@mugenlabs/logtape-devtools 0.2.1 → 0.4.0

package/dist/index.d.ts

@@ -1,31 +1,8 @@
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { Sink } from '@logtape/logtape';
-
-type LogLevel = "trace" | "debug" | "info" | "warning" | "error" | "fatal";
-declare const LOG_LEVELS: LogLevel[];
-interface DevtoolsLogRecord {
-    /** Source location of the log call (only present when `experimentalCaptureStackTrace` is enabled). */
-    caller?: string;
-    category: string[];
-    id: string;
-    level: LogLevel;
-    message: unknown[];
-    messageText: string;
-    properties: Record<string, unknown>;
-    timestamp: number;
-}
-
-type Listener = () => void;
-interface LogStore {
-    addRecord(record: DevtoolsLogRecord): void;
-    clear(): void;
-    getSnapshot(): DevtoolsLogRecord[];
-    setMaxSize(size: number): void;
-    subscribe(listener: Listener): () => void;
-}
-declare function createLogStore(maxSize?: number): LogStore;
-/** Default shared store instance used when no custom store is provided */
-declare const defaultLogStore: LogStore;
+import { LogStore, DevtoolsSinkOptions, DevtoolsSink } from './sink.js';
+export { DevtoolsLogRecord, LOG_LEVELS, LogLevel, LogStoreOptions, createDevtoolsSink, createLogStore, defaultLogStore } from './sink.js';
+import * as _tanstack_react_devtools from '@tanstack/react-devtools';
+import { TanStackDevtoolsReactPlugin } from '@tanstack/react-devtools';
+import '@logtape/logtape';
 
 interface LogTapeDevtoolsPluginOptions {
     /** Whether to open the devtools panel by default. Default: true */
@@ -46,60 +23,45 @@ interface LogTapeDevtoolsPluginOptions {
  * <TanStackDevtools plugins={[createLogTapeDevtoolsPlugin()]} />
  * ```
  */
-declare const createLogTapeDevtoolsPlugin: (options?: LogTapeDevtoolsPluginOptions) => {
-    defaultOpen: boolean;
-    id: string;
-    name: string;
-    render: react_jsx_runtime.JSX.Element;
-};
-
-interface Props {
-    store: LogStore;
-}
-declare const LogTapeDevtoolsPlugin: ({ store }: Props) => react_jsx_runtime.JSX.Element;
+declare const createLogTapeDevtoolsPlugin: (options?: LogTapeDevtoolsPluginOptions) => TanStackDevtoolsReactPlugin;
 
-interface DevtoolsSinkOptions {
-    /**
-     * Capture the source location of each log call via stack trace parsing.
-     *
-     * **Experimental / dev-only** — relies on `new Error().stack` which is
-     * engine-dependent. Automatically disabled in production builds (when
-     * `process.env.NODE_ENV === "production"`) because minified bundles
-     * produce meaningless file/line references. Note that source maps do not
-     * help here — browsers do not apply source maps to `Error.stack`.
-     *
-     * Set `forceStackTrace` to `true` to override the production guard — useful
-     * when your production build ships unminified code.
-     *
-     * @default true
-     */
-    experimentalCaptureStackTrace?: boolean;
-    /**
-     * Force stack trace capture even in production builds.
-     * Only has an effect when `experimentalCaptureStackTrace` is `true`.
-     *
-     * @default false
-     */
-    forceStackTrace?: boolean;
-    /** Custom log store instance. Defaults to the shared store. */
+/** Options for {@link createLogTapeDevtools}. */
+interface CreateLogTapeDevtoolsOptions {
+    /** Plugin options, minus `store` — the shared store is wired automatically. */
+    plugin?: Omit<LogTapeDevtoolsPluginOptions, "store">;
+    /** Sink options, minus `store` — the shared store is wired automatically. */
+    sink?: Omit<DevtoolsSinkOptions, "store">;
+    /** Store shared by the sink and the plugin. Defaults to the shared store. */
     store?: LogStore;
 }
 /**
- * Creates a LogTape sink that forwards log records to the devtools panel.
+ * Creates a LogTape sink and its matching TanStack DevTools plugin, both wired
+ * to the same store.
  *
- * Usage:
- * ```ts
- * import { configure } from "@logtape/logtape";
- * import { createDevtoolsSink } from "@mugenlabs/logtape-devtools";
+ * Use this instead of calling `createDevtoolsSink` and
+ * `createLogTapeDevtoolsPlugin` separately when you do not need to hold on to
+ * the store yourself.
+ *
+ * ```tsx
+ * import { configure, getLogger } from "@logtape/logtape";
+ * import { TanStackDevtools } from "@tanstack/react-devtools";
+ * import { createLogTapeDevtools } from "@mugenlabs/logtape-devtools";
+ *
+ * const { sink, plugin } = createLogTapeDevtools();
  *
  * await configure({
- *   sinks: { devtools: createDevtoolsSink() },
- *   loggers: [
- *     { category: ["app"], lowestLevel: "debug", sinks: ["devtools"] },
- *   ],
+ *   sinks: { devtools: sink },
+ *   loggers: [{ category: [], lowestLevel: "trace", sinks: ["devtools"] }],
  * });
+ *
+ * function App() {
+ *   return <TanStackDevtools plugins={[plugin]} />;
+ * }
  * ```
  */
-declare function createDevtoolsSink(options?: DevtoolsSinkOptions): Sink;
+declare function createLogTapeDevtools(options?: CreateLogTapeDevtoolsOptions): {
+    plugin: _tanstack_react_devtools.TanStackDevtoolsReactPlugin;
+    sink: DevtoolsSink;
+};
 
-export { type DevtoolsLogRecord, type DevtoolsSinkOptions, LOG_LEVELS, type LogLevel, type LogStore, LogTapeDevtoolsPlugin, type LogTapeDevtoolsPluginOptions, createDevtoolsSink, createLogStore, createLogTapeDevtoolsPlugin, defaultLogStore };
+export { type CreateLogTapeDevtoolsOptions, DevtoolsSink, DevtoolsSinkOptions, LogStore, type LogTapeDevtoolsPluginOptions, createLogTapeDevtools, createLogTapeDevtoolsPlugin };