@testforgejs/vue-test-plugin-router 1.0.0-beta.3 → 1.0.0-beta.4

package/dist/index.d.cts

@@ -1,19 +1,38 @@
 import { RouterOptions, Router } from 'vue-router';
 import { PluginControlOptions, PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
 
+/**
+ * Stable TestForge identifier for the managed Vue Router plugin.
+ *
+ * Use this identifier when declaring Router configuration
+ * in presets and other plugin-aware TestForge APIs.
+ */
 declare const ROUTER_PLUGIN_NAME: "router";
 
 /**
  * Configuration options for the Vue Router test plugin.
  *
- * This interface integrates standard router initialization settings
- * and TestForge test kernel control options (such as `expose`).
+ * Combines standard Vue Router configuration (`RouterOptions` from `vue-router`)
+ * with TestForge plugin control options.
+ *
+ * @example
+ * Configure the managed Vue Router plugin for a component test:
  *
- * @see {@link RouterOptions} from the `vue-router` package for configuring routes and history.
- * @see {@link PluginControlOptions} from the `@testforgejs/vue-test-core` package for instance interception.
+ * ```ts
+ * factory({}, {
+ *   plugins: {
+ *     router: {
+ *       history: createMemoryHistory(),
+ *       routes: [],
+ *     },
+ *   },
+ * });
+ * ```
+ *
+ * @see `RouterOptions` from `vue-router` for configuring routes and history.
+ * @see `PluginControlOptions` from `@testforgejs/vue-test-core` for instance capturing and exposure mechanisms.
  */
-interface VueTestRouterOptions extends RouterOptions, PluginControlOptions<Router> {
-}
+type VueTestRouterOptions = RouterOptions & PluginControlOptions<Router>;
 
 /**
  * Extending TestForge kernel types for Vue Router integration.
@@ -49,7 +68,10 @@ declare module "@testforgejs/vue-test-core" {
 }
 
 /**
- * A Vue Router plugin module for the TestForge testing framework.
+ * Managed Vue Router plugin module for TestForge.
+ *
+ * Provides the runtime definition for creating Vue Router instances
+ * and exposes the default configuration used by TestForge-managed presets.
  */
 declare const routerPlugin: PluginModuleWithDefaults<Router, VueTestRouterOptions>;
 

package/dist/index.d.ts

@@ -1,19 +1,38 @@
 import { RouterOptions, Router } from 'vue-router';
 import { PluginControlOptions, PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
 
+/**
+ * Stable TestForge identifier for the managed Vue Router plugin.
+ *
+ * Use this identifier when declaring Router configuration
+ * in presets and other plugin-aware TestForge APIs.
+ */
 declare const ROUTER_PLUGIN_NAME: "router";
 
 /**
  * Configuration options for the Vue Router test plugin.
  *
- * This interface integrates standard router initialization settings
- * and TestForge test kernel control options (such as `expose`).
+ * Combines standard Vue Router configuration (`RouterOptions` from `vue-router`)
+ * with TestForge plugin control options.
+ *
+ * @example
+ * Configure the managed Vue Router plugin for a component test:
  *
- * @see {@link RouterOptions} from the `vue-router` package for configuring routes and history.
- * @see {@link PluginControlOptions} from the `@testforgejs/vue-test-core` package for instance interception.
+ * ```ts
+ * factory({}, {
+ *   plugins: {
+ *     router: {
+ *       history: createMemoryHistory(),
+ *       routes: [],
+ *     },
+ *   },
+ * });
+ * ```
+ *
+ * @see `RouterOptions` from `vue-router` for configuring routes and history.
+ * @see `PluginControlOptions` from `@testforgejs/vue-test-core` for instance capturing and exposure mechanisms.
  */
-interface VueTestRouterOptions extends RouterOptions, PluginControlOptions<Router> {
-}
+type VueTestRouterOptions = RouterOptions & PluginControlOptions<Router>;
 
 /**
  * Extending TestForge kernel types for Vue Router integration.
@@ -49,7 +68,10 @@ declare module "@testforgejs/vue-test-core" {
 }
 
 /**
- * A Vue Router plugin module for the TestForge testing framework.
+ * Managed Vue Router plugin module for TestForge.
+ *
+ * Provides the runtime definition for creating Vue Router instances
+ * and exposes the default configuration used by TestForge-managed presets.
  */
 declare const routerPlugin: PluginModuleWithDefaults<Router, VueTestRouterOptions>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testforgejs/vue-test-plugin-router",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.4",
   "type": "module",
   "description": "Official TestForge plugin for Vue Router integration in component tests",
   "homepage": "https://github.com/testforgejs/testforge#readme",