@zerotal/devtools 1.8.1 → 1.10.0

package/CHANGELOG.md

@@ -8,6 +8,16 @@ follows the Zerotal monorepo's unified versioning.
 
 ## [Unreleased]
 
+## [1.9.0] — 2026-08-29
+
+### Documented
+
+- **Every promised export is documented.** The `docs-coverage` gate reads `maturity: stable` as a
+  promise about a package's exports, and measures how much of that promise is written down. It
+  was 798 gaps across the suite; it is now zero. This package's share is covered on its own
+  pages — types named, options shapes described, and the decisions behind them recorded where
+  somebody looking for them will find them.
+
 ## [1.8.1] — 2026-08-26
 
 ### Fixed

package/api-surface.md

@@ -45,10 +45,6 @@ class TraceStore = {
   subscribe: (fn: Subscriber) => () => void
 }
 
-const traceSink = TraceSink
-
-function attributeBindings = (sql: string, count: number) => Array<string | undefined>
-
 function DevtoolsConfig = (options?: Partial<DevtoolsConfigShape>) => DevtoolsConfigShape
 
 function devtoolsEnabled = () => boolean
@@ -61,10 +57,6 @@ function redactCacheKey = (key: string, options?: RedactionOptions) => string
 
 function redactValue = (value: unknown, options?: RedactionOptions) => unknown
 
-function startDevtoolsStream = () => () => void
-
-function traceChannels = () => TraceChannelDescriptor[]
-
 function traceStore = () => TraceStore
 
 interface AuthInfo = {
@@ -94,8 +86,6 @@ interface DevtoolsConfigShape = {
   redact: RedactionOptions
 }
 
-interface DevtoolsInjectionOptions = {}
-
 interface DevtoolsPanelPlugin = {
   badge?: () => number | string | undefined
   id: string
@@ -151,9 +141,9 @@ interface QuerySpan = {
 }
 
 interface RedactionOptions = {
-  allow?: string[]
-  deny?: string[]
-  enabled?: boolean
+  allow?: string[] | undefined
+  deny?: string[] | undefined
+  enabled?: boolean | undefined
 }
 
 interface RequestTrace = {
@@ -228,9 +218,9 @@ interface TraceSink = {
 }
 
 interface TraceStoreOptions = {
-  capacity?: number
-  dbPath?: string | null
-  pruneHours?: number
+  capacity?: number | undefined
+  dbPath?: string | null | undefined
+  pruneHours?: number | undefined
 }
 
 type DevtoolsGate = (request: Request) => boolean | Promise<boolean>
@@ -262,9 +252,9 @@ function traceGroupKey = (trace: RequestTrace, channels: TraceChannelDescriptor[
 function traceMatches = (trace: RequestTrace, query: string, f: Facets) => boolean
 
 interface DevtoolsClientOptions = {
-  endpoint?: string
-  mode?: 'floating' | 'standalone'
-  mount?: HTMLElement
+  endpoint?: string | undefined
+  mode?: 'floating' | 'standalone' | undefined
+  mount?: HTMLElement | undefined
 }
 
 interface DevtoolsPanelPlugin = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerotal/devtools",
-  "version": "1.8.1",
+  "version": "1.10.0",
   "license": "MIT",
   "maturity": "stable",
   "private": false,
@@ -31,11 +31,11 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@zerotal/core": "1.8.1"
+    "@zerotal/core": "1.10.0"
   },
   "devDependencies": {
     "typescript": "^5.8.0",
-    "@zerotal/orm": "1.8.1"
+    "@zerotal/orm": "1.10.0"
   },
   "description": "In-browser developer tools for Zerotal — request traces, an inspector panel, and an extensible tab registry.",
   "keywords": [

package/src/DevtoolsInjectionMiddleware.ts

@@ -43,6 +43,7 @@ async function _buildDashboardJs(): Promise<string> {
   return _dashboardJs;
 }
 
+/** @internal */
 export interface DevtoolsInjectionOptions {
   // reserved for future use
 }
@@ -102,6 +103,8 @@ const SSE_HEARTBEAT_MS = 25_000;
  * built the one the app's config asks for.
  *
  * @returns A disposer that unsubscribes and closes connected clients.
+ *
+ * @internal
  */
 export function startDevtoolsStream(): () => void {
   const unsubscribe = traceStore().subscribe((trace) => {

package/src/TraceStore.ts

@@ -16,11 +16,11 @@ interface Db {
 
 export interface TraceStoreOptions {
   /** How many traces to keep in memory and load back on open. */
-  capacity?: number;
+  capacity?: number | undefined;
   /** SQLite file backing the history. Pass `null` to keep traces in memory only. */
-  dbPath?: string | null;
+  dbPath?: string | null | undefined;
   /** How long a persisted trace survives, in hours. */
-  pruneHours?: number;
+  pruneHours?: number | undefined;
 }
 
 /**

package/src/client/index.ts

@@ -33,7 +33,7 @@ import { timelineTab } from "./tabs/timeline.ts";
 
 export interface DevtoolsClientOptions {
   /** Base URL path for the devtools API. Default: '/__zerotal/devtools' */
-  endpoint?: string;
+  endpoint?: string | undefined;
   /**
    * How the panel is mounted.
    *
@@ -42,9 +42,9 @@ export interface DevtoolsClientOptions {
    * inspector dashboard. Both run the same renderers, so a tab added for one
    * exists in the other.
    */
-  mode?: "floating" | "standalone";
+  mode?: "floating" | "standalone" | undefined;
   /** Element to mount into. Defaults to `document.body`. */
-  mount?: HTMLElement;
+  mount?: HTMLElement | undefined;
 }
 
 /**

package/src/redaction.ts

@@ -31,17 +31,17 @@ export interface RedactionOptions {
    * Turn masking off entirely. Only reasonable when you are debugging the values
    * themselves and nothing sensitive is in the database.
    */
-  enabled?: boolean;
+  enabled?: boolean | undefined;
   /**
    * Names whose values are safe to show in full. Matched case-insensitively
    * against the column a binding belongs to, a channel entry's field name, or a
    * cache key's segment.
    */
-  allow?: string[];
+  allow?: string[] | undefined;
   /**
    * Extra names to mask, added to the built-in list.
    */
-  deny?: string[];
+  deny?: string[] | undefined;
 }
 
 /**
@@ -247,6 +247,8 @@ export function redactBindings(
  * `SET col = ?`, and `WHERE col <op> ?` (including `IN (?, ?)`, where every
  * placeholder belongs to the same column). Returns `undefined` at any position it
  * cannot attribute.
+ *
+ * @internal
  */
 export function attributeBindings(sql: string, count: number): Array<string | undefined> {
   const out: Array<string | undefined> = new Array(count).fill(undefined);

package/src/tracing.ts

@@ -99,6 +99,8 @@ const _channels = new Map<string, TraceChannelDescriptor>();
  *
  * A `hidden` channel is left out: its entries are still recorded and still reach
  * the panel on the trace, but whatever renders them is not this generic row list.
+ *
+ * @internal
  */
 export function traceChannels(): TraceChannelDescriptor[] {
   return [...(_channels.values() as Iterable<TraceChannelDescriptor>)]
@@ -199,6 +201,7 @@ export interface TraceSink {
 // nothing: by the time a panel draws a row, the unredacted copy has already been
 // streamed to the browser and written to `.zerotal/devtools.sqlite`, where it
 // sits for a day. The sink is the last point where "not recorded" is still true.
+/** @internal */
 export const traceSink: TraceSink = {
   channel(descriptor: TraceChannelDescriptor): void {
     _channels.set(descriptor.id, descriptor);