@reporters/mux 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+## [1.1.0](https://github.com/MoLow/reporters/compare/mux-v1.0.0...mux-v1.1.0) (2026-07-02)
+
+
+### Features
+
+* **mux:** start every sink before reporters consume events ([#221](https://github.com/MoLow/reporters/issues/221)) ([c5ef14f](https://github.com/MoLow/reporters/commit/c5ef14fbe0357a4f756fb170f69876396806abd6))
+
+
+### Bug Fixes
+
+* **web:** stay a pure emitter under mux via symbol-declared default options ([#217](https://github.com/MoLow/reporters/issues/217)) ([96a7d14](https://github.com/MoLow/reporters/commit/96a7d14e82f69c6dc6d8d363645f94c09733fbda))
+
+## 1.0.0 (2026-07-02)
+
+
+### Features
+
+* @reporters/mux environment-aware reporter routing + web NDJSON redesign ([#203](https://github.com/MoLow/reporters/issues/203)) ([82d1e20](https://github.com/MoLow/reporters/commit/82d1e205949e6daa90b13aec5838ddb0c7e931a5))
+* @reporters/sink — gist + s3 delivery sinks for viewing CI runs ([#211](https://github.com/MoLow/reporters/issues/211)) ([4b254b6](https://github.com/MoLow/reporters/commit/4b254b629236393b25c5903a976dbebfaf5ebc1a))
+
+
+### Documentation
+
+* flag-order fixes and the gh collapsible actions log ([#216](https://github.com/MoLow/reporters/issues/216)) ([131f410](https://github.com/MoLow/reporters/commit/131f4107712d6d0b899d3b8ca7a39496b6e05276))
+* rewrite package READMEs with demos and clearer positioning ([#209](https://github.com/MoLow/reporters/issues/209)) ([e1265e5](https://github.com/MoLow/reporters/commit/e1265e5f6b8a0f34b80ef7ee725cede4ed16b6da))
+
+
+### Miscellaneous Chores
+
+* route this repo's tests through @reporters/mux ([#207](https://github.com/MoLow/reporters/issues/207)) ([85a5973](https://github.com/MoLow/reporters/commit/85a59737bc3d631b0293edf343b77fd82e0c459d))

package/README.md

@@ -60,7 +60,12 @@ Transform-stream reporters (like `@reporters/gh`) are supported as route reporte
   `@reporters/web` accepts `{ open: boolean }`); most reporters need none.
 - `sink` — `'stdout'`, `'stderr'`, a file path, or a `Sink` object.
 - `open` — open the sink's viewer URL in a browser. Defaults to on locally, off
-  in CI. `open: false` opts out; `REPORTERS_OPEN=1|0` forces it.
+  in CI. `open: false` opts out; `REPORTERS_OPEN=1|0` forces it. This is the
+  only open gate: a reporter can declare default options for when it runs under
+  mux — attached to the reporter function under
+  `Symbol.for('reporters.mux.defaultOptions')`, merged beneath the route's
+  `options` — which is how reporters that self-open standalone (like
+  `@reporters/web`, declaring `{ open: false }`) stay pure emitters here.
 
 ### Profile resolution
 
@@ -95,3 +100,22 @@ Built in: `'stdout'`, `'stderr'`, and file paths. Beyond those:
 
 When a sink exposes a `viewerUrl`, mux prints `report at <url>` to stderr and —
 on GitHub Actions — adds a **View report** link to the job summary.
+
+Reporters can consume a sink's viewer URL too: keep the sink instance and pass
+a lazy getter into another route's `options`. Every sink in the profile has
+started before any reporter receives events, so the getter is live from the
+first event on (note `options` reach function reporters only — stream
+reporters have no options channel):
+
+```js
+import { s3 } from '@reporters/sink';
+
+const upload = s3({ bucket: 'ci-runs' });
+
+export default {
+  ci: [
+    { reporter: '@reporters/web', sink: upload },
+    { reporter: './my-reporter.mjs', options: { viewerUrl: () => upload.viewerUrl() }, sink: 'stdout' },
+  ],
+};
+```

package/dist/index.d.ts

@@ -40,7 +40,12 @@ interface Sink {
     flush?(): Promise<void>;
     /** The run ended; release resources. */
     close(): Promise<void>;
-    /** How a human views what was written, if anything. */
+    /**
+     * How a human views what was written, if anything. Valid once `start()` has
+     * resolved; under mux, every sink in the profile has started before any
+     * reporter receives events, so a getter wired into another route's
+     * `options` is live from the first event.
+     */
     viewerUrl?(): string | undefined;
 }
 type SinkSpec = string | Sink;
@@ -61,6 +66,13 @@ interface Route {
 /** Map of profile name -> the routes active under that profile. */
 type MuxConfig = Record<string, Route[]>;
 
+/**
+ * Well-known key under which a reporter function declares the options it wants
+ * by default when driven through mux (a route's own `options` win key-by-key).
+ * Lets a reporter behave differently under mux without env coupling — e.g.
+ * `@reporters/web` declares `{ open: false }` so the sink owns viewing.
+ */
+declare const MUX_DEFAULT_OPTIONS: unique symbol;
 /** A reporter function, a stream instance, or a module specifier to `import()`. */
 declare function resolveReporter(reporter: Reporter | Duplex | string): Promise<Reporter | Duplex>;
 /**
@@ -76,4 +88,4 @@ declare function runRoutes(source: AsyncIterable<TestEvent>, config: MuxConfig,
  */
 declare function mux(source: AsyncIterable<TestEvent>): AsyncGenerator<string>;
 
-export { type MuxConfig, type Reporter, type Route, type Sink, type SinkSpec, mux as default, resolveReporter, runRoutes };
+export { MUX_DEFAULT_OPTIONS, type MuxConfig, type Reporter, type Route, type Sink, type SinkSpec, mux as default, resolveReporter, runRoutes };

package/dist/index.js

@@ -183,6 +183,12 @@ function announce(url, env = process.env) {
 var internals = { openInBrowser, announce };
 
 // src/index.ts
+var MUX_DEFAULT_OPTIONS = /* @__PURE__ */ Symbol.for("reporters.mux.defaultOptions");
+function routeOptions(reporter, route) {
+  const defaults = reporter[MUX_DEFAULT_OPTIONS];
+  if (!defaults) return route.options;
+  return { ...defaults, ...route.options };
+}
 function isStreamReporter(value) {
   return typeof value === "object" && value !== null && typeof value.pipe === "function";
 }
@@ -196,12 +202,15 @@ async function resolveReporter(reporter) {
 async function runRoutes(source, config, env = process.env, open = internals.openInBrowser) {
   const routes = resolveProfile(config, env);
   const streams = broadcast(source, routes.length);
-  await Promise.all(routes.map(async (route, i) => {
-    const reporter = await resolveReporter(route.reporter);
-    const sink = resolveSink(route.sink);
-    const stage = typeof reporter === "function" ? (src) => reporter(src, route.options) : reporter;
+  const sinks = routes.map((route) => resolveSink(route.sink));
+  const starts = sinks.map((sink) => sink.start?.());
+  await Promise.allSettled(starts);
+  const results = await Promise.allSettled(routes.map(async (route, i) => {
+    const sink = sinks[i];
     try {
-      if (sink.start) await sink.start();
+      await starts[i];
+      const reporter = await resolveReporter(route.reporter);
+      const stage = typeof reporter === "function" ? (src) => reporter(src, routeOptions(reporter, route)) : reporter;
       const url = sink.viewerUrl?.();
       if (url) {
         internals.announce(url, env);
@@ -214,12 +223,15 @@ async function runRoutes(source, config, env = process.env, open = internals.ope
       await sink.close();
     }
   }));
+  const failure = results.find((r) => r.status === "rejected");
+  if (failure) throw failure.reason;
 }
 async function* mux(source) {
   const config = await loadConfig();
   await runRoutes(source, config);
 }
 export {
+  MUX_DEFAULT_OPTIONS,
   mux as default,
   resolveReporter,
   runRoutes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reporters/mux",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Environment-aware routing reporter for `node:test`: tee the event stream to multiple reporters and sinks",
   "type": "module",
   "keywords": [
@@ -29,7 +29,7 @@
     "test": "node --test-reporter=@reporters/mux --test"
   },
   "devDependencies": {
-    "@reporters/tree-core": "workspace:^",
+    "@reporters/tree-core": "^0.0.0",
     "tsup": "^8.5.0",
     "typescript": "^5.7.0"
   },
@@ -40,4 +40,4 @@
   "repository": "https://github.com/MoLow/reporters.git",
   "author": "Moshe Atlow",
   "license": "MIT"
-}
+}