@beignet/devtools 0.0.1 → 0.0.3

package/src/watchers.ts

@@ -1,5 +1,8 @@
 import type { DevtoolsEvent } from "./events";
 
+/**
+ * Built-in devtools watcher names.
+ */
 export const BUILT_IN_DEVTOOLS_WATCHER_NAMES = [
   "requests",
   "errors",
@@ -11,26 +14,55 @@ export const BUILT_IN_DEVTOOLS_WATCHER_NAMES = [
   "db",
   "cache",
   "storage",
+  "uploads",
   "mail",
+  "notifications",
   "auth",
   "audit",
   "rateLimit",
   "custom",
 ] as const;
 
+/**
+ * Name of a built-in devtools watcher.
+ */
 export type BuiltInDevtoolsWatcherName =
   (typeof BUILT_IN_DEVTOOLS_WATCHER_NAMES)[number];
 
+/**
+ * Name of a built-in or app-defined devtools watcher.
+ */
 export type DevtoolsWatcherName = BuiltInDevtoolsWatcherName | (string & {});
 
+/**
+ * Resolved devtools watcher configuration.
+ */
 export interface DevtoolsWatcher {
+  /**
+   * Watcher name.
+   */
   name: DevtoolsWatcherName;
+  /**
+   * Display label.
+   */
   label: string;
+  /**
+   * Display description.
+   */
   description?: string;
+  /**
+   * Event types this watcher owns.
+   */
   eventTypes: readonly DevtoolsEvent["type"][];
+  /**
+   * Whether events owned by this watcher should be stored.
+   */
   enabled: boolean;
 }
 
+/**
+ * User-provided watcher override.
+ */
 export type DevtoolsWatcherOptions =
   | boolean
   | {
@@ -40,6 +72,9 @@ export type DevtoolsWatcherOptions =
       eventTypes?: readonly DevtoolsEvent["type"][];
     };
 
+/**
+ * Watcher overrides keyed by built-in or custom watcher name.
+ */
 export type DevtoolsWatchersOptions = Partial<
   Record<BuiltInDevtoolsWatcherName, DevtoolsWatcherOptions>
 > &
@@ -117,6 +152,13 @@ const BUILT_IN_DEVTOOLS_WATCHERS = {
     eventTypes: ["custom"],
     enabled: true,
   },
+  uploads: {
+    name: "uploads",
+    label: "Uploads",
+    description: "Upload preparation, direct upload signing, and completion.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
   mail: {
     name: "mail",
     label: "Mail",
@@ -124,6 +166,13 @@ const BUILT_IN_DEVTOOLS_WATCHERS = {
     eventTypes: ["custom"],
     enabled: true,
   },
+  notifications: {
+    name: "notifications",
+    label: "Notifications",
+    description: "Application notification intent and channel delivery.",
+    eventTypes: ["custom"],
+    enabled: true,
+  },
   auth: {
     name: "auth",
     label: "Auth",
@@ -184,6 +233,9 @@ function normalizeWatcherOptions(
   };
 }
 
+/**
+ * Resolve built-in and custom watcher configuration.
+ */
 export function resolveDevtoolsWatchers(
   options: DevtoolsWatchersOptions = {},
 ): DevtoolsWatcher[] {
@@ -211,6 +263,9 @@ export function resolveDevtoolsWatchers(
   return watchers;
 }
 
+/**
+ * Check whether a watcher is enabled.
+ */
 export function isDevtoolsWatcherEnabled(
   watchers: readonly DevtoolsWatcher[],
   name: DevtoolsWatcherName,
@@ -218,6 +273,9 @@ export function isDevtoolsWatcherEnabled(
   return watchers.find((watcher) => watcher.name === name)?.enabled ?? true;
 }
 
+/**
+ * Check whether an event should be stored for a watcher configuration.
+ */
 export function isDevtoolsEventEnabled(
   watchers: readonly DevtoolsWatcher[],
   event: DevtoolsEvent,