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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.cjs +0 -15
  2. package/dist/index.d.cts +38 -36
  3. package/dist/index.d.ts +38 -36
  4. package/dist/index.js +0 -15
  5. package/package.json +3 -3
package/dist/index.cjs CHANGED
@@ -51,25 +51,10 @@ var PRIMEVUE_V3_PLUGIN_NAME = "primevueV3";
51
51
 
52
52
  // src/module/primeVuePlugin.ts
53
53
  var primeVuePlugin = {
54
- /**
55
- * Returns the plugin identifier used in TestForge configuration.
56
- *
57
- * @returns The plugin registration key (`"primevueV3"`).
58
- */
59
54
  getName: () => PRIMEVUE_V3_PLUGIN_NAME,
60
- /**
61
- * Returns the PrimeVue 3 plugin lifecycle definition.
62
- *
63
- * @returns Plugin lifecycle hooks consumed by the TestForge kernel.
64
- */
65
55
  getDefinition: () => ({
66
56
  create: createPrimeVuePlugin
67
57
  }),
68
- /**
69
- * Creates the default PrimeVue 3 options used by TestForge.
70
- *
71
- * @returns A factory that creates the default PrimeVue 3 options.
72
- */
73
58
  getDefaultOptions: defaultOptions
74
59
  };
75
60
  // Annotate the CommonJS export names for ESM import in node:
package/dist/index.d.cts CHANGED
@@ -1,70 +1,72 @@
1
1
  import PrimeVue, { PrimeVueConfiguration } from 'primevue/config';
2
2
  import { PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
3
3
 
4
+ /**
5
+ * Stable TestForge identifier for the managed PrimeVue 3 plugin.
6
+ *
7
+ * Use this identifier when declaring PrimeVue 3 configuration
8
+ * in presets and other plugin-aware TestForge APIs.
9
+ */
4
10
  declare const PRIMEVUE_V3_PLUGIN_NAME: "primevueV3";
5
11
 
6
12
  /**
7
- * Vue Test Utils compatible plugin tuple for PrimeVue 3.
13
+ * Vue Test Utils-compatible plugin tuple for PrimeVue 3.
8
14
  *
9
- * PrimeVue 3 is an install-based Vue plugin and therefore integrates
10
- * through a standard `[plugin, options]` tuple instead of a runtime instance.
15
+ * Represents the install-based PrimeVue 3 plugin together with its configuration,
16
+ * as accepted by Vue Test Utils through `global.plugins`.
11
17
  *
12
- * @see {@link PrimeVue}
13
- * @see {@link PrimeVueConfiguration}
18
+ * @see `PrimeVueConfiguration` from `primevue/config`.
14
19
  */
15
20
  type PrimeVueMountPlugin = [typeof PrimeVue, PrimeVueConfiguration];
16
21
  /**
17
- * Configuration options for the PrimeVue 3 TestForge plugin.
22
+ * Configuration options for the managed PrimeVue 3 plugin.
23
+ *
24
+ * Maps directly to the standard PrimeVue 3 configuration.
18
25
  *
19
- * This type maps directly to the official PrimeVue 3 configuration object
20
- * and intentionally does not include TestForge runtime controls such as
21
- * `expose()` or `__meta.instance`, because PrimeVue does not create
22
- * a reusable runtime instance.
26
+ * Unlike plugins that create a dedicated runtime instance, PrimeVue 3 uses
27
+ * an install-based Vue plugin integration and therefore does not support
28
+ * TestForge instance controls such as `expose`.
23
29
  *
24
- * @see {@link PrimeVueConfiguration}
30
+ * @example
31
+ * Configure the managed PrimeVue 3 plugin for a component test:
32
+ *
33
+ * ```ts
34
+ * factory({}, {
35
+ * plugins: {
36
+ * primevueV3: {
37
+ * ripple: true,
38
+ * },
39
+ * },
40
+ * });
41
+ * ```
42
+ *
43
+ * @see `PrimeVueConfiguration` from `primevue/config`.
25
44
  */
26
45
  type VueTestPrimeVueOptions = PrimeVueConfiguration;
27
46
 
28
47
  /**
29
- * Extends TestForge kernel types for PrimeVue 3 integration.
30
- *
31
- * Registers the `primevueV3` configuration key inside the global
32
- * plugin options map, enabling strict typing and IDE autocompletion
33
- * when configuring PrimeVue 3 in component tests.
48
+ * TestForge core type augmentation for PrimeVue 3 integration.
34
49
  *
35
- * @module Augmentation
50
+ * Registers the public plugin configuration type
51
+ * used by TestForge's managed plugin APIs.
36
52
  */
37
53
  declare module "@testforgejs/vue-test-core" {
38
54
  /**
39
- * Global TestForge plugin configuration registry.
55
+ * Global map for TestForge plugin configuration options.
40
56
  */
41
57
  interface PluginOptionsMap {
42
58
  /**
43
- * Configuration for the `primevueV3` plugin.
44
- *
45
- * Accepts standard {@link VueTestPrimeVueOptions},
46
- * which correspond directly to PrimeVue 3 configuration options.
47
- *
48
- * @example
49
- * ```ts
50
- * factory({}, {
51
- * plugins: {
52
- * primevueV3: {
53
- * ripple: true
54
- * }
55
- * }
56
- * })
57
- * ```
59
+ * Configuration accepted by the managed `primevueV3` plugin.
58
60
  */
59
61
  [PRIMEVUE_V3_PLUGIN_NAME]: VueTestPrimeVueOptions;
60
62
  }
61
63
  }
62
64
 
63
65
  /**
64
- * Official TestForge integration module for PrimeVue 3.
66
+ * Managed PrimeVue plugin module for TestForge.
65
67
  *
66
- * Registers PrimeVue 3 in the TestForge plugin pipeline and exposes
67
- * the `primevueV3` configuration key for presets and mount options.
68
+ * Provides the runtime integration for mounting PrimeVue 3 as an install-based
69
+ * Vue plugin and exposes the default configuration used by TestForge-managed presets.
68
70
  */
69
71
  declare const primeVuePlugin: PluginModuleWithDefaults<PrimeVueMountPlugin, VueTestPrimeVueOptions>;
70
72
 
package/dist/index.d.ts CHANGED
@@ -1,70 +1,72 @@
1
1
  import PrimeVue, { PrimeVueConfiguration } from 'primevue/config';
2
2
  import { PluginModuleWithDefaults } from '@testforgejs/vue-test-core';
3
3
 
4
+ /**
5
+ * Stable TestForge identifier for the managed PrimeVue 3 plugin.
6
+ *
7
+ * Use this identifier when declaring PrimeVue 3 configuration
8
+ * in presets and other plugin-aware TestForge APIs.
9
+ */
4
10
  declare const PRIMEVUE_V3_PLUGIN_NAME: "primevueV3";
5
11
 
6
12
  /**
7
- * Vue Test Utils compatible plugin tuple for PrimeVue 3.
13
+ * Vue Test Utils-compatible plugin tuple for PrimeVue 3.
8
14
  *
9
- * PrimeVue 3 is an install-based Vue plugin and therefore integrates
10
- * through a standard `[plugin, options]` tuple instead of a runtime instance.
15
+ * Represents the install-based PrimeVue 3 plugin together with its configuration,
16
+ * as accepted by Vue Test Utils through `global.plugins`.
11
17
  *
12
- * @see {@link PrimeVue}
13
- * @see {@link PrimeVueConfiguration}
18
+ * @see `PrimeVueConfiguration` from `primevue/config`.
14
19
  */
15
20
  type PrimeVueMountPlugin = [typeof PrimeVue, PrimeVueConfiguration];
16
21
  /**
17
- * Configuration options for the PrimeVue 3 TestForge plugin.
22
+ * Configuration options for the managed PrimeVue 3 plugin.
23
+ *
24
+ * Maps directly to the standard PrimeVue 3 configuration.
18
25
  *
19
- * This type maps directly to the official PrimeVue 3 configuration object
20
- * and intentionally does not include TestForge runtime controls such as
21
- * `expose()` or `__meta.instance`, because PrimeVue does not create
22
- * a reusable runtime instance.
26
+ * Unlike plugins that create a dedicated runtime instance, PrimeVue 3 uses
27
+ * an install-based Vue plugin integration and therefore does not support
28
+ * TestForge instance controls such as `expose`.
23
29
  *
24
- * @see {@link PrimeVueConfiguration}
30
+ * @example
31
+ * Configure the managed PrimeVue 3 plugin for a component test:
32
+ *
33
+ * ```ts
34
+ * factory({}, {
35
+ * plugins: {
36
+ * primevueV3: {
37
+ * ripple: true,
38
+ * },
39
+ * },
40
+ * });
41
+ * ```
42
+ *
43
+ * @see `PrimeVueConfiguration` from `primevue/config`.
25
44
  */
26
45
  type VueTestPrimeVueOptions = PrimeVueConfiguration;
27
46
 
28
47
  /**
29
- * Extends TestForge kernel types for PrimeVue 3 integration.
30
- *
31
- * Registers the `primevueV3` configuration key inside the global
32
- * plugin options map, enabling strict typing and IDE autocompletion
33
- * when configuring PrimeVue 3 in component tests.
48
+ * TestForge core type augmentation for PrimeVue 3 integration.
34
49
  *
35
- * @module Augmentation
50
+ * Registers the public plugin configuration type
51
+ * used by TestForge's managed plugin APIs.
36
52
  */
37
53
  declare module "@testforgejs/vue-test-core" {
38
54
  /**
39
- * Global TestForge plugin configuration registry.
55
+ * Global map for TestForge plugin configuration options.
40
56
  */
41
57
  interface PluginOptionsMap {
42
58
  /**
43
- * Configuration for the `primevueV3` plugin.
44
- *
45
- * Accepts standard {@link VueTestPrimeVueOptions},
46
- * which correspond directly to PrimeVue 3 configuration options.
47
- *
48
- * @example
49
- * ```ts
50
- * factory({}, {
51
- * plugins: {
52
- * primevueV3: {
53
- * ripple: true
54
- * }
55
- * }
56
- * })
57
- * ```
59
+ * Configuration accepted by the managed `primevueV3` plugin.
58
60
  */
59
61
  [PRIMEVUE_V3_PLUGIN_NAME]: VueTestPrimeVueOptions;
60
62
  }
61
63
  }
62
64
 
63
65
  /**
64
- * Official TestForge integration module for PrimeVue 3.
66
+ * Managed PrimeVue plugin module for TestForge.
65
67
  *
66
- * Registers PrimeVue 3 in the TestForge plugin pipeline and exposes
67
- * the `primevueV3` configuration key for presets and mount options.
68
+ * Provides the runtime integration for mounting PrimeVue 3 as an install-based
69
+ * Vue plugin and exposes the default configuration used by TestForge-managed presets.
68
70
  */
69
71
  declare const primeVuePlugin: PluginModuleWithDefaults<PrimeVueMountPlugin, VueTestPrimeVueOptions>;
70
72
 
package/dist/index.js CHANGED
@@ -13,25 +13,10 @@ var PRIMEVUE_V3_PLUGIN_NAME = "primevueV3";
13
13
 
14
14
  // src/module/primeVuePlugin.ts
15
15
  var primeVuePlugin = {
16
- /**
17
- * Returns the plugin identifier used in TestForge configuration.
18
- *
19
- * @returns The plugin registration key (`"primevueV3"`).
20
- */
21
16
  getName: () => PRIMEVUE_V3_PLUGIN_NAME,
22
- /**
23
- * Returns the PrimeVue 3 plugin lifecycle definition.
24
- *
25
- * @returns Plugin lifecycle hooks consumed by the TestForge kernel.
26
- */
27
17
  getDefinition: () => ({
28
18
  create: createPrimeVuePlugin
29
19
  }),
30
- /**
31
- * Creates the default PrimeVue 3 options used by TestForge.
32
- *
33
- * @returns A factory that creates the default PrimeVue 3 options.
34
- */
35
20
  getDefaultOptions: defaultOptions
36
21
  };
37
22
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@testforgejs/vue-test-plugin-primevue-v3",
3
- "version": "1.0.0-beta.3",
3
+ "version": "1.0.0-beta.4",
4
4
  "type": "module",
5
5
  "description": "Official TestForge plugin for PrimeVue 3 integration in component tests",
6
6
  "homepage": "https://github.com/testforgejs/testforge#readme",
@@ -42,11 +42,11 @@
42
42
  "author": "Roman Levchenko",
43
43
  "peerDependencies": {
44
44
  "primevue": "^3.0.0",
45
- "@testforgejs/vue-test-core": "1.0.0-beta.3"
45
+ "@testforgejs/vue-test-core": "1.0.0-beta.4"
46
46
  },
47
47
  "devDependencies": {
48
48
  "primevue": "^3.0.0",
49
- "@testforgejs/vue-test-core": "1.0.0-beta.3"
49
+ "@testforgejs/vue-test-core": "1.0.0-beta.4"
50
50
  },
51
51
  "testforge": {
52
52
  "plugin": {