@webx-ui/module-audit 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 webx-ui
+
+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,26 @@
+# @webx-ui/module-audit
+
+The «Audit» section of the [WebX UI](https://github.com/webx-ui/webx-ui) admin panel: the
+overview of the last run — health, counts by severity and group, what is new and what got fixed —
+its findings, one row per check, each opening into its addresses — and the pages the last full
+run crawled, with any field of the snapshot as a column, a filter on any field, a CSV export and
+a card per page with its answer, its problems, its links in and out, the pictures, CSS and JS it
+loads with what each answered, and its structured data with what the types lack.
+
+The server half is the Composer package `webx-ui/module-audit`; the section appears in the
+navigation when both are installed.
+
+```ts
+import { createAdmin } from '@webx-ui/module-admin'
+import { audit } from '@webx-ui/module-audit'
+import '@webx-ui/module-audit/style.css'
+
+createAdmin({ modules: [audit()] })
+```
+
+Options: `path` (default `/audit`) and `settingsPath` (default `/settings` — the audit's settings
+live on the «Audit» tab there).
+
+## License
+
+MIT

package/dist/AuditCompareIssues.d.ts

@@ -0,0 +1,12 @@
+import { AuditComparisonRow } from './types';
+/**
+ * One check of a comparison opened: its new, fixed or persisting findings, fifty at a time —
+ * fixed ones as the earlier run stored them, the others from the later run.
+ */
+type __VLS_Props = {
+    from: number;
+    to: number;
+    row: AuditComparisonRow;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditDetails.d.ts

@@ -0,0 +1,11 @@
+import { AuditDetails } from './types';
+/**
+ * The expansion of a finding, for every check alike (§4 of the spec): a summary line and, when
+ * the check gave one, a table whose cells are drawn by their type — an address opens, a code is
+ * coloured, a missing value is said in red, an editor link goes to the record in the panel.
+ */
+type __VLS_Props = {
+    details: AuditDetails;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditFixDialog.d.ts

@@ -0,0 +1,22 @@
+import { AuditIssue } from './types';
+/**
+ * The fix button's dialog (§8, decision 4): the fixes that can close one finding, each with what
+ * it would change — the records and fields with their counts, or a setting before and after —
+ * and "Apply" under each. Nothing changes until it is pressed; the finding then waits for the
+ * next run, which is the only thing that says it is gone.
+ */
+type __VLS_Props = {
+    run: number;
+    issue: AuditIssue;
+};
+type __VLS_PublicProps = {
+    'open'?: boolean;
+} & __VLS_Props;
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    fixed: (fix: string) => any;
+    "update:open": (value: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    onFixed?: ((fix: string) => any) | undefined;
+    "onUpdate:open"?: ((value: boolean) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/AuditHideDialog.d.ts

@@ -0,0 +1,21 @@
+import { AuditIgnoreRule, AuditIssue } from './types';
+/**
+ * «Hide» on a finding (decision 9): which addresses — this one, a mask of them, or the whole
+ * check — and why. While the mask is typed the dialog says how many findings of the last run it
+ * would hide; nothing is hidden until the button is pressed, and nothing is ever deleted.
+ */
+type __VLS_Props = {
+    issue: AuditIssue;
+    title: string;
+};
+type __VLS_PublicProps = {
+    'open'?: boolean;
+} & __VLS_Props;
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    hidden: (rule: AuditIgnoreRule) => any;
+    "update:open": (value: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    onHidden?: ((rule: AuditIgnoreRule) => any) | undefined;
+    "onUpdate:open"?: ((value: boolean) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/AuditHostPlaces.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Where one host stands, under its row on «Outgoing»: the pages that link to it with the anchor
+ * and what it answered, and the fields of the database that hold it, with «Open in the editor».
+ * Fifty of each — enough to see the pattern, and the findings list the rest.
+ */
+type __VLS_Props = {
+    host: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditHostsPage.d.ts

@@ -0,0 +1,11 @@
+/**
+ * «Outgoing» (§8): every host the site points at — in the pages of the last full run and in the
+ * fields of the database — by class, development stands on top and in red. A row opens into
+ * where the host stands: the pages with their anchors, the records with the field and the way to
+ * the editor.
+ */
+type __VLS_Props = {
+    base: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditIssueList.d.ts

@@ -0,0 +1,20 @@
+import { AuditIssueQuery } from './types';
+/**
+ * The addresses of one check, under its row in the findings table: loaded when the row opens,
+ * fifty at a time. A check that has fixes gets a button on each address; the dialog shows what
+ * it would change before anything does. «Hide» asks for the reason; on the list of hidden ones
+ * each says why, and «Show again» removes the rule.
+ */
+type __VLS_Props = {
+    run: number;
+    query: AuditIssueQuery;
+    fixable?: boolean;
+    /** The check's title, for the hiding dialog. */
+    title?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    changed: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onChanged?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditIssuesPage.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The findings of the last finished run (§8): one row per check, worst first; a row opens into
+ * its addresses. «Hidden» in the state filter lists what the rules hide, each with its reason. The «?» beside a check says what was found, why it matters and how to fix it —
+ * the three texts every check carries.
+ */
+type __VLS_Props = {
+    base: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditLayout.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The head of the section: its name, its views — the overview, the findings, the pages, the
+ * hosts the site points at and the runs — and the way to the section's own settings.
+ */
+type __VLS_Props = {
+    base: string;
+    current: 'overview' | 'issues' | 'pages' | 'hosts' | 'runs' | 'settings';
+    /** A card around the slot — the tables want one, the overview draws its own. */
+    card?: boolean;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Readonly<{
+        default?: () => unknown;
+    }> & {
+        default?: () => unknown;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    card: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/AuditOverviewPage.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The last run at a glance (§8): health, the counts by severity and by group, what is new and
+ * what got fixed since the run before, and the button that starts the next one. While a run is
+ * going the page asks for it every couple of seconds and shows the stage it is in.
+ */
+type __VLS_Props = {
+    base: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditPageCard.d.ts

@@ -0,0 +1,24 @@
+/**
+ * One page of the snapshot, sliding in from the right (§8): what it answered and what its head
+ * says, its findings, the links that lead in and out of it — with the answer of each own page
+ * and the class of each host — what it loads (pictures, CSS, JS) with what each answered, and
+ * its structured data with what the types lack.
+ *
+ * «Recheck» asks this one address again (a run of the `urls` scope) and says what of its findings
+ * in the last full run are fixed; «Export» downloads the page — snapshot, findings and links.
+ */
+type __VLS_Props = {
+    run: number;
+    /** Where the section lives — the recheck's comparison opens on its runs. */
+    base?: string;
+    /** The page to show; null keeps the card closed. */
+    pageId: number | null;
+    /** Check ids and their titles in the reader's language, for the findings tab. */
+    titles: Record<string, string>;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    close: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onClose?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/AuditPagesPage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Every address the last full run crawled (§8, «Pages»): any field of the snapshot as a column,
+ * a filter on any of them, the list as CSV, and a row that opens the page's card.
+ */
+type __VLS_Props = {
+    base: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditRunsPage.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The history (§8 «Runs»): every run kept, newest first, with its health and counts. Ticking a
+ * run compares it with the one it was analysed against; ticking two compares those two — by
+ * fingerprint (decision 8): what is new in the later one, what both have, what is gone. `?to=`
+ * opens on one run already ticked — the way the page card's recheck leads here.
+ */
+type __VLS_Props = {
+    base: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/AuditSettingsPage.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The section's settings (§8): where the site is and which hosts are its stands, the limits of
+ * the crawl and the paths it leaves out, the thresholds, the nightly run and how much history
+ * to keep. The form is the screen the server describes (`audit.settings`), so a project patches
+ * a field in the way it does everywhere else; saving is this page's own.
+ */
+type __VLS_Props = {
+    base: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/api.d.ts

@@ -0,0 +1,85 @@
+import { AdminContext } from '@webx-ui/module-admin';
+import { AuditCheckRow, AuditComparison, AuditComparisonKind, AuditFixOffer, AuditFixResult, AuditHosts, AuditHostClass, AuditIgnoreRule, AuditIssue, AuditIssueQuery, AuditLatest, AuditLinkRow, AuditPage, AuditPageCard, AuditPageQuery, AuditPageRow, AuditResourceRow, AuditResourceTab, AuditRun, AuditScope } from './types';
+export interface AuditApi {
+    /** The run that is going, the last one that finished, and whether the queue can take one. */
+    latest(): Promise<AuditLatest>;
+    run(id: number): Promise<AuditRun>;
+    /** Every run, newest first — the history. */
+    runs(query?: {
+        page?: number;
+        per_page?: number;
+    }): Promise<AuditPage<AuditRun>>;
+    /**
+     * Queues a run; refused with 409 on a `sync` queue or while another one is going. A `urls` run
+     * is a recheck of the addresses given.
+     */
+    start(scope: AuditScope, urls?: string[]): Promise<AuditRun>;
+    cancel(id: number): Promise<AuditRun>;
+    /** The checks of a run that found something, worst first. */
+    checks(run: number, query?: AuditIssueQuery): Promise<AuditCheckRow[]>;
+    /** The findings of a run — of one check when `check` is given. */
+    issues(run: number, query?: AuditIssueQuery): Promise<AuditPage<AuditIssue>>;
+    /** The crawled pages of a run under the screen's filters. */
+    pages(run: number, query?: AuditPageQuery): Promise<AuditPage<AuditPageRow>>;
+    /** Where the browser downloads the same list as CSV, under the panel's session. */
+    pagesFile(run: number, query: AuditPageQuery, columns: string[]): string;
+    page(run: number, id: number): Promise<AuditPageCard>;
+    /** The links of a page: `out` — what it points at, `in` — what points at it. */
+    links(run: number, id: number, query?: {
+        direction?: 'in' | 'out';
+        kind?: string;
+        page?: number;
+        per_page?: number;
+    }): Promise<AuditPage<AuditLinkRow>>;
+    /** What a page loads, a tab of the card at a time. */
+    resources(run: number, id: number, query: {
+        tab: AuditResourceTab;
+        page?: number;
+        per_page?: number;
+    }): Promise<AuditPage<AuditResourceRow>>;
+    /** The fixes that can close a finding now, each with what it would change. */
+    fixes(run: number, issue: number): Promise<AuditFixOffer[]>;
+    /** Presses a fix — or, with `dryRun`, only asks again what it would change. */
+    fix(run: number, issue: number, fix: string, dryRun?: boolean): Promise<AuditFixResult>;
+    /** Where the browser downloads one page of a run — its snapshot, findings and links. */
+    pageFile(run: number, id: number): string;
+    /** Two runs by fingerprint; without `from`, `to` against the run it was analysed against. */
+    compare(to: number, from?: number | null): Promise<AuditComparison>;
+    /** The findings of one kind of a comparison, of one check when given. */
+    compareIssues(query: {
+        to: number;
+        from?: number | null;
+        kind: AuditComparisonKind;
+        check?: string;
+        page?: number;
+        per_page?: number;
+    }): Promise<AuditPage<AuditIssue>>;
+    /** Every host the site points at, by class — stands first; with `host`, where it stands. */
+    hosts(query?: {
+        class?: AuditHostClass | null;
+        search?: string;
+        host?: string;
+    }): Promise<AuditHosts>;
+    /** The hiding rules. */
+    ignores(): Promise<AuditIgnoreRule[]>;
+    /** Hides what a rule matches, with the reason. */
+    hide(rule: {
+        check: string;
+        pattern: string;
+        reason: string;
+    }): Promise<AuditIgnoreRule>;
+    /** How many findings of the last run a rule would hide — nothing is hidden. */
+    hidePreview(rule: {
+        check: string;
+        pattern: string;
+    }): Promise<number>;
+    /** Removes a rule: its findings count again. */
+    unhide(id: number): Promise<void>;
+    /** The section's settings, keyed as the screen names them. */
+    settings(): Promise<Record<string, unknown>>;
+    saveSettings(values: Record<string, unknown>): Promise<Record<string, unknown>>;
+}
+/** The query of the pages screen as the API reads it: `f[field]=op:value` for each filter. */
+export declare function pageParams(query: AuditPageQuery): Record<string, string | number | undefined>;
+/** Everything under `/audit`, below the panel's API path. */
+export declare function createAuditApi(admin: AdminContext): AuditApi;

package/dist/fields.d.ts

@@ -0,0 +1,15 @@
+import { AuditFieldType, AuditFilterOp, AuditPageField } from './types';
+/**
+ * The fields of the snapshot, as `PageColumns` lists them on the server: what the pages screen
+ * can show, filter on, sort by and export. Kept in the same order, so the column picker reads
+ * like the page's card — address and answer first, markup, then speed and links.
+ */
+export declare const PAGE_FIELDS: Record<AuditPageField, AuditFieldType>;
+export declare const DEFAULT_COLUMNS: AuditPageField[];
+/** `h1` is read out of a JSON list: shown and exported, not filtered or sorted on. */
+export declare const COMPUTED_FIELDS: AuditPageField[];
+/** What can be asked of a field of each type. */
+export declare const OPERATIONS: Record<AuditFieldType, AuditFilterOp[]>;
+/** The operations that need a value typed beside them. */
+export declare const WITH_VALUE: AuditFilterOp[];
+export declare const SOURCES: readonly ["home", "sitemap", "registry", "link"];

package/dist/i18n.d.ts

@@ -0,0 +1,2 @@
+/** Puts this package's English under the panel's dictionary, once per panel. */
+export declare function useAuditMessages(): void;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export { audit, type AuditOptions } from './module';
+export { createAuditApi, pageParams, type AuditApi } from './api';
+export { auditMessages } from './messages';
+export { default as WxAuditOverviewPage } from './AuditOverviewPage';
+export { default as WxAuditIssuesPage } from './AuditIssuesPage';
+export { default as WxAuditDetails } from './AuditDetails';
+export { default as WxAuditPagesPage } from './AuditPagesPage';
+export { default as WxAuditPageCard } from './AuditPageCard';
+export { default as WxAuditHostsPage } from './AuditHostsPage';
+export { default as WxAuditRunsPage } from './AuditRunsPage';
+export { default as WxAuditSettingsPage } from './AuditSettingsPage';
+export { default as WxAuditHideDialog } from './AuditHideDialog';
+export { PAGE_FIELDS, DEFAULT_COLUMNS } from './fields';
+export type { AuditCellType, AuditCheckRow, AuditComparison, AuditComparisonKind, AuditComparisonRow, AuditCounts, AuditDetails, AuditDetailsColumn, AuditFieldFilter, AuditFieldType, AuditFilterOp, AuditFixChange, AuditFixOffer, AuditFixResult, AuditHostClass, AuditHostField, AuditHostPage, AuditHostRow, AuditHosts, AuditIgnoreRule, AuditIssue, AuditIssueQuery, AuditJsonLdBlock, AuditLatest, AuditLinkRow, AuditPage, AuditPageCard, AuditPageField, AuditPageQuery, AuditPageRow, AuditPageSource, AuditResourceRow, AuditResourceTab, AuditRun, AuditRunStatus, AuditScope, AuditSeverity, AuditStage, } from './types';