@testforgejs/vue-test-plugin-router 1.0.0-beta.0

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2026 Roman Levchenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# @testforgejs/vue-test-plugin-router
+
+Official TestForge plugin for Vue Router integration in component tests.
+
+## Installation
+
+Choose your preferred package manager.
+
+### pnpm
+
+```bash
+pnpm add -D @testforgejs/vue-test-plugin-router@beta
+```
+
+### npm
+
+```bash
+npm install -D @testforgejs/vue-test-plugin-router@beta
+```
+
+### Yarn
+
+```bash
+yarn add -D @testforgejs/vue-test-plugin-router@beta
+```
+
+> `@testforgejs/vue-test-core` is required.
+
+## Usage
+
+Register `routerPlugin` in the TestForge plugin manifest.
+
+```ts
+import { createTestFramework } from "@testforgejs/vue-test-core";
+import { routerPlugin } from "@testforgejs/vue-test-plugin-router";
+
+const framework = createTestFramework({
+  presets: {
+    default: {
+      manifest: [
+        {
+          module: routerPlugin,
+          enabled: true,
+        },
+      ],
+    },
+  },
+});
+
+const factory = framework.testComponentFactory(MyComponent);
+
+const wrapper = factory();
+```
+
+The plugin provides Vue Router integration for components mounted through TestForge.
+
+## Supported versions
+
+- Vue: 3.x
+- Vue Router: 4.x and 5.x
+
+## Documentation
+
+See the [TestForge documentation](https://github.com/testforgejs/testforge#readme).
+
+### API Reference
+
+See the [API reference](https://github.com/testforgejs/testforge/blob/main/packages/vue-test-plugin-router/docs/api/README.md).

package/dist/index.cjs

@@ -0,0 +1,44 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  routerPlugin: () => routerPlugin
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/module/createRouterPlugin.ts
+var import_vue_test_core = require("@testforgejs/vue-test-core");
+var import_vue_router = require("vue-router");
+function createRouterPlugin(options) {
+  return (0, import_vue_test_core.createPluginInstance)(import_vue_router.createRouter, options);
+}
+
+// src/module/routerPlugin.ts
+var routerPlugin = {
+  getName: () => "router",
+  getDefinition: () => ({
+    create: createRouterPlugin
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  routerPlugin
+});

package/dist/index.d.cts

@@ -0,0 +1,54 @@
+import { RouterOptions, Router } from 'vue-router';
+import { PluginControlOptions, PluginModule } from '@testforgejs/vue-test-core';
+
+/**
+ * Configuration options for the Vue Router test plugin.
+ *
+ * This interface integrates standard router initialization settings
+ * and TestForge test kernel control options (such as `expose`).
+ *
+ * @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.
+ */
+interface VueTestRouterOptions extends 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`.
+ *
+ * @module Augmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * The global interface for the TestForge kernel plugin 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: [...]
+         *     }
+         *   }
+         * });
+         * ```
+         */
+        router: VueTestRouterOptions;
+    }
+}
+
+/**
+ * A Vue Router plugin module for the TestForge testing framework.
+ */
+declare const routerPlugin: PluginModule<Router, VueTestRouterOptions>;
+
+export { type VueTestRouterOptions, routerPlugin };

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import { RouterOptions, Router } from 'vue-router';
+import { PluginControlOptions, PluginModule } from '@testforgejs/vue-test-core';
+
+/**
+ * Configuration options for the Vue Router test plugin.
+ *
+ * This interface integrates standard router initialization settings
+ * and TestForge test kernel control options (such as `expose`).
+ *
+ * @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.
+ */
+interface VueTestRouterOptions extends 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`.
+ *
+ * @module Augmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * The global interface for the TestForge kernel plugin 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: [...]
+         *     }
+         *   }
+         * });
+         * ```
+         */
+        router: VueTestRouterOptions;
+    }
+}
+
+/**
+ * A Vue Router plugin module for the TestForge testing framework.
+ */
+declare const routerPlugin: PluginModule<Router, VueTestRouterOptions>;
+
+export { type VueTestRouterOptions, routerPlugin };

package/dist/index.js

@@ -0,0 +1,17 @@
+// src/module/createRouterPlugin.ts
+import { createPluginInstance } from "@testforgejs/vue-test-core";
+import { createRouter } from "vue-router";
+function createRouterPlugin(options) {
+  return createPluginInstance(createRouter, options);
+}
+
+// src/module/routerPlugin.ts
+var routerPlugin = {
+  getName: () => "router",
+  getDefinition: () => ({
+    create: createRouterPlugin
+  })
+};
+export {
+  routerPlugin
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@testforgejs/vue-test-plugin-router",
+  "version": "1.0.0-beta.0",
+  "type": "module",
+  "description": "Official TestForge plugin for Vue Router integration in component tests",
+  "homepage": "https://github.com/testforgejs/testforge#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testforgejs/testforge.git",
+    "directory": "packages/vue-test-plugin-router"
+  },
+  "bugs": {
+    "url": "https://github.com/testforgejs/testforge/issues"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "vue",
+    "vue3",
+    "testing",
+    "component-testing",
+    "vue-test-utils",
+    "vue-router",
+    "router",
+    "routing",
+    "navigation",
+    "testforge",
+    "testforge-plugin"
+  ],
+  "license": "MIT",
+  "author": "Roman Levchenko",
+  "peerDependencies": {
+    "vue-router": ">=4.0.0 <6.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "devDependencies": {
+    "vue-router": "^5.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test:types": "tsd",
+    "docs:generate": "typedoc"
+  }
+}