ax-audit 5.0.0 → 6.0.0
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.
- package/CHANGELOG.md +10 -0
- package/README.md +33 -24
- package/dist/baseline.js +1 -1
- package/dist/baseline.js.map +1 -1
- package/dist/check-ids.js +1 -1
- package/dist/check-ids.js.map +1 -1
- package/dist/cli.js +1 -1
- package/dist/cli.js.map +1 -1
- package/dist/constants.d.ts +1 -85
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +0 -135
- package/dist/constants.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/license.d.ts +3 -2
- package/dist/license.d.ts.map +1 -1
- package/dist/license.js +5 -58
- package/dist/license.js.map +1 -1
- package/dist/metadata.d.ts +6 -0
- package/dist/metadata.d.ts.map +1 -0
- package/dist/metadata.js +205 -0
- package/dist/metadata.js.map +1 -0
- package/dist/orchestrator.d.ts +1 -0
- package/dist/orchestrator.d.ts.map +1 -1
- package/dist/orchestrator.js +134 -63
- package/dist/orchestrator.js.map +1 -1
- package/dist/scorer.js +2 -2
- package/dist/scorer.js.map +1 -1
- package/dist/types.d.ts +2 -0
- package/dist/types.d.ts.map +1 -1
- package/docs/api.md +12 -4
- package/docs/architecture.md +9 -98
- package/docs/ci.md +7 -3
- package/docs/cli.md +7 -3
- package/docs/faq.md +18 -0
- package/docs/getting-started.md +32 -26
- package/package.json +5 -5
- package/dist/checks/agent-access.d.ts +0 -33
- package/dist/checks/agent-access.d.ts.map +0 -1
- package/dist/checks/agent-access.js +0 -256
- package/dist/checks/agent-access.js.map +0 -1
- package/dist/checks/agent-card.d.ts +0 -37
- package/dist/checks/agent-card.d.ts.map +0 -1
- package/dist/checks/agent-card.js +0 -352
- package/dist/checks/agent-card.js.map +0 -1
- package/dist/checks/agent-operability.d.ts +0 -66
- package/dist/checks/agent-operability.d.ts.map +0 -1
- package/dist/checks/agent-operability.js +0 -383
- package/dist/checks/agent-operability.js.map +0 -1
- package/dist/checks/agent-skills.d.ts +0 -24
- package/dist/checks/agent-skills.d.ts.map +0 -1
- package/dist/checks/agent-skills.js +0 -316
- package/dist/checks/agent-skills.js.map +0 -1
- package/dist/checks/ai-catalog.d.ts +0 -28
- package/dist/checks/ai-catalog.d.ts.map +0 -1
- package/dist/checks/ai-catalog.js +0 -254
- package/dist/checks/ai-catalog.js.map +0 -1
- package/dist/checks/ai-directives.d.ts +0 -57
- package/dist/checks/ai-directives.d.ts.map +0 -1
- package/dist/checks/ai-directives.js +0 -263
- package/dist/checks/ai-directives.js.map +0 -1
- package/dist/checks/api-discovery.d.ts +0 -26
- package/dist/checks/api-discovery.d.ts.map +0 -1
- package/dist/checks/api-discovery.js +0 -432
- package/dist/checks/api-discovery.js.map +0 -1
- package/dist/checks/auth-discovery.d.ts +0 -28
- package/dist/checks/auth-discovery.d.ts.map +0 -1
- package/dist/checks/auth-discovery.js +0 -302
- package/dist/checks/auth-discovery.js.map +0 -1
- package/dist/checks/commerce-discovery.d.ts +0 -40
- package/dist/checks/commerce-discovery.d.ts.map +0 -1
- package/dist/checks/commerce-discovery.js +0 -295
- package/dist/checks/commerce-discovery.js.map +0 -1
- package/dist/checks/content-negotiation.d.ts +0 -4
- package/dist/checks/content-negotiation.d.ts.map +0 -1
- package/dist/checks/content-negotiation.js +0 -253
- package/dist/checks/content-negotiation.js.map +0 -1
- package/dist/checks/crawl-efficiency.d.ts +0 -16
- package/dist/checks/crawl-efficiency.d.ts.map +0 -1
- package/dist/checks/crawl-efficiency.js +0 -186
- package/dist/checks/crawl-efficiency.js.map +0 -1
- package/dist/checks/frontmatter.d.ts +0 -34
- package/dist/checks/frontmatter.d.ts.map +0 -1
- package/dist/checks/frontmatter.js +0 -100
- package/dist/checks/frontmatter.js.map +0 -1
- package/dist/checks/html-rendering.d.ts +0 -21
- package/dist/checks/html-rendering.d.ts.map +0 -1
- package/dist/checks/html-rendering.js +0 -221
- package/dist/checks/html-rendering.js.map +0 -1
- package/dist/checks/html-utils.d.ts +0 -66
- package/dist/checks/html-utils.d.ts.map +0 -1
- package/dist/checks/html-utils.js +0 -139
- package/dist/checks/html-utils.js.map +0 -1
- package/dist/checks/http-headers.d.ts +0 -11
- package/dist/checks/http-headers.d.ts.map +0 -1
- package/dist/checks/http-headers.js +0 -249
- package/dist/checks/http-headers.js.map +0 -1
- package/dist/checks/http-hygiene.d.ts +0 -26
- package/dist/checks/http-hygiene.d.ts.map +0 -1
- package/dist/checks/http-hygiene.js +0 -257
- package/dist/checks/http-hygiene.js.map +0 -1
- package/dist/checks/index.d.ts +0 -3
- package/dist/checks/index.d.ts.map +0 -1
- package/dist/checks/index.js +0 -55
- package/dist/checks/index.js.map +0 -1
- package/dist/checks/llms-txt.d.ts +0 -19
- package/dist/checks/llms-txt.d.ts.map +0 -1
- package/dist/checks/llms-txt.js +0 -281
- package/dist/checks/llms-txt.js.map +0 -1
- package/dist/checks/mcp-discovery.d.ts +0 -30
- package/dist/checks/mcp-discovery.d.ts.map +0 -1
- package/dist/checks/mcp-discovery.js +0 -523
- package/dist/checks/mcp-discovery.js.map +0 -1
- package/dist/checks/meta-tags.d.ts +0 -17
- package/dist/checks/meta-tags.d.ts.map +0 -1
- package/dist/checks/meta-tags.js +0 -188
- package/dist/checks/meta-tags.js.map +0 -1
- package/dist/checks/robots-parser.d.ts +0 -110
- package/dist/checks/robots-parser.d.ts.map +0 -1
- package/dist/checks/robots-parser.js +0 -277
- package/dist/checks/robots-parser.js.map +0 -1
- package/dist/checks/robots-txt.d.ts +0 -6
- package/dist/checks/robots-txt.d.ts.map +0 -1
- package/dist/checks/robots-txt.js +0 -367
- package/dist/checks/robots-txt.js.map +0 -1
- package/dist/checks/rsl.d.ts +0 -4
- package/dist/checks/rsl.d.ts.map +0 -1
- package/dist/checks/rsl.js +0 -242
- package/dist/checks/rsl.js.map +0 -1
- package/dist/checks/security-txt.d.ts +0 -4
- package/dist/checks/security-txt.d.ts.map +0 -1
- package/dist/checks/security-txt.js +0 -81
- package/dist/checks/security-txt.js.map +0 -1
- package/dist/checks/seo-basics.d.ts +0 -13
- package/dist/checks/seo-basics.d.ts.map +0 -1
- package/dist/checks/seo-basics.js +0 -221
- package/dist/checks/seo-basics.js.map +0 -1
- package/dist/checks/sitemap.d.ts +0 -12
- package/dist/checks/sitemap.d.ts.map +0 -1
- package/dist/checks/sitemap.js +0 -240
- package/dist/checks/sitemap.js.map +0 -1
- package/dist/checks/structured-data.d.ts +0 -4
- package/dist/checks/structured-data.d.ts.map +0 -1
- package/dist/checks/structured-data.js +0 -408
- package/dist/checks/structured-data.js.map +0 -1
- package/dist/checks/structured-fields.d.ts +0 -46
- package/dist/checks/structured-fields.d.ts.map +0 -1
- package/dist/checks/structured-fields.js +0 -112
- package/dist/checks/structured-fields.js.map +0 -1
- package/dist/checks/surface.d.ts +0 -59
- package/dist/checks/surface.d.ts.map +0 -1
- package/dist/checks/surface.js +0 -106
- package/dist/checks/surface.js.map +0 -1
- package/dist/checks/tls-https.d.ts +0 -13
- package/dist/checks/tls-https.d.ts.map +0 -1
- package/dist/checks/tls-https.js +0 -163
- package/dist/checks/tls-https.js.map +0 -1
- package/dist/checks/usage-policy.d.ts +0 -53
- package/dist/checks/usage-policy.d.ts.map +0 -1
- package/dist/checks/usage-policy.js +0 -339
- package/dist/checks/usage-policy.js.map +0 -1
- package/dist/checks/utils.d.ts +0 -40
- package/dist/checks/utils.d.ts.map +0 -1
- package/dist/checks/utils.js +0 -74
- package/dist/checks/utils.js.map +0 -1
- package/dist/checks/waf.d.ts +0 -75
- package/dist/checks/waf.d.ts.map +0 -1
- package/dist/checks/waf.js +0 -203
- package/dist/checks/waf.js.map +0 -1
- package/dist/checks/webmcp.d.ts +0 -55
- package/dist/checks/webmcp.d.ts.map +0 -1
- package/dist/checks/webmcp.js +0 -209
- package/dist/checks/webmcp.js.map +0 -1
- package/dist/checks/well-known.d.ts +0 -38
- package/dist/checks/well-known.d.ts.map +0 -1
- package/dist/checks/well-known.js +0 -202
- package/dist/checks/well-known.js.map +0 -1
- package/dist/fetcher.d.ts +0 -15
- package/dist/fetcher.d.ts.map +0 -1
- package/dist/fetcher.js +0 -127
- package/dist/fetcher.js.map +0 -1
- package/dist/guide-urls.d.ts +0 -2
- package/dist/guide-urls.d.ts.map +0 -1
- package/dist/guide-urls.js +0 -5
- package/dist/guide-urls.js.map +0 -1
- package/dist/licensed-checks.d.ts +0 -4
- package/dist/licensed-checks.d.ts.map +0 -1
- package/dist/licensed-checks.js +0 -11
- package/dist/licensed-checks.js.map +0 -1
- package/docs/roadmap.md +0 -367
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAErD,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;AAExF,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iGAAiG;IACjG,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,iDAAiD;AACjD,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAChC;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;CAC1E;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8FAA8F;IAC9F,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC;IAC7D,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,KAAK,CAAC;KACd,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;AAIrE;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B,8EAA8E;IAC9E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,6BAA6B;AAC7B,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,iEAAiE;AACjE,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,WAAW,EAAE,SAAS,EAAE,CAAC;IACzB,YAAY,EAAE,SAAS,EAAE,CAAC;CAC3B"}
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAErD,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,aAAa,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,CAAC;AAExF,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iGAAiG;IACjG,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,iDAAiD;AACjD,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAChC;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,aAAa,CAAC,CAAC;IACvE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;CAC1E;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,CAAC,GAAG,EAAE,YAAY,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;IACjD,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,0FAA0F;IAC1F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;IACzE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8FAA8F;IAC9F,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAa,SAAQ,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC;IAC7D,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,KAAK,CAAC;KACd,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;AAIrE;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B,8EAA8E;IAC9E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,6BAA6B;AAC7B,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,iEAAiE;AACjE,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,WAAW,EAAE,SAAS,EAAE,CAAC;IACzB,YAAY,EAAE,SAAS,EAAE,CAAC;CAC3B"}
|
package/docs/api.md
CHANGED
|
@@ -11,7 +11,10 @@ The package is ESM-only (`"type": "module"`), targets Node 18+ (built-in `fetch`
|
|
|
11
11
|
|
|
12
12
|
## `audit(options): Promise<AuditReport>`
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Executes selected checks on the private AX Rush service and returns its report.
|
|
15
|
+
The URL and options are sent to AX Rush; no audit runs on the client. An active
|
|
16
|
+
paid subscription and an organization key from https://axrush.com/account/api
|
|
17
|
+
are required for every call. `apiKey` defaults to `AXRUSH_API_KEY`.
|
|
15
18
|
|
|
16
19
|
```typescript
|
|
17
20
|
function audit(options: AuditOptions): Promise<AuditReport>;
|
|
@@ -41,7 +44,10 @@ report.results; // CheckResult[]
|
|
|
41
44
|
report.duration; // ms
|
|
42
45
|
```
|
|
43
46
|
|
|
44
|
-
`audit`
|
|
47
|
+
`audit` rejects with `LicenseError`: `MISSING_KEY`, `INVALID_KEY`, `PLAN_REQUIRED`,
|
|
48
|
+
`INVALID_INPUT`, `RATE_LIMITED`, or `VALIDATION_UNAVAILABLE`. Network failures,
|
|
49
|
+
malformed service responses and access refusals never trigger a local fallback.
|
|
50
|
+
Only public HTTP(S) targets are supported; the service blocks private addresses.
|
|
45
51
|
|
|
46
52
|
## `batchAudit(urls, options?): Promise<BatchAuditReport>`
|
|
47
53
|
|
|
@@ -53,7 +59,7 @@ interface BatchOptions extends Omit<AuditOptions, 'url'> {
|
|
|
53
59
|
}
|
|
54
60
|
```
|
|
55
61
|
|
|
56
|
-
A batch
|
|
62
|
+
A batch accepts 1–100 URLs and concurrency 1–4 (default 1). Each URL is a separate authenticated service request and consumes the shared rate limit. Report order matches input order. Invalid options reject before any request.
|
|
57
63
|
|
|
58
64
|
```typescript
|
|
59
65
|
const batch = await batchAudit(urls, { concurrency: 4, retries: 2 });
|
|
@@ -70,6 +76,7 @@ batch.summary.grade; // Grade for the average
|
|
|
70
76
|
```typescript
|
|
71
77
|
interface AuditReport {
|
|
72
78
|
url: string;
|
|
79
|
+
engine?: string; // private server engine provenance
|
|
73
80
|
timestamp: string; // ISO 8601
|
|
74
81
|
overallScore: number; // 0–100
|
|
75
82
|
grade: Grade;
|
|
@@ -122,6 +129,7 @@ function diffBaseline(baseline: BaselineData, report: AuditReport): BaselineDiff
|
|
|
122
129
|
|
|
123
130
|
interface BaselineData {
|
|
124
131
|
url: string;
|
|
132
|
+
engine?: string; // private server engine provenance
|
|
125
133
|
timestamp: string;
|
|
126
134
|
overallScore: number;
|
|
127
135
|
checks: Record<string, number>; // checkId → score
|
|
@@ -256,4 +264,4 @@ Within a major version, the exported function signatures and the `AuditReport` J
|
|
|
256
264
|
|
|
257
265
|
`AuditOptions`, `BatchOptions`, `AuditReport`, `BatchAuditReport`, `CheckResult`, `CheckMeta`, `CheckContext`, `CheckModule`, `Finding`, `FindingStatus`, `FetchOptions`, `FetchResponse`, `Grade`, `OutputFormat`, `BaselineData`, `BaselineDiff`, `CheckDiff`.
|
|
258
266
|
|
|
259
|
-
`checks` exposes metadata
|
|
267
|
+
`checks` exposes metadata only, with no `run` function. Execute checks through `audit({ url, checks: [id], apiKey })`, which calls AX Rush. Keep keys out of browser bundles.
|
package/docs/architecture.md
CHANGED
|
@@ -1,104 +1,15 @@
|
|
|
1
1
|
# Architecture
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Version 6 separates the public client from the private audit service.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
- `src/orchestrator.ts` sends authenticated requests to the fixed AX Rush audit endpoint. It contains no checks, HTML parsers, target fetcher or offline fallback.
|
|
6
|
+
- `src/license.ts` reads the account key and defines actionable client errors. Local validation is only for usability; the server owns authorization.
|
|
7
|
+
- `src/metadata.ts` holds check descriptions and aliases, without executable `run` functions.
|
|
8
|
+
- `src/reporter/`, `src/baseline.ts` and `src/scorer.ts` format, compare and summarize existing results locally.
|
|
9
|
+
- The private AX Rush application owns check implementations, safe outbound HTTP, server-side API-key and billing checks, and shared abuse limits. Authorization runs for every audit.
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
cli.ts ──► orchestrator.ts ──► checks/* (Promise.allSettled, parallel)
|
|
9
|
-
│ │
|
|
10
|
-
▼ ▼
|
|
11
|
-
fetcher.ts scorer.ts ──► reporter/{terminal,json,html,markdown}
|
|
12
|
-
(cache + retries) │
|
|
13
|
-
▲ baseline.ts (save / load / diff)
|
|
14
|
-
└── shared by every check via CheckContext.fetch
|
|
15
|
-
```
|
|
11
|
+
Only URL, check selection, profile, request timeout and retry count are sent in the request body. The account key travels in the Authorization header only. There is no endpoint override or bypass flag. Private network targets are not supported.
|
|
16
12
|
|
|
17
|
-
|
|
18
|
-
2. **orchestrator.ts** (`audit`) creates one fetcher per run, fetches the homepage once, builds the `CheckContext` (`url`, `html`, `headers`, `fetch`), and runs all selected checks in parallel. A check that throws is converted into a score-0 result with the error as a finding — one bad check never kills the audit. `batchAudit` runs `audit` per URL through an order-preserving work queue with configurable `concurrency`.
|
|
19
|
-
3. **fetcher.ts** wraps `fetch` with: per-run in-memory caching keyed on URL + normalized (lowercased, sorted) custom headers — mirroring HTTP `Vary` semantics so a `text/markdown` probe never collides with the HTML fetch; case-insensitive header merging over defaults; timeouts via `AbortController`; and retries with exponential backoff for transient failures (status 0, 408, 425, 429, 5xx). Errors never throw — they become `{ status: 0, ok: false, error }` results, also cached.
|
|
20
|
-
4. **checks/** — one module per check (26). Each exports `default` (async check function) and `meta` (`{ id, name, description, weight, category?, aliases? }`).
|
|
21
|
-
5. **scorer.ts** computes the weighted average over the checks that ran *and apply*; a check reporting `applicable: false` is excluded from both numerator and denominator. When every applicable check has weight 0 it falls back to a plain average.
|
|
22
|
-
6. **reporter/** renders to terminal (chalk), JSON, self-contained HTML, or Markdown, grouping checks by category and showing n/a where a check does not apply.
|
|
23
|
-
7. **baseline.ts** persists minimal score snapshots and computes per-check diffs for regression gating.
|
|
13
|
+
`npm test` checks the public API, report rendering, baselines and the remote transport, including denied access and unavailable service. Engine check tests live with the private server. `npm run prepublishOnly` builds from a clean `dist` and verifies the package allowlist so check implementations cannot accidentally ship.
|
|
24
14
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
```typescript
|
|
28
|
-
import { guideUrl } from '../guide-urls.js';
|
|
29
|
-
import type { CheckContext, CheckResult, CheckMeta, Finding } from '../types.js';
|
|
30
|
-
import { buildResult } from './utils.js';
|
|
31
|
-
|
|
32
|
-
export const meta: CheckMeta = {
|
|
33
|
-
id: 'my-check',
|
|
34
|
-
name: 'My Check',
|
|
35
|
-
description: 'One-line description shown in reports',
|
|
36
|
-
category: 'discovery',
|
|
37
|
-
// No `weight` here: weights live in CHECK_WEIGHTS, and only there.
|
|
38
|
-
};
|
|
39
|
-
|
|
40
|
-
export default async function check(ctx: CheckContext): Promise<CheckResult> {
|
|
41
|
-
const start = performance.now();
|
|
42
|
-
const findings: Finding[] = [];
|
|
43
|
-
let score = 100;
|
|
44
|
-
|
|
45
|
-
const res = await ctx.fetch(`${ctx.url}/something`, { headers: { Accept: 'application/json' } });
|
|
46
|
-
if (!res.ok) {
|
|
47
|
-
findings.push({
|
|
48
|
-
status: 'fail',
|
|
49
|
-
message: '/something not found',
|
|
50
|
-
hint: 'Actionable, copy-pasteable advice.',
|
|
51
|
-
learnMoreUrl: guideUrl(meta.id, 'not-found'),
|
|
52
|
-
});
|
|
53
|
-
return buildResult(meta, 0, findings, start);
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
// ... validations, each pushing a pass/warn/fail Finding and adjusting score
|
|
57
|
-
|
|
58
|
-
return buildResult(meta, score, findings, start);
|
|
59
|
-
}
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
Conventions:
|
|
63
|
-
|
|
64
|
-
- **Findings are actionable.** Every `warn`/`fail` carries a `hint` with concrete remediation and a `learnMoreUrl` pointing to `axrush.com/guides/<check-id>#<anchor>`. Every anchor must have a section in that guide.
|
|
65
|
-
- **Scores are clamped** to [0, 100] by `buildResult`.
|
|
66
|
-
- **Shared HTML primitives** live in `checks/html-utils.ts` (`getMetaContent`, `findLinkTags`, `getAttribute`, `extractVisibleText`, …) — no per-check regex duplication.
|
|
67
|
-
- **robots.txt is parsed once**, by `checks/robots-parser.ts`. It returns User-agent groups with their rules plus `Content-Signal`, `Content-Usage`, `License`, `Sitemap` and `Agentmap` directives. `robots-txt`, `rsl` and `agent-access` all consume it, so the grouping rules have one definition.
|
|
68
|
-
- **Responses are classified**, not just status-checked. `checks/waf.ts` turns a response into ok / challenge / paywall / needs-signature / license-required / rate-limited / blocked, with the evidence that produced it and an `inconclusive` flag for what an unsigned probe cannot settle.
|
|
69
|
-
- **Probed paths carry their standing.** `checks/well-known.ts` records every path as IANA-registered, vendor convention, draft or legacy, so a missing draft file is never reported like a missing registered one.
|
|
70
|
-
- **An HTML body means absent, not broken.** `isHtmlDocument` in `checks/utils.ts` gates speculative probes: an SPA catch-all returns its index shell for every unknown path, and reporting that as a malformed document sends operators hunting for a bug in a file they never wrote.
|
|
71
|
-
- **A check that does not apply reports N/A**, via `notApplicable()`, rather than scoring 0. Commerce discovery on a blog, OAuth metadata where nothing needs authorizing, WebMCP on a page with no forms: scoring these zero would say something false about the site. Everything counted against a site must be something the site could have done.
|
|
72
|
-
- **Check ids are a public interface** — they appear in `--checks` flags and in saved baselines. A rename declares the old id in `meta.aliases`; `src/check-ids.ts` resolves aliases for selection and for baseline diffing.
|
|
73
|
-
- **Content-Type validation** uses `checkContentType` from `checks/utils.ts` (−5 convention for mismatches).
|
|
74
|
-
- **Network goes through `ctx.fetch`** — never raw `fetch` — so caching, retries, timeouts, and `--verbose` logging apply uniformly.
|
|
75
|
-
|
|
76
|
-
## Adding a new check
|
|
77
|
-
|
|
78
|
-
1. Create `src/checks/your-check.ts` exporting `default` + `meta` (weight 0 — see scoring policy below).
|
|
79
|
-
2. Register it in `src/checks/index.ts`.
|
|
80
|
-
3. Add its weight to `CHECK_WEIGHTS` in `src/constants.ts`.
|
|
81
|
-
4. Add a test suite in `test/checks/your-check.test.js` using `mockContext` / `mockResponse` from `test/helpers.js`. Route values can be functions `(url, fetchOptions) => response` when the response must vary by request headers.
|
|
82
|
-
5. Document it in `docs/checks.md` and the README table.
|
|
83
|
-
6. Write the remediation guide covering every `learnMoreUrl` anchor you emit.
|
|
84
|
-
|
|
85
|
-
## Scoring policy
|
|
86
|
-
|
|
87
|
-
Score deltas on the same site are treated as **breaking**. Within a major version:
|
|
88
|
-
|
|
89
|
-
- New checks ship with **weight 0**: full findings, no effect on the overall score or baselines.
|
|
90
|
-
- New findings inside weighted checks must be informational, with no deduction.
|
|
91
|
-
- Weight redistribution happens in a major version, and the baseline schema version is bumped with it so an existing baseline is not read as a regression.
|
|
92
|
-
|
|
93
|
-
Weights live in `CHECK_WEIGHTS` in `src/constants.ts`, and only there. Checks used to declare their own `meta.weight` alongside the map; the two drifted, and a redistribution silently did nothing. `CheckMeta.weight` remains as an override that nothing uses, and a test asserts no check declares one.
|
|
94
|
-
|
|
95
|
-
Two check states exist beyond a score:
|
|
96
|
-
|
|
97
|
-
- **Weight 0** means the check runs and reports but rests on something too unsettled to score: a draft specification that may be renamed.
|
|
98
|
-
- **Not applicable** means the question does not arise for this site. It leaves the denominator entirely. `--profile` overrides the detection.
|
|
99
|
-
|
|
100
|
-
## Testing
|
|
101
|
-
|
|
102
|
-
`npm test` builds (`tsc`) and runs `node --test`. The suite (964 tests) covers every check, the scorer, baseline logic, the Markdown reporter, plus integration tests that spin up real local HTTP servers for the fetcher (per-header caching, retries, HEAD and manual redirects) and the batch orchestrator (ordering, concurrency caps). No test dependencies beyond Node.
|
|
103
|
-
|
|
104
|
-
Two classes of test exist specifically to keep the 3.x promise that no score goes down: **score-stability tests** assert that a configuration which scored 100 in 3.6 still scores 100, and that findings added inside a weighted check leave the score untouched. When those fail, the change belongs in the next major, not the current minor.
|
|
15
|
+
The server must be deployed and verified before publishing a client version that relies on it.
|
package/docs/ci.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# CI Integration
|
|
2
2
|
|
|
3
|
-
For ax-audit
|
|
3
|
+
For ax-audit 6, create a paid organization API key at
|
|
4
4
|
https://axrush.com/account/api, save it as the `AXRUSH_API_KEY` repository secret,
|
|
5
5
|
and expose it only to trusted audit jobs:
|
|
6
6
|
|
|
@@ -11,8 +11,8 @@ env:
|
|
|
11
11
|
|
|
12
12
|
Fork pull requests do not receive secrets. Skip licensed audits for those runs;
|
|
13
13
|
never use `pull_request_target` to execute untrusted checkout code with this key.
|
|
14
|
-
The job needs outbound HTTPS to axrush.com
|
|
15
|
-
|
|
14
|
+
The job needs outbound HTTPS to axrush.com; authorization and audit execution
|
|
15
|
+
both happen on AX Rush. License errors fail the command instead of publishing a score.
|
|
16
16
|
|
|
17
17
|
|
|
18
18
|
ax-audit's exit codes (see [cli.md](./cli.md)) make it a drop-in quality gate: `0` for Good/Excellent, `1` for Fair/Poor or regressions.
|
|
@@ -102,3 +102,7 @@ jobs:
|
|
|
102
102
|
```
|
|
103
103
|
|
|
104
104
|
`--fail-on-regression 0` makes any per-check drop fail the workflow — appropriate for scheduled runs where every change is unexpected.
|
|
105
|
+
|
|
106
|
+
## Remote execution in v6
|
|
107
|
+
|
|
108
|
+
Audit a public preview or deployed URL. Localhost and private CI network hosts are not reachable by AX Rush. The target URL and options are sent to AX Rush; no engine is downloaded. Each URL requires an active paid subscription and consumes the service rate limit.
|
package/docs/cli.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# CLI Reference
|
|
2
2
|
|
|
3
|
-
Version
|
|
3
|
+
Version 6 requires `AXRUSH_API_KEY`, generated at https://axrush.com/account/api
|
|
4
4
|
by an owner/admin of an active paid organization. Set it through your environment
|
|
5
5
|
or CI secret store. It is never a command-line flag, target header or report field.
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
The server rejects missing/revoked keys and inactive subscriptions before
|
|
7
|
+
contacting the target. Service failures never trigger a local audit. `--help` and `--version` work without a key.
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
```bash
|
|
@@ -108,3 +108,7 @@ Each area is reported against its threshold on stderr, so the output survives `-
|
|
|
108
108
|
## Baselines across a scoring change
|
|
109
109
|
|
|
110
110
|
Baselines record which scoring model produced them. Comparing a baseline written by an older version shows the deltas but suspends regression gating, because a rescore is not something the site did. Re-save with `--save-baseline` to resume gating. Checks that changed applicability are excluded from regressions and improvements for the same reason.
|
|
111
|
+
|
|
112
|
+
## Version 6 service boundary
|
|
113
|
+
|
|
114
|
+
The CLI sends the URL and options to AX Rush and renders the returned report. The engine is private to the server. Set `AXRUSH_API_KEY` using a key from an active paid account. Public HTTP(S) URLs only, ports 80/443, no URL credentials. `--timeout` is 100–10000 ms per server request, `--retries` is 0–2, and `--concurrency` is 1–4. Verbose output is client-side only; server network traces are not returned. Rate limits and API errors exit with code 2.
|
package/docs/faq.md
CHANGED
|
@@ -1,3 +1,21 @@
|
|
|
1
|
+
# Version 6: remote service
|
|
2
|
+
|
|
3
|
+
## Can I use the engine without a subscription?
|
|
4
|
+
|
|
5
|
+
No. The npm package contains only a client. AX Rush authorizes each audit against an active paid subscription. Modifying the client cannot expose engine code that it does not contain.
|
|
6
|
+
|
|
7
|
+
## Can I audit localhost or run offline?
|
|
8
|
+
|
|
9
|
+
No. Audit a public preview or deployed site. AX Rush must be able to reach it.
|
|
10
|
+
|
|
11
|
+
## What data leaves my machine?
|
|
12
|
+
|
|
13
|
+
The target URL and selected audit options are sent to AX Rush. AX Rush fetches the pages and returns a report. The API key is sent only to AX Rush, never to the target site.
|
|
14
|
+
|
|
15
|
+
## What about versions 1–5?
|
|
16
|
+
|
|
17
|
+
They were distributed with local engine code. This release cannot disable downloaded copies or revoke previously granted license rights. They are legacy releases, not the current AX Rush service.
|
|
18
|
+
|
|
1
19
|
# FAQ & Troubleshooting
|
|
2
20
|
|
|
3
21
|
## Scores & results
|
package/docs/getting-started.md
CHANGED
|
@@ -1,32 +1,38 @@
|
|
|
1
1
|
# Getting Started
|
|
2
2
|
|
|
3
|
-
## AX Rush
|
|
3
|
+
## AX Rush service access (v6)
|
|
4
|
+
|
|
5
|
+
Install with `npm install ax-audit`. Version 6 is a CLI and SDK for the private
|
|
6
|
+
AX Rush service: **the npm package contains no audit engine or check implementations**.
|
|
7
|
+
|
|
8
|
+
1. Subscribe at [AX Rush](https://axrush.com/pricing).
|
|
9
|
+
2. Generate an organization key in [Account → API keys](https://axrush.com/account/api).
|
|
10
|
+
3. Store it as `AXRUSH_API_KEY` in your environment or trusted CI secret store.
|
|
11
|
+
4. Run `npx ax-audit@6 https://example.com`.
|
|
12
|
+
|
|
13
|
+
`audit({ url, apiKey })` can pass a key explicitly. Never commit keys or put them
|
|
14
|
+
in command-line arguments. The service checks the key and an active paid
|
|
15
|
+
subscription for **each audit**; revoked keys, canceled subscriptions, past-due
|
|
16
|
+
payments, trial-only and complimentary-only accounts cannot execute the engine.
|
|
17
|
+
|
|
18
|
+
The client sends the target URL and audit options to
|
|
19
|
+
`https://axrush.com/api/v1/engine/audit`, with the key in the Authorization header.
|
|
20
|
+
AX Rush fetches the public pages and returns the report. The key is never sent
|
|
21
|
+
to the target website. This endpoint does not save the report to your dashboard;
|
|
22
|
+
use the authenticated site API for stored scan history.
|
|
23
|
+
|
|
24
|
+
Only publicly reachable HTTP(S) sites on ports 80/443 are supported. Localhost,
|
|
25
|
+
private networks, URL credentials and custom ports are rejected. CI should audit
|
|
26
|
+
a public preview or deployed environment. Internet access to AX Rush is required;
|
|
27
|
+
there is no offline mode or local fallback. Current abuse limits are 10 audits
|
|
28
|
+
per organization per hour and 5 per target per hour, shared across keys and scan
|
|
29
|
+
surfaces. A batch consumes one audit for each URL.
|
|
30
|
+
|
|
31
|
+
Rendering an existing report, reading check descriptions and comparing saved
|
|
32
|
+
baselines remain local. `checks` contains metadata only; `checks[i].run()` was
|
|
33
|
+
removed. The CLI and client utilities remain Apache-2.0. Earlier releases and
|
|
34
|
+
rights already granted under their licenses cannot be revoked by this release.
|
|
4
35
|
|
|
5
|
-
Install the package normally with `npm install ax-audit`. To execute an audit,
|
|
6
|
-
you need an active paid AX Rush plan and an organization key created in
|
|
7
|
-
[Account → API keys](https://axrush.com/account/api). Set `AXRUSH_API_KEY` in
|
|
8
|
-
your local environment or your CI secret store. Do not commit it to source
|
|
9
|
-
control or put it in browser code.
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
# AXRUSH_API_KEY is supplied securely by your environment or CI secrets
|
|
13
|
-
npx ax-audit@5 https://example.com
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
The engine validates the key with AX Rush before each audit or batch, then runs
|
|
17
|
-
locally. Only the key is sent to AX Rush: target URLs, page content and reports
|
|
18
|
-
stay in your execution environment. Validation needs internet access and fails
|
|
19
|
-
closed if unavailable. Revocation or an inactive subscription blocks the next
|
|
20
|
-
execution; authorization is not cached between runs. Public check metadata,
|
|
21
|
-
scoring utilities and rendering existing reports need no key. Calling an
|
|
22
|
-
individual exported check requires `AXRUSH_API_KEY` too.
|
|
23
|
-
|
|
24
|
-
This is an execution requirement for the official v5 package, not tamper-proof
|
|
25
|
-
DRM. Earlier published releases remain usable, and local JavaScript can be
|
|
26
|
-
modified. The existing source license and notices are unchanged.
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
This walkthrough takes you from zero to a passing AX score: run your first audit, learn to read the report, and fix findings in the order that moves your score most.
|
|
30
36
|
|
|
31
37
|
## 1. Run your first audit
|
|
32
38
|
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ax-audit",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "6.0.0",
|
|
4
|
+
"description": "CLI and SDK for the private AX Rush audit service. Requires an active paid subscription and API key.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "Apache-2.0",
|
|
7
7
|
"author": "Durani Technologies (https://axrush.com)",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
|
-
"url": "https://github.com/duranitech/ax-audit.git"
|
|
10
|
+
"url": "git+https://github.com/duranitech/ax-audit.git"
|
|
11
11
|
},
|
|
12
12
|
"homepage": "https://axrush.com",
|
|
13
13
|
"bugs": {
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"typescript"
|
|
37
37
|
],
|
|
38
38
|
"bin": {
|
|
39
|
-
"ax-audit": "
|
|
39
|
+
"ax-audit": "bin/ax-audit.js"
|
|
40
40
|
},
|
|
41
41
|
"exports": {
|
|
42
42
|
".": {
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"format": "prettier --write \"src/**/*.ts\"",
|
|
67
67
|
"format:check": "prettier --check \"src/**/*.ts\"",
|
|
68
68
|
"prepare": "husky",
|
|
69
|
-
"prepublishOnly": "npm run build"
|
|
69
|
+
"prepublishOnly": "npm run build && node scripts/verify-package.mjs"
|
|
70
70
|
},
|
|
71
71
|
"lint-staged": {
|
|
72
72
|
"src/**/*.ts": [
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
import type { CheckContext, CheckResult, CheckMeta } from '../types.js';
|
|
2
|
-
/**
|
|
3
|
-
* "agent-access" — the gap between what robots.txt permits and what the server
|
|
4
|
-
* actually does.
|
|
5
|
-
*
|
|
6
|
-
* The failure this catches is invisible from the inside: robots.txt says
|
|
7
|
-
* `Allow: /` for GPTBot, and the WAF returns 403 to anything whose user agent
|
|
8
|
-
* says GPTBot. The operator sees a permissive robots.txt and assumes the site
|
|
9
|
-
* is reachable. Cloudflare's "Block AI Crawlers" toggle produces exactly this,
|
|
10
|
-
* and so does a hand-written rule that outlived its reason.
|
|
11
|
-
*
|
|
12
|
-
* The check probes the homepage once per core crawler and compares the result
|
|
13
|
-
* against the default-user-agent baseline. Since 3.7 it classifies *how* a
|
|
14
|
-
* request was turned away, because the remedies are completely different: a
|
|
15
|
-
* JavaScript challenge needs a bot-management exception, a hard 403 needs a
|
|
16
|
-
* firewall rule change, a 402 is a deliberate price, and a signature demand is
|
|
17
|
-
* the site working as designed.
|
|
18
|
-
*
|
|
19
|
-
* Honesty constraint: this probe is unsigned and comes from the auditor's own
|
|
20
|
-
* network. An edge that verifies crawlers by IP range or Web Bot Auth signature
|
|
21
|
-
* will reject it while admitting the genuine crawler. Those outcomes are scored
|
|
22
|
-
* as inconclusive and labelled as such, never as "blocks AI crawlers".
|
|
23
|
-
*/
|
|
24
|
-
export declare const meta: CheckMeta;
|
|
25
|
-
/**
|
|
26
|
-
* Build a realistic crawler User-Agent for a given bot token. WAF and
|
|
27
|
-
* bot-management rules match on the token substring, which is what we need
|
|
28
|
-
* to trigger the same code path the real crawler would hit.
|
|
29
|
-
*/
|
|
30
|
-
export declare function crawlerUserAgent(token: string): string;
|
|
31
|
-
export { intentBlocked } from './robots-parser.js';
|
|
32
|
-
export default function check(ctx: CheckContext): Promise<CheckResult>;
|
|
33
|
-
//# sourceMappingURL=agent-access.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"agent-access.d.ts","sourceRoot":"","sources":["../../src/checks/agent-access.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,SAAS,EAAW,MAAM,aAAa,CAAC;AAMjF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,IAAI,EAAE,SAKlB,CAAC;AA+BF;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AAGD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAoCnD,wBAA8B,KAAK,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CA8E3E"}
|