@account-kit/signer 4.0.0-beta.1 → 4.0.0-beta.10

package/src/session/manager.ts

@@ -8,6 +8,7 @@ import {
 import { createStore, type Mutate, type StoreApi } from "zustand/vanilla";
 import type { BaseSignerClient } from "../client/base";
 import type { User } from "../client/types";
+import { assertNever } from "../utils/typeAssertions.js";
 import type { Session, SessionManagerEvents } from "./types";
 
 export const DEFAULT_SESSION_MS = 15 * 60 * 1000; // 15 minutes
@@ -82,11 +83,18 @@ export class SessionManager {
     }
 
     switch (existingSession.type) {
-      case "email": {
+      case "email":
+      case "oauth": {
+        const connectedEventName =
+          existingSession.type === "email"
+            ? "connectedEmail"
+            : "connectedOauth";
         const result = await this.client
-          .completeEmailAuth({
+          .completeAuthWithBundle({
             bundle: existingSession.bundle,
             orgId: existingSession.user.orgId,
+            authenticatingType: existingSession.type,
+            connectedEventName,
           })
           .catch((e) => {
             console.warn("Failed to load user from session", e);
@@ -108,7 +116,10 @@ export class SessionManager {
         return this.client.lookupUserWithPasskey(existingSession.user);
       }
       default:
-        throw new Error("Unknown session type");
+        assertNever(
+          existingSession,
+          `Unknown session type: ${(existingSession as any).type}`
+        );
     }
   };
 
@@ -168,7 +179,7 @@ export class SessionManager {
 
   private setSession = (
     session:
-      | Omit<Extract<Session, { type: "email" }>, "expirationDateMs">
+      | Omit<Extract<Session, { type: "email" | "oauth" }>, "expirationDateMs">
       | Omit<Extract<Session, { type: "passkey" }>, "expirationDateMs">
   ) => {
     this.store.setState({
@@ -211,21 +222,9 @@ export class SessionManager {
 
     this.client.on("disconnected", () => this.clearSession());
 
-    this.client.on("connectedEmail", (user, bundle) => {
-      const existingSession = this.getSession();
-      if (
-        existingSession != null &&
-        existingSession.type === "email" &&
-        existingSession.user.userId === user.userId &&
-        // if the bundle is different, then we've refreshed the session
-        // so we need to reset the session
-        existingSession.bundle === bundle
-      ) {
-        return;
-      }
-
-      this.setSession({ type: "email", user, bundle });
-    });
+    this.client.on("connectedEmail", (user, bundle) =>
+      this.setSessionWithUserAndBundle({ type: "email", user, bundle })
+    );
 
     this.client.on("connectedPasskey", (user) => {
       const existingSession = this.getSession();
@@ -240,10 +239,38 @@ export class SessionManager {
       this.setSession({ type: "passkey", user });
     });
 
+    this.client.on("connectedOauth", (user, bundle) =>
+      this.setSessionWithUserAndBundle({ type: "oauth", user, bundle })
+    );
+
     // sync local state if persisted state has changed from another tab
     window.addEventListener("focus", () => {
       this.store.persist.rehydrate();
       this.initialize();
     });
   };
+
+  private setSessionWithUserAndBundle = ({
+    type,
+    user,
+    bundle,
+  }: {
+    type: "email" | "oauth";
+    user: User;
+    bundle: string;
+  }) => {
+    const existingSession = this.getSession();
+    if (
+      existingSession != null &&
+      existingSession.type === type &&
+      existingSession.user.userId === user.userId &&
+      // if the bundle is different, then we've refreshed the session
+      // so we need to reset the session
+      existingSession.bundle === bundle
+    ) {
+      return;
+    }
+
+    this.setSession({ type, user, bundle });
+  };
 }

package/src/session/types.ts

@@ -2,7 +2,7 @@ import type { User } from "../client/types";
 
 export type Session =
   | {
-      type: "email";
+      type: "email" | "oauth";
       bundle: string;
       expirationDateMs: number;
       user: User;

package/src/signer.ts

@@ -24,8 +24,45 @@ export type AuthParams =
       createNew: true;
       username: string;
       creationOpts?: CredentialCreationOptionOverrides;
+    }
+  | ({
+      type: "oauth";
+      scope?: string;
+      claims?: string;
+    } & OauthProviderConfig &
+      OauthRedirectConfig)
+  | {
+      type: "oauthReturn";
+      bundle: string;
+      orgId: string;
+      idToken: string;
     };
 
+export type OauthProviderConfig =
+  | {
+      authProviderId: "auth0";
+      isCustomProvider?: false;
+      auth0Connection?: string;
+    }
+  | {
+      authProviderId: KnownAuthProvider;
+      isCustomProvider?: false;
+      auth0Connection?: never;
+    }
+  | {
+      authProviderId: string;
+      isCustomProvider: true;
+      auth0Connection?: never;
+    };
+
+export type OauthRedirectConfig =
+  | { mode: "redirect"; redirectUrl: string }
+  | { mode: "popup"; redirectUrl?: never };
+
+export type KnownAuthProvider = "google" | "apple" | "facebook" | "auth0";
+
+export type OauthMode = "redirect" | "popup";
+
 export const AlchemySignerParamsSchema = z
   .object({
     client: z
@@ -73,9 +110,59 @@ export class AlchemyWebSigner extends BaseAlchemySigner<AlchemySignerWebClient>
     } else {
       client = params_.client;
     }
-    super({
-      client,
-      sessionConfig,
-    });
+    const { emailBundle, oauthBundle, oauthOrgId, oauthError, idToken } =
+      getAndRemoveQueryParams({
+        emailBundle: "bundle",
+        // We don't need this, but we still want to remove it from the URL.
+        emailOrgId: "orgId",
+        oauthBundle: "alchemy-bundle",
+        oauthOrgId: "alchemy-org-id",
+        oauthError: "alchemy-error",
+        idToken: "alchemy-id-token",
+      });
+
+    const initialError =
+      oauthError != null
+        ? { name: "OauthError", message: oauthError }
+        : undefined;
+
+    super({ client, sessionConfig, initialError });
+
+    if (emailBundle) {
+      this.authenticate({ type: "email", bundle: emailBundle });
+    } else if (oauthBundle && oauthOrgId && idToken) {
+      this.authenticate({
+        type: "oauthReturn",
+        bundle: oauthBundle,
+        orgId: oauthOrgId,
+        idToken,
+      });
+    }
+  }
+}
+
+/**
+ * Reads and removes the specified query params from the URL.
+ *
+ * @param {T} keys object whose values are the query parameter keys to read and
+ * remove
+ * @returns {{ [K in keyof T]: string | undefined }} object with the same keys
+ * as the input whose values are the values of the query params.
+ */
+function getAndRemoveQueryParams<T extends Record<string, string>>(
+  keys: T
+): { [K in keyof T]: string | undefined } {
+  const url = new URL(window.location.href);
+  const result: Record<string, string | undefined> = {};
+  let foundQueryParam = false;
+  for (const [key, param] of Object.entries(keys)) {
+    const value = url.searchParams.get(param) ?? undefined;
+    foundQueryParam ||= value != null;
+    result[key] = value;
+    url.searchParams.delete(param);
+  }
+  if (foundQueryParam) {
+    window.history.replaceState(window.history.state, "", url.toString());
   }
+  return result as { [K in keyof T]: string | undefined };
 }

package/src/types.ts

@@ -4,6 +4,7 @@ export type AlchemySignerEvents = {
   connected(user: User): void;
   disconnected(): void;
   statusChanged(status: AlchemySignerStatus): void;
+  errorChanged(error: ErrorInfo | undefined): void;
 };
 
 export type AlchemySignerEvent = keyof AlchemySignerEvents;
@@ -12,6 +13,13 @@ export enum AlchemySignerStatus {
   INITIALIZING = "INITIALIZING",
   CONNECTED = "CONNECTED",
   DISCONNECTED = "DISCONNECTED",
-  AUTHENTICATING = "AUTHENTICATING",
+  AUTHENTICATING_PASSKEY = "AUTHENTICATING_PASSKEY",
+  AUTHENTICATING_EMAIL = "AUTHENTICATING_EMAIL",
+  AUTHENTICATING_OAUTH = "AUTHENTICATING_OAUTH",
   AWAITING_EMAIL_AUTH = "AWAITING_EMAIL_AUTH",
 }
+
+export interface ErrorInfo {
+  name: string;
+  message: string;
+}

package/src/utils/typeAssertions.ts

@@ -0,0 +1,3 @@
+export function assertNever(_: never, message: string): never {
+  throw new Error(message);
+}

package/src/version.ts

@@ -1,3 +1,3 @@
 // This file is autogenerated by inject-version.ts. Any changes will be
 // overwritten on commit!
-export const VERSION = "4.0.0-beta.1";
+export const VERSION = "4.0.0-beta.10";