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

package/dist/index.cjs

@@ -47,7 +47,8 @@ var ROUTER_PLUGIN_NAME = "router";
 var routerPlugin = {
   getName: () => ROUTER_PLUGIN_NAME,
   getDefinition: () => ({
-    create: createRouterPlugin
+    create: createRouterPlugin,
+    supportsInstanceReferences: true
   }),
   getDefaultOptions: defaultOptions
 };

package/dist/index.d.cts

@@ -1,55 +1,71 @@
 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.
- *
- * This module registers the router configuration in the global plugin map,
- * which ensures strict typing when calling `testComponentFactory`.
+ * TestForge core type augmentation for Vue Router integration.
  *
- * @module Augmentation
+ * Registers the public plugin configuration and runtime instance types
+ * used by TestForge's managed plugin APIs.
  */
 declare module "@testforgejs/vue-test-core" {
     /**
-     * The global interface for the TestForge kernel plugin options.
+     * Global map for TestForge plugin configuration options.
      */
     interface PluginOptionsMap {
         /**
-         * Configuration for the `router` plugin.
-         * Accepts an object of type {@link VueTestRouterOptions} containing Vue router settings and control hooks.
-         *
-         * @example
-         * ```ts
-         * factory({}, {
-         *   plugins: {
-         *     router: {
-         *       history: createMemoryHistory(),
-         *       routes: [...]
-         *     }
-         *   }
-         * });
-         * ```
+         * Configuration accepted by the managed `router` plugin.
          */
         [ROUTER_PLUGIN_NAME]: VueTestRouterOptions;
     }
+    /**
+     * Global map for managed plugin runtime instances.
+     */
+    interface PluginInstanceMap {
+        /**
+         * Runtime Vue Router instance created by the managed `router` plugin.
+         */
+        [ROUTER_PLUGIN_NAME]: Router;
+    }
 }
 
 /**
- * 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,55 +1,71 @@
 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.
- *
- * This module registers the router configuration in the global plugin map,
- * which ensures strict typing when calling `testComponentFactory`.
+ * TestForge core type augmentation for Vue Router integration.
  *
- * @module Augmentation
+ * Registers the public plugin configuration and runtime instance types
+ * used by TestForge's managed plugin APIs.
  */
 declare module "@testforgejs/vue-test-core" {
     /**
-     * The global interface for the TestForge kernel plugin options.
+     * Global map for TestForge plugin configuration options.
      */
     interface PluginOptionsMap {
         /**
-         * Configuration for the `router` plugin.
-         * Accepts an object of type {@link VueTestRouterOptions} containing Vue router settings and control hooks.
-         *
-         * @example
-         * ```ts
-         * factory({}, {
-         *   plugins: {
-         *     router: {
-         *       history: createMemoryHistory(),
-         *       routes: [...]
-         *     }
-         *   }
-         * });
-         * ```
+         * Configuration accepted by the managed `router` plugin.
          */
         [ROUTER_PLUGIN_NAME]: VueTestRouterOptions;
     }
+    /**
+     * Global map for managed plugin runtime instances.
+     */
+    interface PluginInstanceMap {
+        /**
+         * Runtime Vue Router instance created by the managed `router` plugin.
+         */
+        [ROUTER_PLUGIN_NAME]: Router;
+    }
 }
 
 /**
- * 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.js

@@ -19,7 +19,8 @@ var ROUTER_PLUGIN_NAME = "router";
 var routerPlugin = {
   getName: () => ROUTER_PLUGIN_NAME,
   getDefinition: () => ({
-    create: createRouterPlugin
+    create: createRouterPlugin,
+    supportsInstanceReferences: true
   }),
   getDefaultOptions: defaultOptions
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testforgejs/vue-test-plugin-router",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.5",
   "type": "module",
   "description": "Official TestForge plugin for Vue Router integration in component tests",
   "homepage": "https://github.com/testforgejs/testforge#readme",
@@ -45,11 +45,11 @@
   "author": "Roman Levchenko",
   "peerDependencies": {
     "vue-router": "^4.0.0 || ^5.0.0",
-    "@testforgejs/vue-test-core": "1.0.0-beta.3"
+    "@testforgejs/vue-test-core": "1.0.0-beta.4"
   },
   "devDependencies": {
     "vue-router": "^5.0.0",
-    "@testforgejs/vue-test-core": "1.0.0-beta.3"
+    "@testforgejs/vue-test-core": "1.0.0-beta.4"
   },
   "testforge": {
     "plugin": {