@code-pushup/axe-plugin 0.105.0 → 0.106.0

package/README.md

@@ -163,51 +163,105 @@ Use `npx code-pushup print-config --onlyPlugins=axe` to list all audits and grou
 
 The plugin provides helpers to integrate Axe results into your categories.
 
-### Auto-generate accessibility category
+### Building categories with ref helpers
 
-Use `axeCategories` to automatically create an accessibility category from all plugin groups:
+Use `axeGroupRefs` and `axeAuditRefs` to build categories. These helpers automatically handle multi-URL expansion:
 
 ```ts
-import axePlugin, { axeCategories } from '@code-pushup/axe-plugin';
+import axePlugin, { axeGroupRefs } from '@code-pushup/axe-plugin';
 
 const axe = axePlugin('https://example.com');
 
 export default {
   plugins: [axe],
-  categories: axeCategories(axe),
+  categories: [
+    {
+      slug: 'a11y',
+      title: 'Accessibility',
+      refs: axeGroupRefs(axe),
+    },
+  ],
 };
 ```
 
-This configuration works with both single-URL and multi-URL configurations. For multi-URL setups, refs are automatically expanded for each URL with appropriate weights.
+For multi-URL setups, refs are automatically expanded for each URL with appropriate weights:
 
-### Custom categories
+```ts
+import axePlugin, { axeGroupRefs } from '@code-pushup/axe-plugin';
 
-For fine-grained control, provide your own categories with specific groups:
+const axe = axePlugin({
+  'https://example.com': 2,
+  'https://example.com/about': 1,
+});
+
+export default {
+  plugins: [axe],
+  categories: [
+    {
+      slug: 'a11y',
+      title: 'Accessibility',
+      refs: axeGroupRefs(axe),
+    },
+  ],
+};
+```
+
+### Custom categories with specific groups
+
+For fine-grained control, specify which groups to include:
 
 ```ts
-import axePlugin, { axeCategories, axeGroupRef } from '@code-pushup/axe-plugin';
+import axePlugin, { axeGroupRefs } from '@code-pushup/axe-plugin';
 
-const axe = axePlugin(['https://example.com', 'https://example.com/about']);
+const axe = axePlugin('https://example.com');
 
 export default {
   plugins: [axe],
-  categories: axeCategories(axe, [
+  categories: [
+    {
+      slug: 'a11y',
+      title: 'Accessibility',
+      refs: [...axeGroupRefs(axe, 'aria', 2), ...axeGroupRefs(axe, 'color'), ...axeGroupRefs(axe, 'keyboard')],
+    },
+  ],
+};
+```
+
+### Combining with Lighthouse
+
+For comprehensive accessibility testing, combine Axe with Lighthouse's accessibility group in a single category:
+
+```ts
+import axePlugin, { axeGroupRefs } from '@code-pushup/axe-plugin';
+import lighthousePlugin, { lighthouseGroupRefs } from '@code-pushup/lighthouse-plugin';
+
+const urls = ['https://example.com', 'https://example.com/about'];
+const axe = axePlugin(urls);
+const lighthouse = await lighthousePlugin(urls);
+
+export default {
+  plugins: [axe, lighthouse],
+  categories: [
     {
-      slug: 'axe-a11y',
-      title: 'Axe Accessibility',
-      refs: [axeGroupRef('aria', 2), axeGroupRef('color'), axeGroupRef('keyboard')],
+      slug: 'a11y',
+      title: 'Accessibility',
+      refs: [...lighthouseGroupRefs(lighthouse, 'accessibility'), ...axeGroupRefs(axe)],
     },
-  ]),
+  ],
 };
 ```
 
+This gives you both Lighthouse's performance-focused accessibility audits and Axe's comprehensive WCAG coverage in one category score.
+
 ### Helper functions
 
-| Function        | Description                            |
-| --------------- | -------------------------------------- |
-| `axeCategories` | Auto-generates or expands categories   |
-| `axeGroupRef`   | Creates a category ref to an Axe group |
-| `axeAuditRef`   | Creates a category ref to an Axe audit |
+| Function       | Description                                              |
+| -------------- | -------------------------------------------------------- |
+| `axeGroupRefs` | Creates category refs to Axe group(s), handles multi-URL |
+| `axeAuditRefs` | Creates category refs to Axe audit(s), handles multi-URL |
+
+> [!TIP]
+> Weights determine each ref's influence on the category score. Use weight `0` to include a ref as info only, without affecting the score.
 
 ### Type safety
 
@@ -219,6 +273,16 @@ import type { AxeGroupSlug } from '@code-pushup/axe-plugin';
 const group: AxeGroupSlug = 'aria';
 ```
 
+### Deprecated helpers
+
+The following helpers are deprecated and will be removed in a future version:
+
+| Function        | Replacement                                       |
+| --------------- | ------------------------------------------------- |
+| `axeCategories` | Build categories manually with `axeGroupRefs`     |
+| `axeGroupRef`   | Use `axeGroupRefs` (plural) for multi-URL support |
+| `axeAuditRef`   | Use `axeAuditRefs` (plural) for multi-URL support |
+
 ## Resources
 
 - **[Axe-core rules](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md)** - Complete list of accessibility rules

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/axe-plugin",
-  "version": "0.105.0",
+  "version": "0.106.0",
   "license": "MIT",
   "description": "Code PushUp plugin for detecting accessibility issues using Axe 🌐",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-axe#readme",
@@ -42,8 +42,8 @@
   "type": "module",
   "dependencies": {
     "@axe-core/playwright": "^4.11.0",
-    "@code-pushup/models": "0.105.0",
-    "@code-pushup/utils": "0.105.0",
+    "@code-pushup/models": "0.106.0",
+    "@code-pushup/utils": "0.106.0",
     "axe-core": "^4.11.0",
     "playwright-core": "^1.56.1",
     "zod": "^4.1.12"

package/src/index.d.ts

@@ -2,5 +2,5 @@ import { axePlugin } from './lib/axe-plugin.js';
 export default axePlugin;
 export type { AxePluginOptions, AxePreset } from './lib/config.js';
 export type { AxeGroupSlug } from './lib/groups.js';
-export { axeAuditRef, axeGroupRef } from './lib/utils.js';
+export { axeAuditRef, axeAuditRefs, axeGroupRef, axeGroupRefs, } from './lib/utils.js';
 export { axeCategories } from './lib/categories.js';

package/src/index.js

@@ -1,5 +1,5 @@
 import { axePlugin } from './lib/axe-plugin.js';
 export default axePlugin;
-export { axeAuditRef, axeGroupRef } from './lib/utils.js';
+export { axeAuditRef, axeAuditRefs, axeGroupRef, axeGroupRefs, } from './lib/utils.js';
 export { axeCategories } from './lib/categories.js';
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,eAAe,SAAS,CAAC;AAKzB,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,eAAe,SAAS,CAAC;AAKzB,OAAO,EACL,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,GACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC"}

package/src/lib/categories.d.ts

@@ -1,22 +1,20 @@
-import type { CategoryConfig, Group, PluginConfig } from '@code-pushup/models';
+import { type CategoryConfig, type PluginConfig } from '@code-pushup/models';
 import { type PluginUrlContext } from '@code-pushup/utils';
-import { type AxeCategoryGroupSlug } from './groups.js';
 /**
- * Creates categories for the Axe plugin.
- *
- * @public
- * @param plugin - {@link PluginConfig} object with groups and context
- * @param categories - {@link CategoryConfig} optional user-defined categories
- * @returns {CategoryConfig[]} - expanded and aggregated categories
+ * @deprecated Use `axeGroupRefs` to build categories manually instead.
  *
  * @example
- * const axe = await axePlugin(urls);
- * const axeCoreConfig = {
- *   plugins: [axe],
- *   categories: axeCategories(axe),
- * };
+ * // Instead of:
+ * const categories = axeCategories(axePlugin);
+ *
+ * // Use:
+ * const categories = [
+ *   {
+ *     slug: 'a11y',
+ *     title: 'Accessibility',
+ *     refs: axeGroupRefs(axePlugin),
+ *   },
+ * ];
  */
 export declare function axeCategories(plugin: Pick<PluginConfig, 'groups' | 'context'>, categories?: CategoryConfig[]): CategoryConfig[];
-export declare function createAggregatedCategory(groups: Group[], context: PluginUrlContext): CategoryConfig;
 export declare function expandAggregatedCategory(category: CategoryConfig, context: PluginUrlContext): CategoryConfig;
-export declare function extractGroupSlugs(groups: Group[]): AxeCategoryGroupSlug[];

package/src/lib/categories.js

@@ -1,56 +1,52 @@
-import { createCategoryRefs, expandCategoryRefs, removeIndex, shouldExpandForUrls, validateUrlContext, } from '@code-pushup/utils';
+import { validate, } from '@code-pushup/models';
+import { expandCategoryRefs, pluginUrlContextSchema, shouldExpandForUrls, } from '@code-pushup/utils';
 import { AXE_PLUGIN_SLUG } from './constants.js';
-import { isAxeGroupSlug } from './groups.js';
+import { axeGroupRefs } from './utils.js';
 /**
- * Creates categories for the Axe plugin.
- *
- * @public
- * @param plugin - {@link PluginConfig} object with groups and context
- * @param categories - {@link CategoryConfig} optional user-defined categories
- * @returns {CategoryConfig[]} - expanded and aggregated categories
+ * @deprecated Use `axeGroupRefs` to build categories manually instead.
  *
  * @example
- * const axe = await axePlugin(urls);
- * const axeCoreConfig = {
- *   plugins: [axe],
- *   categories: axeCategories(axe),
- * };
+ * // Instead of:
+ * const categories = axeCategories(axePlugin);
+ *
+ * // Use:
+ * const categories = [
+ *   {
+ *     slug: 'a11y',
+ *     title: 'Accessibility',
+ *     refs: axeGroupRefs(axePlugin),
+ *   },
+ * ];
  */
 export function axeCategories(plugin, categories) {
     if (!plugin.groups || plugin.groups.length === 0) {
         return categories ?? [];
     }
-    validateUrlContext(plugin.context);
     if (!categories) {
-        return createCategories(plugin.groups, plugin.context);
+        return createCategories(plugin);
     }
-    return expandCategories(categories, plugin.context);
+    return expandCategories(plugin, categories);
 }
-function createCategories(groups, context) {
-    return [createAggregatedCategory(groups, context)];
+function createCategories(plugin) {
+    return [
+        {
+            slug: 'axe-a11y',
+            title: 'Axe Accessibility',
+            refs: axeGroupRefs(plugin),
+        },
+    ];
 }
-function expandCategories(categories, context) {
+function expandCategories(plugin, categories) {
+    const context = validate(pluginUrlContextSchema, plugin.context);
     if (!shouldExpandForUrls(context.urlCount)) {
         return categories;
     }
     return categories.map(category => expandAggregatedCategory(category, context));
 }
-export function createAggregatedCategory(groups, context) {
-    const refs = extractGroupSlugs(groups).flatMap(slug => createCategoryRefs(slug, AXE_PLUGIN_SLUG, context));
-    return {
-        slug: 'axe-a11y',
-        title: 'Axe Accessibility',
-        refs,
-    };
-}
 export function expandAggregatedCategory(category, context) {
     return {
         ...category,
         refs: category.refs.flatMap(ref => ref.plugin === AXE_PLUGIN_SLUG ? expandCategoryRefs(ref, context) : [ref]),
     };
 }
-export function extractGroupSlugs(groups) {
-    const slugs = groups.map(({ slug }) => removeIndex(slug));
-    return [...new Set(slugs)].filter(isAxeGroupSlug);
-}
 //# sourceMappingURL=categories.js.map

package/src/lib/categories.js.map

@@ -1 +1 @@
-{"version":3,"file":"categories.js","sourceRoot":"","sources":["../../../src/lib/categories.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAA6B,cAAc,EAAE,MAAM,aAAa,CAAC;AAExE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAgD,EAChD,UAA6B;IAE7B,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjD,OAAO,UAAU,IAAI,EAAE,CAAC;IAC1B,CAAC;IACD,kBAAkB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACnC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAe,EACf,OAAyB;IAEzB,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,gBAAgB,CACvB,UAA4B,EAC5B,OAAyB;IAEzB,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3C,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAC/B,wBAAwB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,MAAe,EACf,OAAyB;IAEzB,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CACpD,kBAAkB,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,CACnD,CAAC;IACF,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,mBAAmB;QAC1B,IAAI;KACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,QAAwB,EACxB,OAAyB;IAEzB,OAAO;QACL,GAAG,QAAQ;QACX,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAChC,GAAG,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAC1E;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAe;IAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AACpD,CAAC"}
+{"version":3,"file":"categories.js","sourceRoot":"","sources":["../../../src/lib/categories.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,GACT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,kBAAkB,EAClB,sBAAsB,EACtB,mBAAmB,GACpB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAgD,EAChD,UAA6B;IAE7B,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjD,OAAO,UAAU,IAAI,EAAE,CAAC;IAC1B,CAAC;IACD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,gBAAgB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAgD;IAEhD,OAAO;QACL;YACE,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;SAC3B;KACF,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CACvB,MAAqC,EACrC,UAA4B;IAE5B,MAAM,OAAO,GAAG,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACjE,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3C,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAC/B,wBAAwB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,QAAwB,EACxB,OAAyB;IAEzB,OAAO;QACL,GAAG,QAAQ;QACX,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAChC,GAAG,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAC1E;KACF,CAAC;AACJ,CAAC"}

package/src/lib/groups.js

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { axePresetSchema } from './config.js';
-/* WCAG presets for rule loading */
+/** WCAG presets for rule loading */
 const axeWcagTags = [
     'wcag2a',
     'wcag21a',
@@ -21,7 +21,7 @@ const WCAG_PRESET_TAGS = {
 export function getWcagPresetTags(preset) {
     return WCAG_PRESET_TAGS[preset];
 }
-/* Category groups for all presets */
+/** Category groups for all presets */
 const axeCategoryGroupSlugs = [
     'aria',
     'color',
@@ -58,6 +58,6 @@ export const CATEGORY_GROUPS = {
 export function isAxeGroupSlug(slug) {
     return axeCategoryGroupSlugSchema.safeParse(slug).success;
 }
-/* Combined exports */
+// Combined exports
 export const axeGroupSlugSchema = axeCategoryGroupSlugSchema;
 //# sourceMappingURL=groups.js.map

package/src/lib/groups.js.map

@@ -1 +1 @@
-{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../../src/lib/groups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,mCAAmC;AACnC,MAAM,WAAW,GAAG;IAClB,QAAQ;IACR,SAAS;IACT,SAAS;IACT,UAAU;IACV,UAAU;CACF,CAAC;AAEX,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,IAAI,CAAC,WAAW,CAAC;KACjB,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;AAIjC,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe;KAC/C,OAAO,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;KACjC,IAAI,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;AAIpC,MAAM,gBAAgB,GAAwC;IAC5D,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC;IACtD,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC;CACnE,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,MAAqB;IACrD,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAED,qCAAqC;AACrC,MAAM,qBAAqB,GAAG;IAC5B,MAAM;IACN,OAAO;IACP,OAAO;IACP,UAAU;IACV,UAAU;IACV,iBAAiB;IACjB,SAAS;IACT,WAAW;IACX,yBAAyB;IACzB,WAAW;IACX,QAAQ;IACR,mBAAmB;IACnB,gBAAgB;CACR,CAAC;AAEX,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,IAAI,CAAC,qBAAqB,CAAC;KAC3B,IAAI,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC;AAI3C,MAAM,CAAC,MAAM,eAAe,GAAyC;IACnE,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,kBAAkB;IACzB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,iBAAiB,EAAE,gBAAgB;IACnC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,yBAAyB,EAAE,aAAa;IACxC,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,mBAAmB,EAAE,mBAAmB;IACxC,gBAAgB,EAAE,OAAO;CAC1B,CAAC;AAEF,MAAM,UAAU,cAAc,CAAC,IAAa;IAC1C,OAAO,0BAA0B,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;AAC5D,CAAC;AAED,sBAAsB;AACtB,MAAM,CAAC,MAAM,kBAAkB,GAAG,0BAA0B,CAAC"}
+{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../../src/lib/groups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,oCAAoC;AACpC,MAAM,WAAW,GAAG;IAClB,QAAQ;IACR,SAAS;IACT,SAAS;IACT,UAAU;IACV,UAAU;CACF,CAAC;AAEX,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,IAAI,CAAC,WAAW,CAAC;KACjB,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;AAIjC,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe;KAC/C,OAAO,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;KACjC,IAAI,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;AAIpC,MAAM,gBAAgB,GAAwC;IAC5D,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC;IACtD,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC;CACnE,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,MAAqB;IACrD,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC;AAED,sCAAsC;AACtC,MAAM,qBAAqB,GAAG;IAC5B,MAAM;IACN,OAAO;IACP,OAAO;IACP,UAAU;IACV,UAAU;IACV,iBAAiB;IACjB,SAAS;IACT,WAAW;IACX,yBAAyB;IACzB,WAAW;IACX,QAAQ;IACR,mBAAmB;IACnB,gBAAgB;CACR,CAAC;AAEX,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,IAAI,CAAC,qBAAqB,CAAC;KAC3B,IAAI,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,CAAC,CAAC;AAI3C,MAAM,CAAC,MAAM,eAAe,GAAyC;IACnE,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,kBAAkB;IACzB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,iBAAiB,EAAE,gBAAgB;IACnC,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;IACtB,yBAAyB,EAAE,aAAa;IACxC,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,mBAAmB,EAAE,mBAAmB;IACxC,gBAAgB,EAAE,OAAO;CAC1B,CAAC;AAEF,MAAM,UAAU,cAAc,CAAC,IAAa;IAC1C,OAAO,0BAA0B,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;AAC5D,CAAC;AAED,mBAAmB;AACnB,MAAM,CAAC,MAAM,kBAAkB,GAAG,0BAA0B,CAAC"}

package/src/lib/utils.d.ts

@@ -1,4 +1,28 @@
-import type { CategoryRef } from '@code-pushup/models';
-import type { AxeGroupSlug } from './groups.js';
+import { type CategoryRef, type PluginConfig } from '@code-pushup/models';
+import { type AxeGroupSlug } from './groups.js';
+/**
+ * @deprecated Use `axeGroupRefs` instead for multi-URL support.
+ */
 export declare function axeGroupRef(groupSlug: AxeGroupSlug, weight?: number): CategoryRef;
+/**
+ * @deprecated Use `axeAuditRefs` instead for multi-URL support.
+ */
 export declare function axeAuditRef(auditSlug: string, weight?: number): CategoryRef;
+/**
+ * Creates category refs for Axe groups with multi-URL support.
+ *
+ * @param plugin - Axe plugin instance
+ * @param groupSlug - Optional group slug; if omitted, includes all groups
+ * @param groupWeight - Optional weight for the ref(s)
+ * @returns Array of category refs, expanded for each URL in multi-URL configs
+ */
+export declare function axeGroupRefs(plugin: Pick<PluginConfig, 'groups' | 'context'>, groupSlug?: AxeGroupSlug, groupWeight?: number): CategoryRef[];
+/**
+ * Creates category refs for Axe audits with multi-URL support.
+ *
+ * @param plugin - Axe plugin instance
+ * @param auditSlug - Optional audit slug; if omitted, includes all audits
+ * @param auditWeight - Optional weight for the ref(s)
+ * @returns Array of category refs, expanded for each URL in multi-URL configs
+ */
+export declare function axeAuditRefs(plugin: Pick<PluginConfig, 'audits' | 'context'>, auditSlug?: string, auditWeight?: number): CategoryRef[];

package/src/lib/utils.js

@@ -1,4 +1,10 @@
+import { validate, } from '@code-pushup/models';
+import { expandCategoryRefs, extractGroupSlugs, pluginUrlContextSchema, } from '@code-pushup/utils';
 import { AXE_PLUGIN_SLUG } from './constants.js';
+import { isAxeGroupSlug } from './groups.js';
+/**
+ * @deprecated Use `axeGroupRefs` instead for multi-URL support.
+ */
 export function axeGroupRef(groupSlug, weight = 1) {
     return {
         plugin: AXE_PLUGIN_SLUG,
@@ -7,6 +13,9 @@ export function axeGroupRef(groupSlug, weight = 1) {
         weight,
     };
 }
+/**
+ * @deprecated Use `axeAuditRefs` instead for multi-URL support.
+ */
 export function axeAuditRef(auditSlug, weight = 1) {
     return {
         plugin: AXE_PLUGIN_SLUG,
@@ -15,4 +24,50 @@ export function axeAuditRef(auditSlug, weight = 1) {
         weight,
     };
 }
+/**
+ * Creates category refs for Axe groups with multi-URL support.
+ *
+ * @param plugin - Axe plugin instance
+ * @param groupSlug - Optional group slug; if omitted, includes all groups
+ * @param groupWeight - Optional weight for the ref(s)
+ * @returns Array of category refs, expanded for each URL in multi-URL configs
+ */
+export function axeGroupRefs(plugin, groupSlug, groupWeight) {
+    const context = validate(pluginUrlContextSchema, plugin.context);
+    if (groupSlug) {
+        return expandCategoryRefs({
+            slug: groupSlug,
+            weight: groupWeight,
+            type: 'group',
+            plugin: AXE_PLUGIN_SLUG,
+        }, context);
+    }
+    return axeGroupSlugs(plugin).flatMap(slug => expandCategoryRefs({ slug, type: 'group', plugin: AXE_PLUGIN_SLUG }, context));
+}
+/**
+ * Creates category refs for Axe audits with multi-URL support.
+ *
+ * @param plugin - Axe plugin instance
+ * @param auditSlug - Optional audit slug; if omitted, includes all audits
+ * @param auditWeight - Optional weight for the ref(s)
+ * @returns Array of category refs, expanded for each URL in multi-URL configs
+ */
+export function axeAuditRefs(plugin, auditSlug, auditWeight) {
+    const context = validate(pluginUrlContextSchema, plugin.context);
+    if (auditSlug) {
+        return expandCategoryRefs({
+            slug: auditSlug,
+            weight: auditWeight,
+            type: 'audit',
+            plugin: AXE_PLUGIN_SLUG,
+        }, context);
+    }
+    return plugin.audits.flatMap(({ slug }) => expandCategoryRefs({ slug, type: 'audit', plugin: AXE_PLUGIN_SLUG }, context));
+}
+function axeGroupSlugs(plugin) {
+    if (!plugin.groups) {
+        return [];
+    }
+    return extractGroupSlugs(plugin.groups).filter(isAxeGroupSlug);
+}
 //# sourceMappingURL=utils.js.map

package/src/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGjD,MAAM,UAAU,WAAW,CAAC,SAAuB,EAAE,MAAM,GAAG,CAAC;IAC7D,OAAO;QACL,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,OAAO;QACb,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,SAAiB,EAAE,MAAM,GAAG,CAAC;IACvD,OAAO;QACL,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,OAAO;QACb,MAAM;KACP,CAAC;AACJ,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,GACT,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,GACvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAqB,cAAc,EAAE,MAAM,aAAa,CAAC;AAEhE;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,SAAuB,EAAE,MAAM,GAAG,CAAC;IAC7D,OAAO;QACL,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,OAAO;QACb,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,SAAiB,EAAE,MAAM,GAAG,CAAC;IACvD,OAAO;QACL,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,OAAO;QACb,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAgD,EAChD,SAAwB,EACxB,WAAoB;IAEpB,MAAM,OAAO,GAAG,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACjE,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,kBAAkB,CACvB;YACE,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,WAAW;YACnB,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,eAAe;SACxB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IACD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAC1C,kBAAkB,CAChB,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,EAChD,OAAO,CACR,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAgD,EAChD,SAAkB,EAClB,WAAoB;IAEpB,MAAM,OAAO,GAAG,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACjE,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,kBAAkB,CACvB;YACE,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,WAAW;YACnB,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,eAAe;SACxB,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CACxC,kBAAkB,CAChB,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,EAChD,OAAO,CACR,CACF,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,MAAoC;IACzD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,OAAO,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;AACjE,CAAC"}