najm-auth 6.1.0 → 6.2.0

package/README.md

@@ -186,12 +186,22 @@ auth({
     }
   }
 
-  // Dependencies (forwarded to plugins)
+  // Dependencies auth registers when the application has not
   validation?: ValidationPluginConfig
   rateLimit?: RateLimitPluginConfig
+  cache?: CachePluginConfig
+  email?: EmailPluginConfig
 })
 ```
 
+Auth depends on the `cache`, `validation`, `rate-limit` and `email` plugins and
+builds each only when the application has not registered one of that name
+before `auth()`. An application that registers its own configures it there and
+passes nothing for it to `auth()`; config passed both ways is ignored on the
+auth side, and the server warns once at startup naming the option. In
+particular, `auth()` needs no `EMAIL_PROVIDER` when the application registers
+`email()` itself.
+
 ---
 
 ## Auto-Registered Routes

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.1.0",
+  "version": "6.2.0",
   "description": "Authentication and authorization library for najm framework",
   "type": "module",
   "files": [
@@ -93,7 +93,7 @@
   "dependencies": {
     "bcryptjs": "^3.0.2",
     "najm-cookies": "^2.0.3",
-    "najm-core": "^3.0.4",
+    "najm-core": "^3.1.0",
     "najm-database": "^2.2.1",
     "najm-guard": "^2.2.1",
     "najm-i18n": "^2.1.3",