najm-auth 6.0.0 → 6.2.0

package/dist/client/react/index.d.ts

@@ -216,6 +216,22 @@ declare function useOAuthCallback(options?: UseOAuthCallbackOptions): {
  */
 declare function useAuthEvent<K extends AuthEvent>(event: K, handler: (data: AuthEventMap[K]) => void): void;
 
+/**
+ * Sends the user to sign in when the session ends while a page is open.
+ *
+ * A server page checks the session only when it renders, so a session revoked
+ * or expired afterwards leaves the page up: every read then answers 401, and a
+ * list shows as empty instead of asking the user to sign in again.
+ *
+ * It is a full navigation, so the auth middleware can clear the dead cookies,
+ * and `from` brings the user back to this page afterwards, as the middleware's
+ * own redirect does. A normal sign-out emits `logout`, not `sessionExpired`,
+ * so the sign-out button keeps its own navigation.
+ *
+ * Mount it once, in the layout every signed-in page shares.
+ */
+declare function useRedirectOnSessionExpired(loginRoute?: string): void;
+
 interface AuthEventEntry {
     event: AuthEvent;
     data: unknown;
@@ -600,4 +616,4 @@ interface OAuthCallbackProps {
 }
 declare function OAuthCallback({ fallback, errorFallback, defaultRedirect, }: OAuthCallbackProps): react.JSX.Element;
 
-export { AuthBoundary, type AuthEventEntry, AuthGate, AuthLoading, AuthProvider, Can, GitHubLoginButton, GoogleLoginButton, IfAuth, LoginButton, OAuthCallback, PermissionList, Protected, RedirectToLogin, Role, type SessionStatus, SignOutButton, SignedIn, SignedOut, UserAvatar, UserEmail, UserName, UserRole, useAuth, useAuthClient, useAuthEvent, useAuthEvents, useChangePassword, useForgotPassword, useGitHubLogin, useGoogleLogin, useLogin, useLogout, useOAuthCallback, usePermissions, useRegister, useResetPassword, useSession, useUser };
+export { AuthBoundary, type AuthEventEntry, AuthGate, AuthLoading, AuthProvider, Can, GitHubLoginButton, GoogleLoginButton, IfAuth, LoginButton, OAuthCallback, PermissionList, Protected, RedirectToLogin, Role, type SessionStatus, SignOutButton, SignedIn, SignedOut, UserAvatar, UserEmail, UserName, UserRole, useAuth, useAuthClient, useAuthEvent, useAuthEvents, useChangePassword, useForgotPassword, useGitHubLogin, useGoogleLogin, useLogin, useLogout, useOAuthCallback, usePermissions, useRedirectOnSessionExpired, useRegister, useResetPassword, useSession, useUser };

package/dist/client/react/index.js

@@ -431,6 +431,16 @@ function useAuthEvent(event, handler) {
 }
 __name(useAuthEvent, "useAuthEvent");
 
+// src/client/react/useRedirectOnSessionExpired.ts
+function useRedirectOnSessionExpired(loginRoute = "/login") {
+  useAuthEvent("sessionExpired", () => {
+    const login = new URL(loginRoute, window.location.origin);
+    login.searchParams.set("from", `${window.location.pathname}${window.location.search}`);
+    window.location.assign(login.toString());
+  });
+}
+__name(useRedirectOnSessionExpired, "useRedirectOnSessionExpired");
+
 // src/client/react/useAuthEvents.ts
 import { useEffect as useEffect4, useRef as useRef5, useState as useState12 } from "react";
 var ALL_EVENTS = [
@@ -845,6 +855,7 @@ export {
   useLogout,
   useOAuthCallback,
   usePermissions,
+  useRedirectOnSessionExpired,
   useRegister,
   useResetPassword,
   useSession,

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import * as najm_core from 'najm-core';
-import { Container } from 'najm-core';
+import { NajmPlugin, Container } from 'najm-core';
 import { ValidationPluginConfig } from 'najm-validation';
 import { RateLimitPluginConfig, RateLimitKeyContext, TimeWindow } from 'najm-rate';
 import { CachePluginConfig, CacheService } from 'najm-cache';
@@ -315,20 +314,23 @@ type AuthPluginConfig = {
      * a user has a durable setup requirement.
      */
     credentialSetup?: CredentialSetupConfig;
-    /** Optional config forwarded to validation() dependency */
+    /** Config for the validation() plugin auth registers when the application has none. */
     validation?: ValidationPluginConfig;
-    /** Optional config forwarded to rateLimit() dependency */
+    /** Config for the rateLimit() plugin auth registers when the application has none. */
     rateLimit?: RateLimitPluginConfig;
     /**
-     * Optional config forwarded to the package-owned cache() dependency.
-     *
-     * Auth registers cache() itself, so a consumer cannot configure the store by
-     * registering its own plugin first. Pass it here to select a shared, durable
-     * backend — required in production wherever the cache backs rate limiting,
-     * since a per-process memory bucket resets on every restart.
+     * Config for the cache() plugin auth registers when the application has
+     * none. Select a shared, durable backend — here or on the application's own
+     * `cache()` — in production wherever the cache backs rate limiting, since a
+     * per-process memory bucket resets on every restart.
      */
     cache?: CachePluginConfig;
-    /** Email transport used by password reset and verification flows. */
+    /**
+     * Email transport for password reset and verification flows, used when the
+     * application registers no email() plugin. Auth builds its email plugin only
+     * in that case, so an application with its own needs no `EMAIL_PROVIDER`
+     * for auth to start.
+     */
     email?: EmailPluginConfig;
     /** AES-256-GCM key for reversible encryption (e.g. API keys). Falls back to NAJM_ENCRYPTION_KEY env var. */
     encryptionKey?: string;
@@ -384,7 +386,7 @@ interface AuthUser {
     permissions?: string[];
 }
 
-declare const auth$1: (config?: AuthPluginConfig) => najm_core.NajmPlugin;
+declare const auth$1: (config?: AuthPluginConfig) => NajmPlugin;
 
 declare const AUTH_CONFIG: unique symbol;
 declare const AUTH_SCHEMA: unique symbol;

package/dist/index.js

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 };
 
 // src/AuthPlugin.ts
-import { Err as Err17, plugin } from "najm-core";
+import { Err as Err17, lazyPlugin, plugin } from "najm-core";
 import { cache } from "najm-cache";
 
 // src/auth.tokens.ts
@@ -8281,7 +8281,10 @@ var selectAuthSchema = /* @__PURE__ */ __name((config) => {
       return authSchema;
   }
 }, "selectAuthSchema");
-var auth = /* @__PURE__ */ __name((config) => plugin("auth").version("1.0.0").depends(cache(config?.cache), cookies(), i18n(), guards(), validation(config?.validation), rateLimit(config?.rateLimit), email(config?.email)).requires("database").contributes(I18N_CONTRIBUTIONS, AUTH_LOCALES).services(AUTH_CORE_MODULE, config?.publicRegistration === false ? [] : PUBLIC_REGISTRATION_MODULE, OAUTH_MODULE, users_exports, roles_exports, permissions_exports, tokens_exports, CREDENTIAL_SETUP_MODULE, ScopeContext).config(AUTH_CONFIG, resolveAuthConfig(config)).set(AUTH_SCHEMA, selectAuthSchema(config)).set(AUTH_ENCRYPTION_KEY, config?.encryptionKey ?? null).build(), "auth");
+var configurableDependency = /* @__PURE__ */ __name((config, option, name, create) => lazyPlugin(name, () => create(config?.[option]), {
+  forwardedConfig: config?.[option] === void 0 ? void 0 : `auth({ ${option} })`
+}), "configurableDependency");
+var auth = /* @__PURE__ */ __name((config) => plugin("auth").version("1.0.0").depends(configurableDependency(config, "cache", "cache", cache), cookies(), i18n(), guards(), configurableDependency(config, "validation", "validation", validation), configurableDependency(config, "rateLimit", "rate-limit", rateLimit), configurableDependency(config, "email", "email", email)).requires("database").contributes(I18N_CONTRIBUTIONS, AUTH_LOCALES).services(AUTH_CORE_MODULE, config?.publicRegistration === false ? [] : PUBLIC_REGISTRATION_MODULE, OAUTH_MODULE, users_exports, roles_exports, permissions_exports, tokens_exports, CREDENTIAL_SETUP_MODULE, ScopeContext).config(AUTH_CONFIG, resolveAuthConfig(config)).set(AUTH_SCHEMA, selectAuthSchema(config)).set(AUTH_ENCRYPTION_KEY, config?.encryptionKey ?? null).build(), "auth");
 
 // src/seed.ts
 var toSeedId = /* @__PURE__ */ __name((prefix, value) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "najm-auth",
-  "version": "6.0.0",
+  "version": "6.2.0",
   "description": "Authentication and authorization library for najm framework",
   "type": "module",
   "files": [
@@ -93,8 +93,8 @@
   "dependencies": {
     "bcryptjs": "^3.0.2",
     "najm-cookies": "^2.0.3",
-    "najm-core": "^3.0.3",
-    "najm-database": "^2.2.0",
+    "najm-core": "^3.1.0",
+    "najm-database": "^2.2.1",
     "najm-guard": "^2.2.1",
     "najm-i18n": "^2.1.3",
     "najm-cache": "^2.2.0",