@reporters/web 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.3.0](https://github.com/MoLow/reporters/compare/web-v1.2.0...web-v1.3.0) (2026-07-02)
+
+
+### Features
+
+* pluggable viewer report sources and custom s3 viewer links ([#222](https://github.com/MoLow/reporters/issues/222)) ([e553e89](https://github.com/MoLow/reporters/commit/e553e89a6e0c9ba9323483ca52a3142c8e70f8ce))
+
 ## [1.2.0](https://github.com/MoLow/reporters/compare/web-v1.1.0...web-v1.2.0) (2026-07-02)
 
 

package/README.md

@@ -60,3 +60,29 @@ The NDJSON is rendered by the tree viewer, reached three ways:
 Built on the shared [`@reporters/tree-core`](https://github.com/MoLow/reporters/tree/main/packages/tree-core)
 model (also used by [`@reporters/live`](https://github.com/MoLow/reporters/tree/main/packages/live)) —
 the same run state, rendered in the browser instead of the terminal.
+
+## Custom report sources (`@reporters/web/viewer`)
+
+The hosted viewer reads `?src=<url>` with plain `fetch`. To serve reports that
+need authentication (private buckets, SSO), build your own viewer page on the
+same UI with a custom source resolver:
+
+```ts
+import { startViewer } from '@reporters/web/viewer';
+
+startViewer({
+  resolveSource: async (params) => {
+    if (params.get('src') || !params.get('key')) return null; // default handling
+    const credentials = await acquireCredentialsSomehow();
+    return { url: params.get('key')!, fetch: authenticatedFetch(credentials) };
+  },
+});
+```
+
+`resolveSource` runs before anything renders. Return `null`/`undefined` to fall
+through to the default `?src=` handling; return `{ url, fetch?, pollMs? }` to
+take over. The custom `fetch` receives the reader's `Range` header and must
+return a standard `Response`; a thrown error shows the viewer's load-error
+screen, and a promise that never resolves is fine while an auth redirect is in
+flight. The export is a self-contained browser ESM module (React inlined) —
+bundle it with your resolver into a static HTML page.

package/dist/start.d.ts

@@ -0,0 +1,24 @@
+type FetchLike = (url: string, init?: {
+    headers?: Record<string, string>;
+}) => Promise<Response>;
+
+interface ReportSource {
+    /** Passed to the NDJSON reader as the URL/identifier. */
+    url: string;
+    /** Transport for reads; defaults to the global fetch. Receives the reader's
+     *  Range header and must return a standard Response. */
+    fetch?: FetchLike;
+    /** Poll cadence override; else resolved from ?poll= as today. */
+    pollMs?: number;
+}
+interface ViewerOptions {
+    /** Called first with the page's query params. Return a source to use it;
+     *  return null/undefined to fall through to the default ?src= handling.
+     *  A never-resolving promise is legitimate (e.g. an auth redirect is in
+     *  flight). A thrown error shows the viewer's load-error screen. */
+    resolveSource?: (params: URLSearchParams) => Promise<ReportSource | null | undefined>;
+}
+
+declare function startViewer(options?: ViewerOptions): Promise<void>;
+
+export { type FetchLike, type ReportSource, type ViewerOptions, startViewer };