@lukoweb/apitogo 0.1.24 → 0.1.37

package/src/lib/authentication/hook.ts

@@ -1,139 +1,141 @@
-import { useQuery } from "@tanstack/react-query";
-import { useNavigate } from "react-router";
-import { useZudoku } from "../components/context/ZudokuContext.js";
-import type { AuthActionOptions } from "./authentication.js";
-import { useAuthState } from "./state.js";
-
-export type UseAuthReturn = ReturnType<typeof useAuth>;
-
-/**
- * Refreshes the user profile from the authentication provider.
- *
- * This gets called when the user profile needs to be refreshed (e.g. to check if the email is verified)
- */
-export const useRefreshUserProfile = ({
-  refetchOnWindowFocus,
-}: {
-  refetchOnWindowFocus?: boolean | "always";
-} = {}) => {
-  const { authentication } = useZudoku();
-  const isAuthEnabled = typeof authentication !== "undefined";
-
-  return useQuery({
-    refetchOnWindowFocus,
-    queryKey: ["refresh-user-profile"],
-    enabled:
-      isAuthEnabled && typeof authentication?.refreshUserProfile === "function",
-    queryFn: () => authentication?.refreshUserProfile?.(),
-  });
-};
-
-export const useVerifiedEmail = () => {
-  const { authentication } = useZudoku();
-  const authState = useAuthState();
-  const navigate = useNavigate();
-  const isAuthEnabled = typeof authentication !== "undefined";
-
-  const { refetch: refreshUserProfile } = useRefreshUserProfile({
-    refetchOnWindowFocus: "always",
-  });
-
-  return {
-    email: authState.profile?.email,
-    isVerified: authState.profile?.emailVerified,
-    supportsEmailVerification:
-      typeof authentication?.requestEmailVerification === "function",
-    refresh: () => void refreshUserProfile(),
-    requestEmailVerification: async (options?: AuthActionOptions) => {
-      if (process.env.NODE_ENV === "development") {
-        // biome-ignore lint: We want to warn about the deprecation
-        console.warn(
-          "requestEmailVerification is deprecated. Use useVerifiedEmail.",
-        );
-      }
-      if (!isAuthEnabled) {
-        throw new Error("Authentication is not enabled.");
-      }
-
-      await authentication.requestEmailVerification?.(
-        { navigate },
-        {
-          ...options,
-          redirectTo: options?.redirectTo ?? window.location.href,
-        },
-      );
-    },
-  };
-};
-
-export const useAuth = () => {
-  const { authentication } = useZudoku();
-  const authState = useAuthState();
-  const isAuthEnabled = typeof authentication !== "undefined";
-  const navigate = useNavigate();
-
-  useRefreshUserProfile();
-
-  return {
-    isAuthEnabled,
-    ...authState,
-
-    login: async (options?: AuthActionOptions) => {
-      if (!isAuthEnabled) {
-        throw new Error("Authentication is not enabled.");
-      }
-      // TODO: Should handle errors/state
-      await authentication.signIn(
-        { navigate },
-        {
-          ...options,
-          redirectTo: options?.redirectTo ?? window.location.href,
-        },
-      );
-    },
-
-    logout: async () => {
-      if (!isAuthEnabled) {
-        throw new Error("Authentication is not enabled.");
-      }
-      // TODO: Should handle errors/state
-      await authentication.signOut({ navigate });
-
-      // Redirect to home
-      void navigate("/", { replace: true });
-    },
-
-    signup: async (options?: AuthActionOptions) => {
-      if (!isAuthEnabled) {
-        throw new Error("Authentication is not enabled.");
-      }
-      await authentication.signUp(
-        { navigate },
-        {
-          ...options,
-          redirectTo: options?.redirectTo ?? window.location.href,
-        },
-      );
-    },
-
-    requestEmailVerification: async (options?: AuthActionOptions) => {
-      if (process.env.NODE_ENV === "development") {
-        // biome-ignore lint: We want to warn about the deprecation
-        console.warn(
-          "requestEmailVerification is deprecated on useAuth. Use the requestEmailVerification method from useVerifiedEmail hook instead.",
-        );
-      }
-      if (!isAuthEnabled) {
-        throw new Error("Authentication is not enabled.");
-      }
-
-      await authentication.requestEmailVerification?.(
-        { navigate },
-        {
-          ...options,
-          redirectTo: options?.redirectTo ?? window.location.href,
-        },
-      );
-    },
-  };
-};
+import { useQuery } from "@tanstack/react-query";
+import { useNavigate } from "react-router";
+import { useZudoku } from "../components/context/ZudokuContext.js";
+import type { AuthActionOptions } from "./authentication.js";
+import { useAuthState } from "./state.js";
+
+export type UseAuthReturn = ReturnType<typeof useAuth>;
+
+/**
+ * Refreshes the user profile from the authentication provider.
+ *
+ * This gets called when the user profile needs to be refreshed (e.g. to check if the email is verified)
+ */
+export const useRefreshUserProfile = ({
+  refetchOnWindowFocus,
+}: {
+  refetchOnWindowFocus?: boolean | "always";
+} = {}) => {
+  const { authentication } = useZudoku();
+  const isAuthEnabled = typeof authentication !== "undefined";
+
+  return useQuery({
+    refetchOnWindowFocus,
+    queryKey: ["refresh-user-profile"],
+    enabled:
+      isAuthEnabled && typeof authentication?.refreshUserProfile === "function",
+    queryFn: () => authentication?.refreshUserProfile?.(),
+  });
+};
+
+export const useVerifiedEmail = () => {
+  const { authentication } = useZudoku();
+  const authState = useAuthState();
+  const navigate = useNavigate();
+  const isAuthEnabled = typeof authentication !== "undefined";
+
+  const { refetch: refreshUserProfile } = useRefreshUserProfile({
+    refetchOnWindowFocus: "always",
+  });
+
+  return {
+    email: authState.profile?.email,
+    isVerified: authState.profile?.emailVerified,
+    supportsEmailVerification:
+      typeof authentication?.requestEmailVerification === "function",
+    refresh: () => void refreshUserProfile(),
+    requestEmailVerification: async (options?: AuthActionOptions) => {
+      if (process.env.NODE_ENV === "development") {
+        // biome-ignore lint: We want to warn about the deprecation
+        console.warn(
+          "requestEmailVerification is deprecated. Use useVerifiedEmail.",
+        );
+      }
+      if (!isAuthEnabled) {
+        throw new Error("Authentication is not enabled.");
+      }
+
+      await authentication.requestEmailVerification?.(
+        { navigate },
+        {
+          ...options,
+          redirectTo: options?.redirectTo ?? window.location.href,
+        },
+      );
+    },
+  };
+};
+
+export const useAuth = () => {
+  const { authentication } = useZudoku();
+  const authState = useAuthState();
+  const isAuthEnabled = typeof authentication !== "undefined";
+  const navigate = useNavigate();
+
+  useRefreshUserProfile();
+
+  return {
+    isAuthEnabled,
+    ...authState,
+    isBackendAvailable: authState.isBackendAvailable,
+    authMode: authState.authMode,
+
+    login: async (options?: AuthActionOptions) => {
+      if (!isAuthEnabled) {
+        throw new Error("Authentication is not enabled.");
+      }
+      // TODO: Should handle errors/state
+      await authentication.signIn(
+        { navigate },
+        {
+          ...options,
+          redirectTo: options?.redirectTo ?? window.location.href,
+        },
+      );
+    },
+
+    logout: async () => {
+      if (!isAuthEnabled) {
+        throw new Error("Authentication is not enabled.");
+      }
+      // TODO: Should handle errors/state
+      await authentication.signOut({ navigate });
+
+      // Redirect to home
+      void navigate("/", { replace: true });
+    },
+
+    signup: async (options?: AuthActionOptions) => {
+      if (!isAuthEnabled) {
+        throw new Error("Authentication is not enabled.");
+      }
+      await authentication.signUp(
+        { navigate },
+        {
+          ...options,
+          redirectTo: options?.redirectTo ?? window.location.href,
+        },
+      );
+    },
+
+    requestEmailVerification: async (options?: AuthActionOptions) => {
+      if (process.env.NODE_ENV === "development") {
+        // biome-ignore lint: We want to warn about the deprecation
+        console.warn(
+          "requestEmailVerification is deprecated on useAuth. Use the requestEmailVerification method from useVerifiedEmail hook instead.",
+        );
+      }
+      if (!isAuthEnabled) {
+        throw new Error("Authentication is not enabled.");
+      }
+
+      await authentication.requestEmailVerification?.(
+        { navigate },
+        {
+          ...options,
+          redirectTo: options?.redirectTo ?? window.location.href,
+        },
+      );
+    },
+  };
+};

package/src/lib/authentication/providers/auth0.tsx

@@ -1,91 +1,91 @@
-import type { Auth0AuthenticationConfig } from "../../../config/config.js";
-import { joinUrl } from "../../util/joinUrl.js";
-import type {
-  AuthActionContext,
-  AuthenticationPlugin,
-  AuthenticationProviderInitializer,
-} from "../authentication.js";
-import { useAuthState } from "../state.js";
-import { OpenIDAuthenticationProvider } from "./openid.js";
-
-class Auth0AuthenticationProvider
-  extends OpenIDAuthenticationProvider
-  implements AuthenticationPlugin
-{
-  private readonly options: Auth0AuthenticationConfig["options"];
-  constructor(config: Auth0AuthenticationConfig) {
-    super({
-      ...config,
-      type: "openid",
-      issuer: `https://${config.domain}/`,
-      clientId: config.clientId,
-      audience: config.audience,
-      scopes: config.scopes,
-    });
-    this.options = config.options;
-  }
-
-  onAuthorizationUrl = async (
-    url: URL,
-    { isSignUp }: { isSignUp: boolean },
-  ) => {
-    if (this.options?.prompt !== undefined) {
-      if (this.options.prompt !== "") {
-        url.searchParams.set("prompt", this.options.prompt);
-      }
-    } else if (this.options?.alwaysPromptLogin !== false) {
-      url.searchParams.set("prompt", "login");
-    }
-
-    if (isSignUp) {
-      url.searchParams.set("screen_hint", "signup");
-    }
-  };
-
-  signOut = async (_: AuthActionContext): Promise<void> => {
-    const as = await this.getAuthServer();
-
-    const { providerData } = useAuthState.getState();
-    const idToken =
-      providerData?.type === "openid" ? providerData.idToken : undefined;
-
-    useAuthState.getState().setLoggedOut();
-
-    const redirectUrl = new URL(window.location.origin);
-    redirectUrl.pathname = joinUrl(
-      import.meta.env.BASE_URL,
-      this.redirectToAfterSignOut,
-    );
-
-    // SEE: https://auth0.com/docs/authenticate/login/logout/log-users-out-of-auth0
-    // For Auth0 tenants created on or after 14 November 2023, RP-Initiated
-    // Logout End Session Endpoint Discovery is enabled by default.
-    // Otherwise we fallback to the old non-compliant logout
-
-    // The end_session_endpoint is set, the IdP supports some form of logout,
-    // so we use auth0 logout. Otherwise, just redirect the user to home
-    if (as.end_session_endpoint) {
-      const logoutUrl = new URL(as.end_session_endpoint);
-      if (idToken) {
-        logoutUrl.searchParams.set("id_token_hint", idToken);
-      }
-      logoutUrl.searchParams.set("client_id", this.client.client_id);
-      logoutUrl.searchParams.set(
-        "post_logout_redirect_uri",
-        redirectUrl.toString(),
-      );
-
-      window.location.href = logoutUrl.toString();
-    } else {
-      // const logoutUrl = new URL(`${this.issuer.replace(/\/$/, "")}/v2/logout`);
-      // logoutUrl.searchParams.set("returnTo", redirectUrl.toString());
-      // don't support the deprecated logout today
-    }
-  };
-}
-
-const auth0Auth: AuthenticationProviderInitializer<
-  Auth0AuthenticationConfig
-> = (options) => new Auth0AuthenticationProvider(options);
-
-export default auth0Auth;
+import type { Auth0AuthenticationConfig } from "../../../config/config.js";
+import { joinUrl } from "../../util/joinUrl.js";
+import type {
+  AuthActionContext,
+  AuthenticationPlugin,
+  AuthenticationProviderInitializer,
+} from "../authentication.js";
+import { useAuthState } from "../state.js";
+import { OpenIDAuthenticationProvider } from "./openid.js";
+
+class Auth0AuthenticationProvider
+  extends OpenIDAuthenticationProvider
+  implements AuthenticationPlugin
+{
+  private readonly options: Auth0AuthenticationConfig["options"];
+  constructor(config: Auth0AuthenticationConfig) {
+    super({
+      ...config,
+      type: "openid",
+      issuer: `https://${config.domain}/`,
+      clientId: config.clientId,
+      audience: config.audience,
+      scopes: config.scopes,
+    });
+    this.options = config.options;
+  }
+
+  onAuthorizationUrl = async (
+    url: URL,
+    { isSignUp }: { isSignUp: boolean },
+  ) => {
+    if (this.options?.prompt !== undefined) {
+      if (this.options.prompt !== "") {
+        url.searchParams.set("prompt", this.options.prompt);
+      }
+    } else if (this.options?.alwaysPromptLogin !== false) {
+      url.searchParams.set("prompt", "login");
+    }
+
+    if (isSignUp) {
+      url.searchParams.set("screen_hint", "signup");
+    }
+  };
+
+  signOut = async (_: AuthActionContext): Promise<void> => {
+    const as = await this.getAuthServer();
+
+    const { providerData } = useAuthState.getState();
+    const idToken =
+      providerData?.type === "openid" ? providerData.idToken : undefined;
+
+    useAuthState.getState().setLoggedOut();
+
+    const redirectUrl = new URL(window.location.origin);
+    redirectUrl.pathname = joinUrl(
+      import.meta.env.BASE_URL,
+      this.redirectToAfterSignOut,
+    );
+
+    // SEE: https://auth0.com/docs/authenticate/login/logout/log-users-out-of-auth0
+    // For Auth0 tenants created on or after 14 November 2023, RP-Initiated
+    // Logout End Session Endpoint Discovery is enabled by default.
+    // Otherwise we fallback to the old non-compliant logout
+
+    // The end_session_endpoint is set, the IdP supports some form of logout,
+    // so we use auth0 logout. Otherwise, just redirect the user to home
+    if (as.end_session_endpoint) {
+      const logoutUrl = new URL(as.end_session_endpoint);
+      if (idToken) {
+        logoutUrl.searchParams.set("id_token_hint", idToken);
+      }
+      logoutUrl.searchParams.set("client_id", this.client.client_id);
+      logoutUrl.searchParams.set(
+        "post_logout_redirect_uri",
+        redirectUrl.toString(),
+      );
+
+      window.location.href = logoutUrl.toString();
+    } else {
+      // const logoutUrl = new URL(`${this.issuer.replace(/\/$/, "")}/v2/logout`);
+      // logoutUrl.searchParams.set("returnTo", redirectUrl.toString());
+      // don't support the deprecated logout today
+    }
+  };
+}
+
+const auth0Auth: AuthenticationProviderInitializer<
+  Auth0AuthenticationConfig
+> = (options) => new Auth0AuthenticationProvider(options);
+
+export default auth0Auth;