@imtf/auth 1.0.1-beta.0 → 1.0.1-beta.3

package/lib/hooks/useSignOut.esm.js

@@ -2,18 +2,20 @@ import { useCallback } from "react";
 function useSignOut({
   postSignOutRedirectPath = "/auth/sign-in?sign-out=success",
   retrieveSignOutUrlPath = "/api/auth/sign-out-url",
+  onSignOutStart,
   onSignOutSuccess,
   authClient,
   origin: providedOrigin
 }) {
   const origin = providedOrigin ?? (typeof window !== "undefined" ? window.location.origin : "");
   const standardSignOut = useCallback(() => {
+    onSignOutStart?.();
     void authClient.signOut({
       fetchOptions: {
         onSuccess: onSignOutSuccess
       }
     });
-  }, [authClient, onSignOutSuccess]);
+  }, [authClient, onSignOutStart, onSignOutSuccess]);
   const handleSignOut = useCallback(async () => {
     const postLogoutRedirectUri = `${origin}${postSignOutRedirectPath}`;
     try {

package/lib/types/hooks/useSignOut.d.ts

@@ -1,22 +1,38 @@
 import type { createAuthClient } from "better-auth/react";
+export type UseSignOutOptions = {
+    /**
+     * Path to redirect to after sign-out. Defaults to "/auth/sign-in?sign-out=success".
+     */
+    postSignOutRedirectPath?: string;
+    /**
+     * API endpoint to retrieve the federated logout URL. Defaults to "/api/auth/sign-out-url".
+     */
+    retrieveSignOutUrlPath?: string;
+    /**
+     * Optional callback to execute before starting the sign-out process.
+     */
+    onSignOutStart?: () => void;
+    /**
+     * Optional callback to execute after a successful sign-out.
+     */
+    onSignOutSuccess?: () => void;
+    /**
+     * Auth client instance created by better-auth. This is required to perform the sign-out operation.
+     */
+    authClient: ReturnType<typeof createAuthClient>;
+    /**
+     * Optional origin to use for constructing the post-logout redirect URI. Defaults to the current window location origin.
+     */
+    origin?: string;
+};
 /**
  * Custom hook for handling user sign-out with support for federated logout.
  *
- * @param params - Configuration options
- * @param params.postSignOutRedirectPath - Path to redirect to after sign-out (defaults to "/auth/sign-in?sign-out=success")
- * @returns Object containing handleSignOut function to initiate the sign-out process
- *
  * @example
  * ```tsx
  * const { handleSignOut } = useSignOut({ postSignOutRedirectPath: "/auth/sign-in?sign-out=success" });
  * ```
  */
-export declare function useSignOut({ postSignOutRedirectPath, retrieveSignOutUrlPath, onSignOutSuccess, authClient, origin: providedOrigin, }: {
-    postSignOutRedirectPath?: string;
-    retrieveSignOutUrlPath?: string;
-    onSignOutSuccess?: () => void;
-    authClient: ReturnType<typeof createAuthClient>;
-    origin?: string;
-}): {
+export declare function useSignOut({ postSignOutRedirectPath, retrieveSignOutUrlPath, onSignOutStart, onSignOutSuccess, authClient, origin: providedOrigin, }: UseSignOutOptions): {
     handleSignOut: () => Promise<void>;
 };

package/lib/types/options/auth-client.d.ts

@@ -57,6 +57,7 @@ export declare function getBetterAuthClientOptions(): {
                         error: import("zod").ZodOptional<import("zod").ZodString>;
                         error_description: import("zod").ZodOptional<import("zod").ZodString>;
                         state: import("zod").ZodOptional<import("zod").ZodString>;
+                        iss: import("zod").ZodOptional<import("zod").ZodString>;
                     }, import("better-auth").$strip>;
                     metadata: {
                         allowedMediaTypes: string[];
@@ -151,13 +152,25 @@ export declare function getBetterAuthClientOptions(): {
             };
             options: import("better-auth/plugins").GenericOAuthOptions;
             $ERROR_CODES: {
-                readonly INVALID_OAUTH_CONFIGURATION: "Invalid OAuth configuration";
-                readonly TOKEN_URL_NOT_FOUND: "Invalid OAuth configuration. Token URL not found.";
-                readonly PROVIDER_CONFIG_NOT_FOUND: "No config found for provider";
-                readonly PROVIDER_ID_REQUIRED: "Provider ID is required";
-                readonly INVALID_OAUTH_CONFIG: "Invalid OAuth configuration.";
-                readonly SESSION_REQUIRED: "Session is required";
+                INVALID_OAUTH_CONFIGURATION: import("better-auth").RawError<"INVALID_OAUTH_CONFIGURATION">;
+                TOKEN_URL_NOT_FOUND: import("better-auth").RawError<"TOKEN_URL_NOT_FOUND">;
+                PROVIDER_CONFIG_NOT_FOUND: import("better-auth").RawError<"PROVIDER_CONFIG_NOT_FOUND">;
+                PROVIDER_ID_REQUIRED: import("better-auth").RawError<"PROVIDER_ID_REQUIRED">;
+                INVALID_OAUTH_CONFIG: import("better-auth").RawError<"INVALID_OAUTH_CONFIG">;
+                SESSION_REQUIRED: import("better-auth").RawError<"SESSION_REQUIRED">;
+                ISSUER_MISMATCH: import("better-auth").RawError<"ISSUER_MISMATCH">;
+                ISSUER_MISSING: import("better-auth").RawError<"ISSUER_MISSING">;
             };
         }>;
+        $ERROR_CODES: {
+            INVALID_OAUTH_CONFIGURATION: import("better-auth").RawError<"INVALID_OAUTH_CONFIGURATION">;
+            TOKEN_URL_NOT_FOUND: import("better-auth").RawError<"TOKEN_URL_NOT_FOUND">;
+            PROVIDER_CONFIG_NOT_FOUND: import("better-auth").RawError<"PROVIDER_CONFIG_NOT_FOUND">;
+            PROVIDER_ID_REQUIRED: import("better-auth").RawError<"PROVIDER_ID_REQUIRED">;
+            INVALID_OAUTH_CONFIG: import("better-auth").RawError<"INVALID_OAUTH_CONFIG">;
+            SESSION_REQUIRED: import("better-auth").RawError<"SESSION_REQUIRED">;
+            ISSUER_MISMATCH: import("better-auth").RawError<"ISSUER_MISMATCH">;
+            ISSUER_MISSING: import("better-auth").RawError<"ISSUER_MISSING">;
+        };
     }];
 };

package/lib/types/options/auth.d.ts

@@ -81,6 +81,7 @@ export declare function getBetterAuthOptions({ oidcDiscoveryUrl, authSecret, aut
                     error: import("zod").ZodOptional<import("zod").ZodString>;
                     error_description: import("zod").ZodOptional<import("zod").ZodString>;
                     state: import("zod").ZodOptional<import("zod").ZodString>;
+                    iss: import("zod").ZodOptional<import("zod").ZodString>;
                 }, import("better-auth").$strip>;
                 metadata: {
                     allowedMediaTypes: string[];
@@ -175,16 +176,22 @@ export declare function getBetterAuthOptions({ oidcDiscoveryUrl, authSecret, aut
         };
         options: import("better-auth/plugins").GenericOAuthOptions;
         $ERROR_CODES: {
-            readonly INVALID_OAUTH_CONFIGURATION: "Invalid OAuth configuration";
-            readonly TOKEN_URL_NOT_FOUND: "Invalid OAuth configuration. Token URL not found.";
-            readonly PROVIDER_CONFIG_NOT_FOUND: "No config found for provider";
-            readonly PROVIDER_ID_REQUIRED: "Provider ID is required";
-            readonly INVALID_OAUTH_CONFIG: "Invalid OAuth configuration.";
-            readonly SESSION_REQUIRED: "Session is required";
+            INVALID_OAUTH_CONFIGURATION: import("better-auth").RawError<"INVALID_OAUTH_CONFIGURATION">;
+            TOKEN_URL_NOT_FOUND: import("better-auth").RawError<"TOKEN_URL_NOT_FOUND">;
+            PROVIDER_CONFIG_NOT_FOUND: import("better-auth").RawError<"PROVIDER_CONFIG_NOT_FOUND">;
+            PROVIDER_ID_REQUIRED: import("better-auth").RawError<"PROVIDER_ID_REQUIRED">;
+            INVALID_OAUTH_CONFIG: import("better-auth").RawError<"INVALID_OAUTH_CONFIG">;
+            SESSION_REQUIRED: import("better-auth").RawError<"SESSION_REQUIRED">;
+            ISSUER_MISMATCH: import("better-auth").RawError<"ISSUER_MISMATCH">;
+            ISSUER_MISSING: import("better-auth").RawError<"ISSUER_MISSING">;
         };
     }, {
         id: "next-cookies";
         hooks: {
+            before: {
+                matcher(ctx: import("better-auth").HookEndpointContext): boolean;
+                handler: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>;
+            }[];
             after: {
                 matcher(ctx: import("better-auth").HookEndpointContext): true;
                 handler: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imtf/auth",
-  "version": "1.0.1-beta.0",
+  "version": "1.0.1-beta.3",
   "description": "Better auth wrapper for imtf usage",
   "license": "UNLICENSED",
   "author": "",
@@ -24,16 +24,16 @@
     "schemas"
   ],
   "prettier": "@imtf/prettier-config",
-  "module": "./lib/index.js",
+  "module": "./lib/index.esm.js",
   "types": "./lib/types/index.d.ts",
   "exports": {
     ".": {
       "types": "./lib/types/index.d.ts",
-      "import": "./lib/index.js"
+      "import": "./lib/index.esm.js"
     }
   },
   "dependencies": {
-    "@imtf/panache": "^5.6.0-beta.0"
+    "@imtf/panache": "^5.6.0"
   },
   "peerDependencies": {
     "@mui/lab": "^7.0.1-beta.18",