@real-router/validation-plugin 0.13.2 → 0.13.4

package/README.md

@@ -54,10 +54,28 @@ Core's crash guards always run, regardless of whether this plugin is installed.
 ### `validationPlugin()`
 
 ```typescript
-function validationPlugin(): PluginFactory;
+function validationPlugin<
+  Dependencies extends DefaultDependencies = DefaultDependencies,
+>(): PluginFactory<Dependencies>;
 ```
 
-Returns a `PluginFactory` to pass to `router.usePlugin()`. Takes no arguments.
+Returns a `PluginFactory` to pass to `router.usePlugin()`. Takes no runtime
+arguments; the dependency map is a type parameter, normally inferred from the
+router you register it on (#1621). Spell it explicitly only when inference has
+nothing to work from:
+
+```typescript
+type Deps = Record<string, number>;
+
+const router = createRouter<Deps>(routes);
+
+router.usePlugin(validationPlugin()); // inferred
+const factory = validationPlugin<Deps>(); // explicit
+```
+
+Without the parameter the factory would default to `object`, whose `keyof` is
+`never` — and TypeScript 7 refuses to assign that where `PluginFactory<Deps>` is
+expected for any `Deps` carrying an index signature.
 
 Throws `RouterError("VALIDATION_PLUGIN_AFTER_START")` if the router is already active. Always register before `router.start()`.
 

package/dist/cjs/index.d.ts

@@ -1,7 +1,20 @@
-import { PluginFactory } from "@real-router/core";
+import { DefaultDependencies, PluginFactory } from "@real-router/core";
 import { RouterValidator } from "@real-router/core/validation";
 //#region src/validationPlugin.d.ts
-declare function validationPlugin(): PluginFactory;
+/**
+ * The dependency map is a type parameter so the factory carries the CALLER's
+ * `D` rather than the `object` default (#1621). `keyof object` is `never`, so a
+ * bare `PluginFactory` types `getDependency` as `(key: never) => never`, which
+ * TypeScript 7 refuses to assign where `PluginFactory<D>` is expected for any
+ * `D` with an index signature — `usePlugin(validationPlugin())` stops compiling
+ * for a consumer whose dependencies are `Record<string, T>`. TS 6 skipped that
+ * variance check, so the imprecision was always there and simply invisible.
+ *
+ * `PluginFactory<never>` does NOT work as a shorthand here (unlike
+ * `AnyOptions = Options<never>` in core): it fails on both compilers, because
+ * this plugin actually reads dependencies.
+ */
+declare function validationPlugin<Dependencies extends DefaultDependencies = DefaultDependencies>(): PluginFactory<Dependencies>;
 //#endregion
 export { type RouterValidator, validationPlugin };
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/validationPlugin.ts"],"mappings":";;;iBAqUgB,oBAAoB"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/validationPlugin.ts"],"mappings":";;;;;;;;;;;;;;;;iBAqVgB,iBACd,qBAAqB,sBAAsB,wBACxC,cAAc"}