@testforgejs/vue-test-plugin-primevue-v3 1.0.0-beta.3

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,203 @@
+# @testforgejs/vue-test-plugin-primevue-v3
+
+PrimeVue 3 integration for TestForge component tests.
+
+## Installation
+
+Choose your preferred package manager.
+
+### pnpm
+
+```bash
+pnpm add -D @testforgejs/vue-test-plugin-primevue-v3@beta
+```
+
+### npm
+
+```bash
+npm install -D @testforgejs/vue-test-plugin-primevue-v3@beta
+```
+
+### Yarn
+
+```bash
+yarn add -D @testforgejs/vue-test-plugin-primevue-v3@beta
+```
+
+> `@testforgejs/vue-test-core` is required.
+
+## Usage
+
+### Using plugin defaults
+
+The plugin provides a project-independent default configuration through `getDefaultOptions()`:
+
+```typescript
+import { createTestFramework } from "@testforgejs/vue-test-core";
+import { primeVuePlugin } from "@testforgejs/vue-test-plugin-primevue-v3";
+
+const framework = createTestFramework({
+  presets: {
+    default: {
+      manifest: [
+        {
+          module: primeVuePlugin,
+          enabled: true,
+        },
+      ],
+      defaults: {
+        primevueV3: primeVuePlugin.getDefaultOptions(),
+      },
+    },
+  },
+});
+
+const factory = framework.testComponentFactory(MyComponent);
+
+const wrapper = factory();
+```
+
+`getDefaultOptions()` returns an options factory suitable for use in a preset.
+
+The plugin-provided defaults use an empty PrimeVue configuration:
+
+```typescript
+{
+}
+```
+
+This preserves PrimeVue 3's standard configuration without introducing project-specific behavior or forcing unstyled mode.
+
+Plugin defaults are **not applied automatically**. Adding the plugin to a preset manifest declares that the plugin is available and whether it is enabled; the preset explicitly decides whether to use the plugin-provided defaults or provide its own configuration.
+
+### Providing custom options
+
+You can define the PrimeVue configuration directly in the preset instead:
+
+```typescript
+import { createTestFramework } from "@testforgejs/vue-test-core";
+import { primeVuePlugin } from "@testforgejs/vue-test-plugin-primevue-v3";
+
+const framework = createTestFramework({
+  presets: {
+    default: {
+      manifest: [
+        {
+          module: primeVuePlugin,
+          enabled: true,
+        },
+      ],
+      defaults: {
+        primevueV3: () => ({
+          ripple: true,
+          inputStyle: "filled",
+        }),
+      },
+    },
+  },
+});
+```
+
+Using `getDefaultOptions()` is optional. Define custom defaults when tests require application-specific PrimeVue configuration such as ripple effects, input styling, locale settings, pass-through configuration, unstyled mode, or other PrimeVue behavior.
+
+## Configuration
+
+### PrimeVue options
+
+The plugin integrates TestForge with PrimeVue 3 by registering the PrimeVue Vue plugin with the provided configuration.
+
+Configuration fields such as `ripple`, `inputStyle`, `locale`, `pt`, `unstyled`, and other PrimeVue options belong to PrimeVue.
+
+TestForge does not define an alternative configuration format for PrimeVue. The integration passes the provided configuration to the PrimeVue plugin during installation.
+
+Refer to the PrimeVue 3 documentation for the complete set of supported configuration options and their behavior.
+
+### Styled and unstyled modes
+
+The plugin-provided defaults do not select a styling mode explicitly:
+
+```typescript
+{
+}
+```
+
+PrimeVue 3 uses styled mode by default. Application themes in styled mode are configured separately by loading the corresponding PrimeVue theme CSS.
+
+For example, theme setup belongs to the application's test environment or project configuration rather than the TestForge plugin options.
+
+PrimeVue 3 also supports unstyled mode when explicitly enabled:
+
+```typescript
+defaults: {
+  primevueV3: () => ({
+    unstyled: true,
+  }),
+},
+```
+
+Use a project-specific preset when component tests need to reproduce application-specific PrimeVue configuration.
+
+### Options factories
+
+Preset defaults are defined as factories:
+
+```typescript
+defaults: {
+  primevueV3: () => ({
+    ripple: true,
+    inputStyle: "filled",
+  }),
+},
+```
+
+Each invocation of the factory produces a fresh options object for the current TestForge pipeline execution.
+
+`primeVuePlugin.getDefaultOptions()` follows the same contract: it returns an options factory rather than a shared options object.
+
+This allows presets to choose explicitly between:
+
+- the project-independent defaults provided by the plugin; and
+- a custom PrimeVue configuration defined by the preset.
+
+## Package exports
+
+The package provides both descriptive and standardized plugin exports:
+
+```typescript
+import { primeVuePlugin, plugin, PLUGIN_NAME } from "@testforgejs/vue-test-plugin-primevue-v3";
+```
+
+### `primeVuePlugin`
+
+The descriptive PrimeVue 3 plugin module export.
+
+### `plugin`
+
+The standardized plugin module export.
+
+It references the same plugin module as `primeVuePlugin` and provides a consistent package-level API across TestForge plugin packages.
+
+### `PLUGIN_NAME`
+
+The standardized plugin identifier export.
+
+For this package:
+
+```typescript
+PLUGIN_NAME === "primevueV3";
+```
+
+The standardized `plugin` and `PLUGIN_NAME` exports are useful for tooling and other code that works with TestForge plugin packages generically.
+
+## Supported versions
+
+- Vue: 3.3.0 or higher
+- PrimeVue: 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-primevue-v3/docs/api/README.md).

package/dist/index.cjs

@@ -0,0 +1,80 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  PLUGIN_NAME: () => PRIMEVUE_V3_PLUGIN_NAME,
+  plugin: () => primeVuePlugin,
+  primeVuePlugin: () => primeVuePlugin
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/module/createPrimeVuePlugin.ts
+var import_config = __toESM(require("primevue/config"), 1);
+var import_vue_test_core = require("@testforgejs/vue-test-core");
+function createPrimeVuePlugin(options) {
+  return (0, import_vue_test_core.createVuePlugin)(import_config.default, options);
+}
+
+// src/defaults.ts
+var defaultOptions = () => () => ({});
+
+// src/constants/constants.ts
+var PRIMEVUE_V3_PLUGIN_NAME = "primevueV3";
+
+// src/module/primeVuePlugin.ts
+var primeVuePlugin = {
+  /**
+   * Returns the plugin identifier used in TestForge configuration.
+   *
+   * @returns The plugin registration key (`"primevueV3"`).
+   */
+  getName: () => PRIMEVUE_V3_PLUGIN_NAME,
+  /**
+   * Returns the PrimeVue 3 plugin lifecycle definition.
+   *
+   * @returns Plugin lifecycle hooks consumed by the TestForge kernel.
+   */
+  getDefinition: () => ({
+    create: createPrimeVuePlugin
+  }),
+  /**
+   * Creates the default PrimeVue 3 options used by TestForge.
+   *
+   * @returns A factory that creates the default PrimeVue 3 options.
+   */
+  getDefaultOptions: defaultOptions
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PLUGIN_NAME,
+  plugin,
+  primeVuePlugin
+});

package/dist/index.d.cts

@@ -0,0 +1,71 @@
+import PrimeVue, { PrimeVueConfiguration } from 'primevue/config';
+import { PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
+
+declare const PRIMEVUE_V3_PLUGIN_NAME: "primevueV3";
+
+/**
+ * Vue Test Utils compatible plugin tuple for PrimeVue 3.
+ *
+ * PrimeVue 3 is an install-based Vue plugin and therefore integrates
+ * through a standard `[plugin, options]` tuple instead of a runtime instance.
+ *
+ * @see {@link PrimeVue}
+ * @see {@link PrimeVueConfiguration}
+ */
+type PrimeVueMountPlugin = [typeof PrimeVue, PrimeVueConfiguration];
+/**
+ * Configuration options for the PrimeVue 3 TestForge plugin.
+ *
+ * This type maps directly to the official PrimeVue 3 configuration object
+ * and intentionally does not include TestForge runtime controls such as
+ * `expose()` or `__meta.instance`, because PrimeVue does not create
+ * a reusable runtime instance.
+ *
+ * @see {@link PrimeVueConfiguration}
+ */
+type VueTestPrimeVueOptions = PrimeVueConfiguration;
+
+/**
+ * Extends TestForge kernel types for PrimeVue 3 integration.
+ *
+ * Registers the `primevueV3` configuration key inside the global
+ * plugin options map, enabling strict typing and IDE autocompletion
+ * when configuring PrimeVue 3 in component tests.
+ *
+ * @module Augmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * Global TestForge plugin configuration registry.
+     */
+    interface PluginOptionsMap {
+        /**
+         * Configuration for the `primevueV3` plugin.
+         *
+         * Accepts standard {@link VueTestPrimeVueOptions},
+         * which correspond directly to PrimeVue 3 configuration options.
+         *
+         * @example
+         * ```ts
+         * factory({}, {
+         *   plugins: {
+         *     primevueV3: {
+         *       ripple: true
+         *     }
+         *   }
+         * })
+         * ```
+         */
+        [PRIMEVUE_V3_PLUGIN_NAME]: VueTestPrimeVueOptions;
+    }
+}
+
+/**
+ * Official TestForge integration module for PrimeVue 3.
+ *
+ * Registers PrimeVue 3 in the TestForge plugin pipeline and exposes
+ * the `primevueV3` configuration key for presets and mount options.
+ */
+declare const primeVuePlugin: PluginModuleWithDefaults<PrimeVueMountPlugin, VueTestPrimeVueOptions>;
+
+export { PRIMEVUE_V3_PLUGIN_NAME as PLUGIN_NAME, type PrimeVueMountPlugin, type VueTestPrimeVueOptions, primeVuePlugin as plugin, primeVuePlugin };

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+import PrimeVue, { PrimeVueConfiguration } from 'primevue/config';
+import { PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
+
+declare const PRIMEVUE_V3_PLUGIN_NAME: "primevueV3";
+
+/**
+ * Vue Test Utils compatible plugin tuple for PrimeVue 3.
+ *
+ * PrimeVue 3 is an install-based Vue plugin and therefore integrates
+ * through a standard `[plugin, options]` tuple instead of a runtime instance.
+ *
+ * @see {@link PrimeVue}
+ * @see {@link PrimeVueConfiguration}
+ */
+type PrimeVueMountPlugin = [typeof PrimeVue, PrimeVueConfiguration];
+/**
+ * Configuration options for the PrimeVue 3 TestForge plugin.
+ *
+ * This type maps directly to the official PrimeVue 3 configuration object
+ * and intentionally does not include TestForge runtime controls such as
+ * `expose()` or `__meta.instance`, because PrimeVue does not create
+ * a reusable runtime instance.
+ *
+ * @see {@link PrimeVueConfiguration}
+ */
+type VueTestPrimeVueOptions = PrimeVueConfiguration;
+
+/**
+ * Extends TestForge kernel types for PrimeVue 3 integration.
+ *
+ * Registers the `primevueV3` configuration key inside the global
+ * plugin options map, enabling strict typing and IDE autocompletion
+ * when configuring PrimeVue 3 in component tests.
+ *
+ * @module Augmentation
+ */
+declare module "@testforgejs/vue-test-core" {
+    /**
+     * Global TestForge plugin configuration registry.
+     */
+    interface PluginOptionsMap {
+        /**
+         * Configuration for the `primevueV3` plugin.
+         *
+         * Accepts standard {@link VueTestPrimeVueOptions},
+         * which correspond directly to PrimeVue 3 configuration options.
+         *
+         * @example
+         * ```ts
+         * factory({}, {
+         *   plugins: {
+         *     primevueV3: {
+         *       ripple: true
+         *     }
+         *   }
+         * })
+         * ```
+         */
+        [PRIMEVUE_V3_PLUGIN_NAME]: VueTestPrimeVueOptions;
+    }
+}
+
+/**
+ * Official TestForge integration module for PrimeVue 3.
+ *
+ * Registers PrimeVue 3 in the TestForge plugin pipeline and exposes
+ * the `primevueV3` configuration key for presets and mount options.
+ */
+declare const primeVuePlugin: PluginModuleWithDefaults<PrimeVueMountPlugin, VueTestPrimeVueOptions>;
+
+export { PRIMEVUE_V3_PLUGIN_NAME as PLUGIN_NAME, type PrimeVueMountPlugin, type VueTestPrimeVueOptions, primeVuePlugin as plugin, primeVuePlugin };

package/dist/index.js

@@ -0,0 +1,41 @@
+// src/module/createPrimeVuePlugin.ts
+import PrimeVue from "primevue/config";
+import { createVuePlugin } from "@testforgejs/vue-test-core";
+function createPrimeVuePlugin(options) {
+  return createVuePlugin(PrimeVue, options);
+}
+
+// src/defaults.ts
+var defaultOptions = () => () => ({});
+
+// src/constants/constants.ts
+var PRIMEVUE_V3_PLUGIN_NAME = "primevueV3";
+
+// src/module/primeVuePlugin.ts
+var primeVuePlugin = {
+  /**
+   * Returns the plugin identifier used in TestForge configuration.
+   *
+   * @returns The plugin registration key (`"primevueV3"`).
+   */
+  getName: () => PRIMEVUE_V3_PLUGIN_NAME,
+  /**
+   * Returns the PrimeVue 3 plugin lifecycle definition.
+   *
+   * @returns Plugin lifecycle hooks consumed by the TestForge kernel.
+   */
+  getDefinition: () => ({
+    create: createPrimeVuePlugin
+  }),
+  /**
+   * Creates the default PrimeVue 3 options used by TestForge.
+   *
+   * @returns A factory that creates the default PrimeVue 3 options.
+   */
+  getDefaultOptions: defaultOptions
+};
+export {
+  PRIMEVUE_V3_PLUGIN_NAME as PLUGIN_NAME,
+  primeVuePlugin as plugin,
+  primeVuePlugin
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@testforgejs/vue-test-plugin-primevue-v3",
+  "version": "1.0.0-beta.3",
+  "type": "module",
+  "description": "Official TestForge plugin for PrimeVue 3 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-primevue-v3"
+  },
+  "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",
+    "primevue",
+    "testforge",
+    "testforge-plugin"
+  ],
+  "license": "MIT",
+  "author": "Roman Levchenko",
+  "peerDependencies": {
+    "primevue": "^3.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.3"
+  },
+  "devDependencies": {
+    "primevue": "^3.0.0",
+    "@testforgejs/vue-test-core": "1.0.0-beta.3"
+  },
+  "testforge": {
+    "plugin": {
+      "schemaVersion": 1,
+      "displayName": "PrimeVue 3"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test:types": "tsd",
+    "docs:generate": "typedoc"
+  }
+}