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

package/dist/index.cjs

@@ -30,7 +30,10 @@ module.exports = __toCommonJS(index_exports);
 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);
+  const pinia = (0, import_vue_test_core.createPluginInstance)(
+    import_testing.createTestingPinia,
+    options
+  );
   if (options.mockStores) {
     options.mockStores(pinia);
   }

package/dist/index.d.cts

@@ -1,26 +1,33 @@
-import { Pinia } from 'pinia';
-import { TestingOptions } from '@pinia/testing';
+import { TestingOptions, TestingPinia } from '@pinia/testing';
 import { PluginControlOptions, PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
 
+/**
+ * Stable TestForge identifier for the managed Pinia plugin.
+ *
+ * Use this identifier when declaring Pinia configuration
+ * in presets and other plugin-aware TestForge APIs.
+ */
 declare const PINIA_PLUGIN_NAME: "pinia";
 
 /**
- * A callback function to mutate or configure Pinia stores immediately after they are created.
- * Used to set the initial state (mocking) in tests.
+ * A callback for configuring Pinia stores after the testing Pinia instance
+ * is created and before the component is mounted.
+ *
+ * Use it to initialize or modify stores required by the test.
  *
- * @param pinia - Созданный инстанс Pinia для тестирования.
+ * @param pinia - The testing Pinia instance used by the mounted component.
  */
-type MockStoresFn = (pinia: Pinia) => void;
+type MockStoresFn = (pinia: TestingPinia) => 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.
+ * Combines standard Pinia testing configuration (`TestingOptions` from `@pinia/testing`)
+ * with TestForge plugin control options.
  *
- * @see {@link TestingOptions} to configure action stubs and the initial state.
- * @see {@link PluginControlOptions} to use interception methods such as `expose`.
+ * @see {@link TestingOptions} for configuring action stubs, initial state, and Pinia plugins.
+ * @see {@link PluginControlOptions} for instance capturing and exposure mechanisms.
  */
-interface VueTestPiniaOptions extends TestingOptions, PluginControlOptions<Pinia> {
+interface VueTestPiniaOptions extends TestingOptions, PluginControlOptions<TestingPinia> {
     /**
      * A callback function to modify the state of stores before a component is mounted.
      *
@@ -62,6 +69,12 @@ declare module "@testforgejs/vue-test-core" {
     }
 }
 
-declare const piniaPlugin: PluginModuleWithDefaults<Pinia, VueTestPiniaOptions>;
+/**
+ * Managed Pinia testing plugin module for TestForge.
+ *
+ * Provides the runtime definition for creating testing Pinia instances
+ * and exposes the default configuration used by TestForge-managed presets.
+ */
+declare const piniaPlugin: PluginModuleWithDefaults<TestingPinia, VueTestPiniaOptions>;
 
 export { type MockStoresFn, PINIA_PLUGIN_NAME as PLUGIN_NAME, type VueTestPiniaOptions, piniaPlugin, piniaPlugin as plugin };

package/dist/index.d.ts

@@ -1,26 +1,33 @@
-import { Pinia } from 'pinia';
-import { TestingOptions } from '@pinia/testing';
+import { TestingOptions, TestingPinia } from '@pinia/testing';
 import { PluginControlOptions, PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
 
+/**
+ * Stable TestForge identifier for the managed Pinia plugin.
+ *
+ * Use this identifier when declaring Pinia configuration
+ * in presets and other plugin-aware TestForge APIs.
+ */
 declare const PINIA_PLUGIN_NAME: "pinia";
 
 /**
- * A callback function to mutate or configure Pinia stores immediately after they are created.
- * Used to set the initial state (mocking) in tests.
+ * A callback for configuring Pinia stores after the testing Pinia instance
+ * is created and before the component is mounted.
+ *
+ * Use it to initialize or modify stores required by the test.
  *
- * @param pinia - Созданный инстанс Pinia для тестирования.
+ * @param pinia - The testing Pinia instance used by the mounted component.
  */
-type MockStoresFn = (pinia: Pinia) => void;
+type MockStoresFn = (pinia: TestingPinia) => 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.
+ * Combines standard Pinia testing configuration (`TestingOptions` from `@pinia/testing`)
+ * with TestForge plugin control options.
  *
- * @see {@link TestingOptions} to configure action stubs and the initial state.
- * @see {@link PluginControlOptions} to use interception methods such as `expose`.
+ * @see {@link TestingOptions} for configuring action stubs, initial state, and Pinia plugins.
+ * @see {@link PluginControlOptions} for instance capturing and exposure mechanisms.
  */
-interface VueTestPiniaOptions extends TestingOptions, PluginControlOptions<Pinia> {
+interface VueTestPiniaOptions extends TestingOptions, PluginControlOptions<TestingPinia> {
     /**
      * A callback function to modify the state of stores before a component is mounted.
      *
@@ -62,6 +69,12 @@ declare module "@testforgejs/vue-test-core" {
     }
 }
 
-declare const piniaPlugin: PluginModuleWithDefaults<Pinia, VueTestPiniaOptions>;
+/**
+ * Managed Pinia testing plugin module for TestForge.
+ *
+ * Provides the runtime definition for creating testing Pinia instances
+ * and exposes the default configuration used by TestForge-managed presets.
+ */
+declare const piniaPlugin: PluginModuleWithDefaults<TestingPinia, VueTestPiniaOptions>;
 
 export { type MockStoresFn, PINIA_PLUGIN_NAME as PLUGIN_NAME, type VueTestPiniaOptions, piniaPlugin, piniaPlugin as plugin };

package/dist/index.js

@@ -2,7 +2,10 @@
 import { createPluginInstance } from "@testforgejs/vue-test-core";
 import { createTestingPinia } from "@pinia/testing";
 function createPiniaPlugin(options) {
-  const pinia = createPluginInstance(createTestingPinia, options);
+  const pinia = createPluginInstance(
+    createTestingPinia,
+    options
+  );
   if (options.mockStores) {
     options.mockStores(pinia);
   }

package/package.json

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