@nitpicker/report-html 0.21.0 → 0.22.0

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 D-ZERO Co., Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/lib/collect-html-report-pages.d.ts

@@ -1,12 +1,23 @@
 import type { ArchiveAccessor } from '@nitpicker/crawler';
 import type { HtmlReportPage } from '@nitpicker/viewer/report-ui';
+/** Row-set restriction for {@link collectHtmlReportPages}. */
+export interface CollectHtmlReportPagesOptions {
+    /** Directory-prefix filters. Empty or omitted lists every inner page. */
+    readonly directories?: readonly string[];
+    /**
+     * Exact-match URL allowlist, already normalized (see
+     * `resolvePageListUrlFilter`). ANDed with `directories` when both are
+     * given — see `PageListRowFilterOptions.urls`'s docs.
+     */
+    readonly urls?: readonly string[];
+}
 /**
  * Collects inner-page rows for a static HTML report in `natural_url_rank`
  * order, attaching redirect sources and per-page resource-file tallies.
  * @param accessor - Archive whose viewer read model is already current.
- * @param directories - Directory-prefix filters. Empty or omitted lists every inner page.
+ * @param options - Row-set restriction. Empty or omitted lists every inner page.
  * @returns Page rows ready for `renderHtmlReport`.
  * @example
- * const pages = await collectHtmlReportPages(accessor, ['/docs']);
+ * const pages = await collectHtmlReportPages(accessor, { directories: ['/docs'] });
  */
-export declare function collectHtmlReportPages(accessor: ArchiveAccessor, directories?: readonly string[]): Promise<HtmlReportPage[]>;
+export declare function collectHtmlReportPages(accessor: ArchiveAccessor, options?: CollectHtmlReportPagesOptions): Promise<HtmlReportPage[]>;

package/lib/collect-html-report-pages.js

@@ -3,15 +3,15 @@ import { buildRedirectFromUrlsByDestId, getResourceFileCountsByPageIds, streamPa
  * Collects inner-page rows for a static HTML report in `natural_url_rank`
  * order, attaching redirect sources and per-page resource-file tallies.
  * @param accessor - Archive whose viewer read model is already current.
- * @param directories - Directory-prefix filters. Empty or omitted lists every inner page.
+ * @param options - Row-set restriction. Empty or omitted lists every inner page.
  * @returns Page rows ready for `renderHtmlReport`.
  * @example
- * const pages = await collectHtmlReportPages(accessor, ['/docs']);
+ * const pages = await collectHtmlReportPages(accessor, { directories: ['/docs'] });
  */
-export async function collectHtmlReportPages(accessor, directories = []) {
+export async function collectHtmlReportPages(accessor, options = {}) {
     const redirectFrom = await buildRedirectFromUrlsByDestId(accessor);
     const pages = [];
-    for await (const chunk of streamPageListRows(accessor, { directories })) {
+    for await (const chunk of streamPageListRows(accessor, options)) {
         const counts = await getResourceFileCountsByPageIds(accessor, chunk.map((row) => row.pageId));
         for (const row of chunk) {
             const resources = counts.get(row.pageId) ?? { total: 0, exists: 0 };
@@ -24,6 +24,7 @@ export async function collectHtmlReportPages(accessor, directories = []) {
                 resourceFilesExists: resources.exists,
                 resourceFilesTotal: resources.total,
                 consoleErrorCount: row.consoleErrorCount,
+                redirectTo: row.redirectDestUrl,
             });
         }
     }

package/lib/page-report-limit.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The static HTML report's inner-page ceiling, shared by both page-selection
+ * paths (`resolveDirectoryPrefixes`'s interactive `--html-dirs` narrowing and
+ * `resolvePageSelection`'s non-interactive `--urls` guard) so the two can
+ * never drift to different limits.
+ */
+export declare const PAGE_REPORT_LIMIT = 10000;

package/lib/page-report-limit.js

@@ -0,0 +1,7 @@
+/**
+ * The static HTML report's inner-page ceiling, shared by both page-selection
+ * paths (`resolveDirectoryPrefixes`'s interactive `--html-dirs` narrowing and
+ * `resolvePageSelection`'s non-interactive `--urls` guard) so the two can
+ * never drift to different limits.
+ */
+export const PAGE_REPORT_LIMIT = 10_000;

package/lib/report.js

@@ -1,11 +1,11 @@
 import { writeFile } from 'node:fs/promises';
 import { TaskList } from '@d-zero/dealer';
-import { getViewerSummary, requireViewerReadModel } from '@nitpicker/query';
+import { getViewerSummary, requireViewerReadModel, resolveAndValidatePageListUrlFilter, warnUnmatchedPageListUrls, } from '@nitpicker/query';
 import { renderHtmlReport } from '@nitpicker/viewer/report-ui';
 import { collectHtmlReportPages } from './collect-html-report-pages.js';
 import { openReportArchive } from './open-report-archive.js';
-import { resolveDirectoryPrefixes } from './resolve-directory-prefixes.js';
 import { resolveOutputPath } from './resolve-output-path.js';
+import { resolvePageSelection } from './resolve-page-selection.js';
 /** A `write()`-only sink that renders nothing, for `params.silent`. */
 const NULL_STREAM = {
     write: () => true,
@@ -33,24 +33,32 @@ const NULL_STREAM = {
 export async function report(params) {
     await using archive = await openReportArchive(params.filePath, params.onExtractProgress);
     await requireViewerReadModel(archive.accessor);
-    const prefixes = await resolveDirectoryPrefixes({
+    const warn = params.silent
+        ? () => { }
+        : (message) => {
+            // eslint-disable-next-line no-console
+            console.warn(message);
+        };
+    const normalizedUrls = params.urls === undefined
+        ? undefined
+        : await resolveAndValidatePageListUrlFilter(archive.accessor, params.urls, warn);
+    const selection = await resolvePageSelection({
         accessor: archive.accessor,
-        initialInput: params.directoryInput,
+        directoryInput: params.directoryInput,
+        urls: normalizedUrls,
         interactive: params.interactive === true,
-        onWarn: params.silent
-            ? () => { }
-            : (message) => {
-                // eslint-disable-next-line no-console
-                console.warn(message);
-            },
+        onWarn: warn,
     });
-    const directoryPrefixes = prefixes.map((prefix) => prefix.display);
+    const directoryPrefixes = selection.directories;
     const outputPath = resolveOutputPath(params.filePath, params.outputPath);
     let html = '';
     let pipeline = TaskList.from(0);
     pipeline = pipeline.pipe('Collect pages', async (input, ctx) => {
         ctx.progress('reading inner pages...');
-        const pages = await collectHtmlReportPages(archive.accessor, directoryPrefixes);
+        const pages = await collectHtmlReportPages(archive.accessor, {
+            directories: directoryPrefixes,
+            urls: selection.urls,
+        });
         const summary = await getViewerSummary(archive.accessor);
         ctx.progress(`${pages.length.toLocaleString()} pages`);
         html = renderHtmlReport({
@@ -60,6 +68,9 @@ export async function report(params) {
             generatedAt: new Date().toISOString(),
             directoryPrefixes,
         });
+        if (selection.urls) {
+            await warnUnmatchedPageListUrls(archive.accessor, selection.urls, warn);
+        }
         return input;
     });
     pipeline = pipeline.pipe('Write HTML', async (input, ctx) => {

package/lib/resolve-directory-prefixes.js

@@ -1,8 +1,8 @@
 import { countPageListHostnames, countPageListRows } from '@nitpicker/query';
 import enquirer from 'enquirer';
 import { HtmlReportCancelledError } from './html-report-cancelled-error.js';
+import { PAGE_REPORT_LIMIT } from './page-report-limit.js';
 import { parseDirectoryInput } from './parse-directory-input.js';
-const PAGE_LIMIT = 10_000;
 /**
  * Asks for comma-separated directory prefixes on a TTY.
  * @returns The raw input string.
@@ -40,7 +40,7 @@ export async function resolveDirectoryPrefixes(options) {
     const unfilteredTotal = await countPageListRows(options.accessor);
     const hostnameCount = await countPageListHostnames(options.accessor);
     let input = options.initialInput;
-    if (unfilteredTotal <= PAGE_LIMIT && input == null) {
+    if (unfilteredTotal <= PAGE_REPORT_LIMIT && input == null) {
         return [];
     }
     for (;;) {
@@ -68,7 +68,7 @@ export async function resolveDirectoryPrefixes(options) {
             const selectedTotal = await countPageListRows(options.accessor, {
                 directories: prefixes.map((prefix) => prefix.display),
             });
-            if (selectedTotal > PAGE_LIMIT) {
+            if (selectedTotal > PAGE_REPORT_LIMIT) {
                 throw new Error(`The selected directories contain ${selectedTotal.toLocaleString()} inner pages; narrow them to 10,000 or fewer.`);
             }
             return prefixes;

package/lib/resolve-page-selection.d.ts

@@ -0,0 +1,40 @@
+import type { ArchiveAccessor } from '@nitpicker/crawler';
+/** Row-set restriction {@link resolvePageSelection} resolves to. */
+export interface PageSelection {
+    /** Directory-prefix filters, display form, ready for `collectHtmlReportPages`. */
+    readonly directories: string[];
+    /** Normalized URL allowlist, or `undefined` when `--urls` was not given. */
+    readonly urls: readonly string[] | undefined;
+}
+interface ResolvePageSelectionOptions {
+    readonly accessor: ArchiveAccessor;
+    readonly directoryInput?: string;
+    /** Already-normalized URLs (via `resolvePageListUrlFilter`), or `undefined` when `--urls` was not given. */
+    readonly urls?: readonly string[];
+    readonly interactive: boolean;
+    readonly onWarn: (message: string) => void;
+}
+/**
+ * Decides the report's page restriction: the `--urls` path (this function's
+ * own AND-combination with `--html-dirs`, no interactive prompting, no
+ * 10,000-page-limit *enforcement via prompting* since a URL list is expected
+ * to already be well under it) or the pre-existing `--html-dirs`-only path
+ * (delegated to {@link resolveDirectoryPrefixes} unchanged, including its
+ * interactive prompt loop).
+ *
+ * `--urls` skips `resolveDirectoryPrefixes`'s prompt-forcing flow entirely
+ * because that flow's whole purpose — interactively narrowing an
+ * unboundedly large report down to size — doesn't apply once the caller has
+ * already named the exact pages it wants. The 10,000-page ceiling itself
+ * still applies (checked after combining `--urls` with any `--html-dirs`
+ * narrowing), so a directory prefix that happens to still leave the
+ * URL-restricted set too large is still rejected.
+ * @param options - Archive, optional non-interactive directory input,
+ *   optional normalized URL allowlist, interactivity, and warning sink.
+ * @returns The resolved directory prefixes and URL allowlist to pass to
+ *   `collectHtmlReportPages`.
+ * @throws {Error} If the `--urls` path's combined row count exceeds the
+ *   10,000-page ceiling.
+ */
+export declare function resolvePageSelection(options: ResolvePageSelectionOptions): Promise<PageSelection>;
+export {};

package/lib/resolve-page-selection.js

@@ -0,0 +1,51 @@
+import { countPageListRows } from '@nitpicker/query';
+import { PAGE_REPORT_LIMIT } from './page-report-limit.js';
+import { parseDirectoryInput } from './parse-directory-input.js';
+import { resolveDirectoryPrefixes } from './resolve-directory-prefixes.js';
+/**
+ * Decides the report's page restriction: the `--urls` path (this function's
+ * own AND-combination with `--html-dirs`, no interactive prompting, no
+ * 10,000-page-limit *enforcement via prompting* since a URL list is expected
+ * to already be well under it) or the pre-existing `--html-dirs`-only path
+ * (delegated to {@link resolveDirectoryPrefixes} unchanged, including its
+ * interactive prompt loop).
+ *
+ * `--urls` skips `resolveDirectoryPrefixes`'s prompt-forcing flow entirely
+ * because that flow's whole purpose — interactively narrowing an
+ * unboundedly large report down to size — doesn't apply once the caller has
+ * already named the exact pages it wants. The 10,000-page ceiling itself
+ * still applies (checked after combining `--urls` with any `--html-dirs`
+ * narrowing), so a directory prefix that happens to still leave the
+ * URL-restricted set too large is still rejected.
+ * @param options - Archive, optional non-interactive directory input,
+ *   optional normalized URL allowlist, interactivity, and warning sink.
+ * @returns The resolved directory prefixes and URL allowlist to pass to
+ *   `collectHtmlReportPages`.
+ * @throws {Error} If the `--urls` path's combined row count exceeds the
+ *   10,000-page ceiling.
+ */
+export async function resolvePageSelection(options) {
+    if (options.urls === undefined) {
+        const prefixes = await resolveDirectoryPrefixes({
+            accessor: options.accessor,
+            initialInput: options.directoryInput,
+            interactive: options.interactive,
+            onWarn: options.onWarn,
+        });
+        return { directories: prefixes.map((prefix) => prefix.display), urls: undefined };
+    }
+    const directoryPrefixes = options.directoryInput
+        ? parseDirectoryInput(options.directoryInput)
+        : [];
+    const directories = directoryPrefixes.map((prefix) => prefix.display);
+    const total = await countPageListRows(options.accessor, {
+        urls: options.urls,
+        directories,
+    });
+    if (total > PAGE_REPORT_LIMIT) {
+        throw new Error(`--urls matched ${total.toLocaleString()} inner page(s)` +
+            (directories.length > 0 ? ' after --html-dirs narrowing' : '') +
+            `; exceeds the ${PAGE_REPORT_LIMIT.toLocaleString()}-page report limit. Narrow --urls or --html-dirs further.`);
+    }
+    return { directories, urls: options.urls };
+}

package/lib/types.d.ts

@@ -6,6 +6,16 @@ export interface HtmlReportParams {
     readonly outputPath?: string;
     /** Comma-separated directory prefixes used for non-interactive large reports. */
     readonly directoryInput?: string;
+    /**
+     * URL allowlist restricting the report to exactly these pages, already
+     * classified into valid/invalid by the CLI (`readUrlListFile` +
+     * `isValidUrl`) but not yet normalized to the archive's own URL form —
+     * `report()` does that via `resolveAndValidatePageListUrlFilter` once the
+     * archive is open. ANDed with `directoryInput` when both are given. Skips the
+     * interactive/10,000-page-limit-prompting flow `directoryInput` alone
+     * triggers — see `resolvePageSelection`.
+     */
+    readonly urls?: readonly string[];
     /** Whether the reporter may prompt for directory prefixes. */
     readonly interactive?: boolean;
     /** Suppresses completion and warning output. */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nitpicker/report-html",
-	"version": "0.21.0",
+	"version": "0.22.0",
 	"description": "Self-contained static HTML reports for Nitpicker archives",
 	"author": "D-ZERO",
 	"license": "Apache-2.0",
@@ -30,10 +30,10 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/dealer": "1.13.1",
-		"@nitpicker/crawler": "0.21.0",
-		"@nitpicker/query": "0.21.0",
-		"@nitpicker/viewer": "0.21.0",
+		"@d-zero/dealer": "1.14.0",
+		"@nitpicker/crawler": "0.22.0",
+		"@nitpicker/query": "0.22.0",
+		"@nitpicker/viewer": "0.22.0",
 		"enquirer": "2.4.1",
 		"react": "19.2.8",
 		"react-dom": "19.2.8"
@@ -41,5 +41,6 @@
 	"devDependencies": {
 		"@d-zero/shared": "0.23.0",
 		"vitest": "4.1.11"
-	}
+	},
+	"gitHead": "934b1714f4394effb3865d84bf8348ed74f45840"
 }