@webx-ui/module-audit 0.2.1 → 0.4.0

package/dist/AuditAddress.d.ts

@@ -0,0 +1,13 @@
+import { LinkType } from '@webx-ui/core';
+/**
+ * An address on one line, opened in a new tab: a long one loses its middle rather than wrapping,
+ * since the start names the site and the end tells two addresses apart. The whole of it is in the
+ * panel's tooltip.
+ */
+type __VLS_Props = {
+    href: string;
+    type?: LinkType;
+    strong?: boolean;
+};
+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, {}, any>;
+export default _default;

package/dist/AuditDetails.d.ts

@@ -4,9 +4,15 @@ import { AuditDetails } from './types';
  * 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, and
  * markup quoted from the page is shown as code.
+ *
+ * The columns have widths by their type, not by what they hold, so the tables of one check line
+ * up under each other. A `location` address beside a `url` is where that address leads: the row
+ * reads as from → to, and a difference of a slash, `www.` or `https` is named.
  */
 type __VLS_Props = {
     details: AuditDetails;
+    /** The count is shown elsewhere (the head of the finding) — the summary line would repeat it. */
+    counted?: boolean;
 };
 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/AuditHeadings.d.ts

@@ -0,0 +1,15 @@
+import { OutlineEntry } from './headings';
+/**
+ * The page's headings as a tree: each one indented by its level, in the order the page has them.
+ * The indent is the level itself, not the nesting the page managed — so a level the page jumped
+ * over is drawn where it should have been, as an empty dashed row, and the gap is seen rather
+ * than read about. Above the tree, what departs from the usual order, in plain words.
+ */
+type __VLS_Props = {
+    /** `[level, text]` in document order; null on a run crawled before the outline was kept. */
+    outline: OutlineEntry[] | null;
+    /** How many headings of each level — to tell «none» from «not kept». */
+    counts: Record<string, number>;
+};
+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/AuditHostPlaces.d.ts

@@ -1,7 +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, broken links first — enough to see the pattern, and the findings list the rest.
+ * Where one host stands, under its row on «Outgoing»: the addresses on it the pages point at, each
+ * a card with the pages under it — a font or a profile link sits in the layout and is on every
+ * page, so by page it would be the same line forty times — and the fields of the database that
+ * hold it, with «Open in the editor». A link's `target` and `rel` sit beside its address, or
+ * beside each page when the pages write it differently. Fifty of each, broken links first; a card counts all its
+ * pages and lists fifty.
  */
 type __VLS_Props = {
     host: string;

package/dist/AuditIssueList.d.ts

@@ -4,6 +4,9 @@ import { AuditIssueQuery } from './types';
  * 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.
+ *
+ * Each finding is a card: the address with its count, the table under it. A check of links that
+ * redirect can also be read by link — every page loaded, one card per link with its pages.
  */
 type __VLS_Props = {
     run: number;

package/dist/AuditLayout.d.ts

@@ -1,3 +1,4 @@
+import { ScreenAction } from '@webx-ui/module-admin';
 /**
  * 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.
@@ -7,6 +8,8 @@ type __VLS_Props = {
     current: 'overview' | 'issues' | 'pages' | 'hosts' | 'runs' | 'settings';
     /** A card around the slot — the tables want one, the overview draws its own. */
     card?: boolean;
+    /** What the view itself offers in the head, before the way to the settings. */
+    actions?: ScreenAction[];
 };
 declare function __VLS_template(): {
     attrs: Partial<{}>;
@@ -21,6 +24,7 @@ declare function __VLS_template(): {
 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;
+    actions: ScreenAction[];
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;

package/dist/AuditLinkAttrs.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A link's `target` and `rel`, as they are in the markup: `_blank`, `nofollow`, `noopener`… Nothing
+ * when the link has neither — a plain link is the usual case, not an empty cell. `_blank` without
+ * `noopener` or `noreferrer` is marked: current browsers add `noopener` themselves, older ones
+ * hand the opened page control of this one.
+ */
+type __VLS_Props = {
+    rel?: string | null;
+    target?: string | null;
+};
+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, {}, any>;
+export default _default;

package/dist/AuditLinkGroups.d.ts

@@ -0,0 +1,11 @@
+import { AuditIssue } from './types';
+/**
+ * The findings of a redirect check turned inside out: one card per link, the pages it is on
+ * under it. A link in the footer or the menu is on every page and is fixed once, in one place —
+ * by page, it would be the same row forty times.
+ */
+type __VLS_Props = {
+    issues: AuditIssue[];
+};
+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

@@ -2,7 +2,8 @@
  * 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.
+ * opens on one run already ticked — the way the page card's recheck leads here. In the head, for
+ * whoever manages the section, the way to clear every run at once, behind a warning.
  */
 type __VLS_Props = {
     base: string;

package/dist/AuditSettingsPage.d.ts

@@ -2,7 +2,8 @@
  * 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.
+ * a field in the way it does everywhere else; saving is this page's own. «Back» beside «Save» returns
+ * to the overview — the tabs above cannot, their «Overview» is already the lit one.
  */
 type __VLS_Props = {
     base: string;

package/dist/AuditStatus.d.ts

@@ -0,0 +1,14 @@
+import { BadgeSize } from '@webx-ui/core';
+/**
+ * An answer's code as a badge of its colour, and what it means in the tooltip: the name and what
+ * to do about it. A code with no line of its own is explained by its class (4xx…); none at all, or
+ * 0, is «no answer».
+ */
+type __VLS_Props = {
+    code: number | null | undefined;
+    size?: BadgeSize;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    size: BadgeSize;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/addresses.d.ts

@@ -0,0 +1,18 @@
+import { BadgeType } from '@webx-ui/core';
+/** What tells a redirect's target from its source when the rest of the address is the same. */
+export type AddressDifference = 'slash' | 'www' | 'https';
+/**
+ * The small differences between where a link points and where it lands: a trailing slash, `www.`,
+ * `http` → `https`. Empty when the addresses differ in anything else (the page really moved) or
+ * either is not an address — then there is nothing small to name.
+ */
+export declare function differences(from: string, to: string): AddressDifference[];
+/**
+ * An address cut in two for an ellipsis in the middle: the head gives way, the tail stays —
+ * the end of an address is what tells two of them apart.
+ */
+export declare function splitMiddle(text: string): [string, string];
+/** The colour of an answer's code. */
+export declare function statusType(value: unknown): BadgeType;
+/** The dictionary key of what an answer means: `code-404`, `code-5xx`, or `code-none`. */
+export declare function statusKey(code: number | null | undefined): string;

package/dist/api.d.ts

@@ -15,6 +15,8 @@ export interface AuditApi {
      */
     start(scope: AuditScope, urls?: string[]): Promise<AuditRun>;
     cancel(id: number): Promise<AuditRun>;
+    /** Deletes every run with all it found; refused with 409 while a run is going. */
+    clear(): Promise<number>;
     /** 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. */

package/dist/headings.d.ts

@@ -0,0 +1,20 @@
+/** One heading as the parser kept it: its level and its text. */
+export type OutlineEntry = [number, string];
+/** A row of the drawn tree — a heading, or a level the page jumped over (`missing`). */
+export interface OutlineRow {
+    level: number;
+    text: string;
+    missing: boolean;
+    /** For a missing level: the level the page jumped from. */
+    after?: number;
+}
+/**
+ * The tree to draw: every heading, and between two of them the levels skipped on the way down,
+ * so a gap stands where the heading should have been.
+ */
+export declare function outlineRows(outline: OutlineEntry[]): OutlineRow[];
+/**
+ * What breaks the usual order — one H1, first; each level one step below the one above; text in
+ * every heading — as sentences in the reader's language. Empty when the order is fine.
+ */
+export declare function outlineHints(outline: OutlineEntry[], t: (key: string, params?: Record<string, string | number>) => string): string[];