@testforgejs/vue-test-plugin-pinia 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,64 @@
+# @testforgejs/vue-test-plugin-pinia
+
+Pinia integration for TestForge component tests.
+
+## Installation
+
+Choose your preferred package manager.
+
+### pnpm
+
+```bash
+pnpm add -D @testforgejs/vue-test-plugin-pinia@beta
+```
+
+### npm
+
+```bash
+npm install -D @testforgejs/vue-test-plugin-pinia@beta
+```
+
+### Yarn
+
+```bash
+yarn add -D @testforgejs/vue-test-plugin-pinia@beta
+```
+
+> `@testforgejs/vue-test-core` is required.
+
+## Usage
+
+Register `piniaPlugin` in the TestForge plugin manifest.
+
+```ts
+import { createTestFramework } from "@testforgejs/vue-test-core";
+import { piniaPlugin } from "@testforgejs/vue-test-plugin-pinia";
+
+const framework = createTestFramework({
+  presets: {
+    default: {
+      manifest: [
+        {
+          module: piniaPlugin,
+          enabled: true,
+        },
+      ],
+    },
+  },
+});
+```
+
+The plugin provides a Pinia instance for components mounted through TestForge.
+
+## Supported versions
+
+- Vue: 3.x
+- Pinia: 3.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-pinia/docs/api/README.md).

package/dist/index.cjs

@@ -0,0 +1,59 @@
+"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, {
+  piniaPlugin: () => piniaPlugin
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/module/createPiniaPlugin.ts
+var import_vue_test_core = require("@testforgejs/vue-test-core");
+var import_testing = require("@pinia/testing");
+function createPiniaPlugin(options) {
+  const pinia = (0, import_vue_test_core.createPluginInstance)(import_testing.createTestingPinia, options);
+  if (options.mockStores) {
+    options.mockStores(pinia);
+  }
+  return pinia;
+}
+
+// src/module/piniaPlugin.ts
+var import_pinia = require("pinia");
+var piniaPlugin = {
+  getName: () => "pinia",
+  getDefinition: () => ({
+    // beforeCreate(ctx, options) {
+    //     return {
+    //         ...defaultPinia,
+    //         ...options,
+    //     }
+    // },
+    create: createPiniaPlugin,
+    // Automatically sets the active Pinia instance for current test context.
+    afterCreate(instance) {
+      (0, import_pinia.setActivePinia)(instance);
+    }
+  })
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  piniaPlugin
+});

package/dist/index.d.cts

@@ -0,0 +1,65 @@
+import { Pinia } from 'pinia';
+import { TestingOptions } from '@pinia/testing';
+import { PluginControlOptions, PluginModule } from '@testforgejs/vue-test-core';
+
+/**
+ * A callback function to mutate or configure Pinia stores immediately after they are created.
+ * Used to set the initial state (mocking) in tests.
+ *
+ * @param pinia - Созданный инстанс Pinia для тестирования.
+ */
+type MockStoresFn = (pinia: Pinia) => void;
+/**
+ * Configuration options for the Pinia test plugin.
+ *
+ * This interface integrates the standard Pinia testing initialization settings
+ * (`TestingOptions` from `@pinia/testing`) with the TestForge core configuration options.
+ *
+ * @see {@link TestingOptions} to configure action stubs and the initial state.
+ * @see {@link PluginControlOptions} to use interception methods such as `expose`.
+ */
+interface VueTestPiniaOptions extends TestingOptions, PluginControlOptions<Pinia> {
+    /**
+     * A callback function to modify the state of stores before a component is mounted.
+     *
+     * @example
+     * ```ts
+     * factory({}, {
+     *   plugins: {
+     *     pinia: {
+     *       mockStores: (pinia) => {
+     *         const store = useCounterStore(pinia);
+     *         store.count = 42;
+     *       }
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    mockStores?: MockStoresFn;
+}
+
+/**
+ * Extending TestForge kernel types for Pinia integration.
+ *
+ * This module registers the Pinia configuration in the global plugin map,
+ * which ensures strict typing of the `pinia` property within `plugins`.
+ *
+ * @module PiniaAugmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * The global interface for the TestForge kernel plugin options.
+     */
+    interface PluginOptionsMap {
+        /**
+         * Configuration for the `pinia` plugin.
+         * Accepts an object of type {@link VueTestPiniaOptions}, which controls the behavior of the stores in tests.
+         */
+        pinia: VueTestPiniaOptions;
+    }
+}
+
+declare const piniaPlugin: PluginModule<Pinia, VueTestPiniaOptions>;
+
+export { type MockStoresFn, type VueTestPiniaOptions, piniaPlugin };

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import { Pinia } from 'pinia';
+import { TestingOptions } from '@pinia/testing';
+import { PluginControlOptions, PluginModule } from '@testforgejs/vue-test-core';
+
+/**
+ * A callback function to mutate or configure Pinia stores immediately after they are created.
+ * Used to set the initial state (mocking) in tests.
+ *
+ * @param pinia - Созданный инстанс Pinia для тестирования.
+ */
+type MockStoresFn = (pinia: Pinia) => void;
+/**
+ * Configuration options for the Pinia test plugin.
+ *
+ * This interface integrates the standard Pinia testing initialization settings
+ * (`TestingOptions` from `@pinia/testing`) with the TestForge core configuration options.
+ *
+ * @see {@link TestingOptions} to configure action stubs and the initial state.
+ * @see {@link PluginControlOptions} to use interception methods such as `expose`.
+ */
+interface VueTestPiniaOptions extends TestingOptions, PluginControlOptions<Pinia> {
+    /**
+     * A callback function to modify the state of stores before a component is mounted.
+     *
+     * @example
+     * ```ts
+     * factory({}, {
+     *   plugins: {
+     *     pinia: {
+     *       mockStores: (pinia) => {
+     *         const store = useCounterStore(pinia);
+     *         store.count = 42;
+     *       }
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    mockStores?: MockStoresFn;
+}
+
+/**
+ * Extending TestForge kernel types for Pinia integration.
+ *
+ * This module registers the Pinia configuration in the global plugin map,
+ * which ensures strict typing of the `pinia` property within `plugins`.
+ *
+ * @module PiniaAugmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * The global interface for the TestForge kernel plugin options.
+     */
+    interface PluginOptionsMap {
+        /**
+         * Configuration for the `pinia` plugin.
+         * Accepts an object of type {@link VueTestPiniaOptions}, which controls the behavior of the stores in tests.
+         */
+        pinia: VueTestPiniaOptions;
+    }
+}
+
+declare const piniaPlugin: PluginModule<Pinia, VueTestPiniaOptions>;
+
+export { type MockStoresFn, type VueTestPiniaOptions, piniaPlugin };

package/dist/index.js

@@ -0,0 +1,32 @@
+// src/module/createPiniaPlugin.ts
+import { createPluginInstance } from "@testforgejs/vue-test-core";
+import { createTestingPinia } from "@pinia/testing";
+function createPiniaPlugin(options) {
+  const pinia = createPluginInstance(createTestingPinia, options);
+  if (options.mockStores) {
+    options.mockStores(pinia);
+  }
+  return pinia;
+}
+
+// src/module/piniaPlugin.ts
+import { setActivePinia } from "pinia";
+var piniaPlugin = {
+  getName: () => "pinia",
+  getDefinition: () => ({
+    // beforeCreate(ctx, options) {
+    //     return {
+    //         ...defaultPinia,
+    //         ...options,
+    //     }
+    // },
+    create: createPiniaPlugin,
+    // Automatically sets the active Pinia instance for current test context.
+    afterCreate(instance) {
+      setActivePinia(instance);
+    }
+  })
+};
+export {
+  piniaPlugin
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@testforgejs/vue-test-plugin-pinia",
+  "version": "1.0.0-beta.0",
+  "type": "module",
+  "description": "Official TestForge plugin for Pinia 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-pinia"
+  },
+  "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",
+    "pinia",
+    "state-management",
+    "stores",
+    "testforge",
+    "testforge-plugin"
+  ],
+  "license": "MIT",
+  "author": "Roman Levchenko",
+  "peerDependencies": {
+    "pinia": ">=3.0.0 <5.0.0",
+    "@pinia/testing": ">=1.0.0 <3.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "devDependencies": {
+    "pinia": "^4.0.0",
+    "@pinia/testing": "^2.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test:types": "tsd",
+    "docs:generate": "typedoc"
+  }
+}