@dxos/log 0.8.4-main.fbb7a13 → 0.8.4-main.fcc0d83b33

package/src/log.ts

@@ -3,13 +3,15 @@
 //
 
 import { type LogConfig, LogLevel, type LogOptions } from './config';
-import { type LogContext, type LogProcessor } from './context';
+import { type LogContext, LogEntry, type LogProcessor } from './context';
 import { createFunctionLogDecorator, createMethodLogDecorator } from './decorators';
 import { type CallMetadata } from './meta';
 import { createConfig } from './options';
 
 /**
  * Accessible from browser console.
+ * Example: `DX_LOG.config({ filter: 'ERROR' })`
+ * NOTE: File level filtering isn't supported in storybooks.
  */
 declare global {
   const DX_LOG: Log;
@@ -24,18 +26,60 @@ type LogFunction = (message: string, context?: LogContext, meta?: CallMetadata)
  * Logging methods.
  */
 export interface LogMethods {
-  config: (options: LogOptions) => Log;
+  config: (options?: LogOptions) => Log;
   addProcessor: (processor: LogProcessor, addDefault?: boolean) => () => void;
 
+  /**
+   * Log at `trace` level.
+   *
+   * Generally not surfaced to the developer and not captured in a log file.
+   */
   trace: LogFunction;
+
+  /**
+   * Log at `debug` level.
+   * Generally not surfaced to the developer and captured in a log file.
+   */
   debug: LogFunction;
+
+  /**
+   * Log at `verbose` level.
+   * Generally not surfaced to the developer and not captured in a log file.
+   */
   verbose: LogFunction;
+
+  /**
+   * Log at `info` level.
+   * Generally surfaced to the developer and captured in a log file.
+   */
   info: LogFunction;
+
+  /**
+   * Log at `warn` level.
+   * Generally surfaced to the developer and captured in a log file.
+   */
   warn: LogFunction;
+
+  /**
+   * Log at `error` level.
+   * Generally surfaced to the developer and captured in a log file.
+   */
   error: LogFunction;
+
+  /**
+   * Log an error and its stack trace at an `error` level.
+   * Generally surfaced to the developer and captured in a log file.
+   */
   catch: (error: Error | any, context?: LogContext, meta?: CallMetadata) => void;
 
+  /**
+   * Decorator to log method parameters and return value at the `info` level.
+   */
   method: (arg0?: never, arg1?: never, meta?: CallMetadata) => MethodDecorator;
+
+  /**
+   * Wrapper to log function parameters and return value at the `info` level.
+   */
   function: <F extends (...args: any[]) => any>(
     name: string,
     fn: F,
@@ -44,7 +88,14 @@ export interface LogMethods {
     },
   ) => F;
 
+  /**
+   * Log a horizontal rule at the `info` level.
+   */
   break: () => void;
+
+  /**
+   * Log a stack trace at the `info` level.
+   */
   stack: (message?: string, context?: never, meta?: CallMetadata) => void;
 }
 
@@ -96,15 +147,8 @@ export const createLog = (): LogImp => {
     error?: Error,
   ) => {
     // TODO(burdon): Do the filter matching upstream (here) rather than in each processor?
-    log._config.processors.forEach((processor) =>
-      processor(log._config, {
-        level,
-        message,
-        context,
-        meta,
-        error,
-      }),
-    );
+    const entry = new LogEntry({ level, message, context, meta, error });
+    log._config.processors.forEach((processor) => processor(log._config, entry));
   };
 
   /**
@@ -116,7 +160,7 @@ export const createLog = (): LogImp => {
      * NOTE: Preserves any processors that were already added to this logger instance
      * unless an explicit processor option is provided.
      */
-    config: ({ processor, ...options }) => {
+    config: ({ processor, ...options } = {}) => {
       const config = createConfig(options);
       // TODO(burdon): This could be buggy since the behavior is not reentrant.
       const processors = processor ? config.processors : log._config.processors;

package/src/meta.ts

@@ -3,11 +3,27 @@
 //
 
 /**
- * Metadata injected b y the log transform plugin.
+ * Marker key + value injected on every {@link CallMetadata} object by the log transform plugin.
+ * Used by {@link isLogMeta} to detect a log-meta argument at runtime (e.g. for variadic
+ * `param_index: 'last'` callees that don't have a fixed meta slot).
+ */
+export const LOG_META_MARKER = '~LogMeta';
+
+/**
+ * Metadata injected by the log transform plugin.
  *
  * Field names are intentionally short to reduce the size of the generated code.
  */
 export interface CallMetadata {
+  /**
+   * Marker tag — when present, equal to {@link LOG_META_MARKER} ({@link `'~LogMeta'`}).
+   * Injected by the log transform plugin on every emitted meta object so that {@link isLogMeta}
+   * can distinguish a meta argument from a regular user-supplied value at runtime.
+   * Optional because hand-written `CallMetadata` literals (decorators, RPC mappers, tests)
+   * don't need the marker — they are recognized by position in the call signature.
+   */
+  '~LogMeta'?: typeof LOG_META_MARKER;
+
   /**
    * File name.
    */
@@ -35,3 +51,15 @@ export interface CallMetadata {
    */
   A?: string[];
 }
+
+/**
+ * Type guard: `true` when `value` is a {@link CallMetadata} object emitted by the log transform plugin.
+ * Detection is based on the presence of the {@link LOG_META_MARKER} marker key/value.
+ */
+export const isLogMeta = (value: unknown): value is CallMetadata => {
+  return (
+    value != null &&
+    typeof value === 'object' &&
+    (value as Record<string, unknown>)[LOG_META_MARKER] === LOG_META_MARKER
+  );
+};

package/src/platform/node/index.ts

@@ -2,9 +2,8 @@
 // Copyright 2022 DXOS.org
 //
 
-import fs from 'node:fs';
-
 import yaml from 'js-yaml';
+import fs from 'node:fs';
 
 import { type LogOptions } from '../../config';
 

package/src/processors/browser-processor.ts

@@ -2,23 +2,11 @@
 // Copyright 2022 DXOS.org
 //
 
-import { getDebugName, safariCheck } from '@dxos/util';
+import { safariCheck } from '@dxos/util';
 
 import { LogLevel } from '../config';
 import { type LogProcessor, getContextFromEntry, shouldLog } from '../context';
 
-const getRelativeFilename = (filename: string) => {
-  // TODO(burdon): Hack uses "packages" as an anchor (pre-parse NX?)
-  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.
-  const match = filename.match(/.+\/(packages\/.+\/.+)/);
-  if (match) {
-    const [, filePath] = match;
-    return filePath;
-  }
-
-  return filename;
-};
-
 type Config = {
   useTestProcessor: boolean;
   printFileLinks: boolean;
@@ -47,23 +35,26 @@ const APP_BROWSER_PROCESSOR: LogProcessor = (config, entry) => {
   // const LOG_BROWSER_CSS = ['color:gray; font-size:10px; padding-bottom: 4px', 'color:#B97852; font-size:14px;'];
   const LOG_BROWSER_CSS: string[] = [];
 
+  const { filename, line: lineNumber, context: scopeDebugName } = entry.computedMeta;
+
   let link = '';
-  if (entry.meta) {
-    const filename = getRelativeFilename(entry.meta.F);
+  if (filename !== undefined && lineNumber !== undefined) {
     const filepath = `${LOG_BROWSER_PREFIX.replace(/\/$/, '')}/${filename}`;
     // TODO(burdon): Line numbers not working for app link, even with colons.
     //  https://stackoverflow.com/a/54459820/2804332
-    link = `${filepath}#L${entry.meta.L}`;
+    link = `${filepath}#L${lineNumber}`;
   }
 
   let args = [];
 
-  if (entry.meta?.S) {
-    const scope = entry.meta?.S;
-    const scopeName = scope.name || getDebugName(scope);
-    const processPrefix = entry.meta.S?.hostSessionId ? '[worker] ' : '';
-    // TODO(dmaretskyi): Those can be made clickable with a custom formatter.
-    args.push(`%c${processPrefix}${scopeName}`, 'color:#C026D3;font-weight:bold');
+  const scope = entry.meta?.S;
+  if (scope) {
+    const scopeName = scope.name || scopeDebugName;
+    if (scopeName) {
+      const processPrefix = scope.hostSessionId ? '[worker] ' : '';
+      // TODO(dmaretskyi): Those can be made clickable with a custom formatter.
+      args.push(`%c${processPrefix}${scopeName}`, 'color:#C026D3;font-weight:bold');
+    }
   }
 
   if (entry.message) {
@@ -73,9 +64,9 @@ const APP_BROWSER_PROCESSOR: LogProcessor = (config, entry) => {
   const context = getContextFromEntry(entry);
   if (context) {
     if (Object.keys(context).length === 1 && 'error' in context) {
-      args.push(context.error);
+      args.push(unwrapEffectError(context.error));
     } else if (Object.keys(context).length === 1 && 'err' in context) {
-      args.push(context.err);
+      args.push(unwrapEffectError(context.err));
     } else {
       args.push(context);
     }
@@ -114,10 +105,8 @@ const TEST_BROWSER_PROCESSOR: LogProcessor = (config, entry) => {
     return;
   }
 
-  let path = '';
-  if (entry.meta) {
-    path = `${getRelativeFilename(entry.meta.F)}:${entry.meta.L}`;
-  }
+  const { filename, line: lineNumber } = entry.computedMeta;
+  const path = filename !== undefined && lineNumber !== undefined ? `${filename}:${lineNumber}` : '';
 
   let args = [];
 
@@ -148,3 +137,13 @@ const TEST_BROWSER_PROCESSOR: LogProcessor = (config, entry) => {
 };
 
 export const BROWSER_PROCESSOR: LogProcessor = CONFIG.useTestProcessor ? TEST_BROWSER_PROCESSOR : APP_BROWSER_PROCESSOR;
+
+// effect-specific
+const originalSymbol = Symbol.for('effect/OriginalAnnotation');
+
+const unwrapEffectError = (error: any) => {
+  if (typeof error === 'object' && error !== null && originalSymbol in error) {
+    return error[originalSymbol];
+  }
+  return error;
+};

package/src/processors/console-processor.ts

@@ -2,17 +2,14 @@
 // Copyright 2022 DXOS.org
 //
 
-import { inspect } from 'node:util';
-
 import chalk from 'chalk';
+import { inspect } from 'node:util';
 
 import { getPrototypeSpecificInstanceId, pickBy } from '@dxos/util';
 
 import { type LogConfig, LogLevel, shortLevelName } from '../config';
 import { type LogProcessor, getContextFromEntry, shouldLog } from '../context';
 
-import { getRelativeFilename } from './common';
-
 const LEVEL_COLORS: Record<LogLevel, typeof chalk.ForegroundColor> = {
   [LogLevel.TRACE]: 'gray',
   [LogLevel.DEBUG]: 'gray',
@@ -95,22 +92,17 @@ export const CONSOLE_PROCESSOR: LogProcessor = (config, entry) => {
     return;
   }
 
+  const { filename, line: lineNumber } = entry.computedMeta;
   const parts: FormatParts = {
     level,
     message,
     error,
-    path: undefined,
-    line: undefined,
-    scope: undefined,
+    path: filename,
+    line: lineNumber,
+    scope: meta?.S,
     context: undefined,
   };
 
-  if (meta) {
-    parts.path = getRelativeFilename(meta.F);
-    parts.line = meta.L;
-    parts.scope = meta.S;
-  }
-
   const context = getContextFromEntry(entry);
   if (context) {
     // Remove undefined fields.

package/src/processors/file-processor.ts

@@ -5,12 +5,8 @@
 import { appendFileSync, mkdirSync, openSync } from 'node:fs';
 import { dirname } from 'node:path';
 
-import { jsonlogify } from '@dxos/util';
-
 import { type LogFilter, LogLevel } from '../config';
-import { type LogProcessor, getContextFromEntry, shouldLog } from '../context';
-
-import { getRelativeFilename } from './common';
+import { type LogProcessor, shouldLog } from '../context';
 
 // Amount of time to retry writing after encountering EAGAIN before giving up.
 const EAGAIN_MAX_DURATION = 1000;
@@ -50,10 +46,12 @@ export const createFileProcessor = ({
     }
 
     const record = {
-      ...entry,
-      timestamp: Date.now(),
-      ...(entry.meta ? { meta: { file: getRelativeFilename(entry.meta.F), line: entry.meta.L } } : {}),
-      context: jsonlogify(getContextFromEntry(entry)),
+      level: entry.level,
+      message: entry.message,
+      timestamp: entry.timestamp,
+      meta: entry.computedMeta,
+      context: entry.computedContext,
+      error: entry.computedError,
     };
     let retryTS: number = 0;
 

package/dist/lib/browser/chunk-GPOFUMLO.mjs

@@ -1,133 +0,0 @@
-// src/config.ts
-var LogLevel = /* @__PURE__ */ (function(LogLevel2) {
-  LogLevel2[LogLevel2["TRACE"] = 5] = "TRACE";
-  LogLevel2[LogLevel2["DEBUG"] = 10] = "DEBUG";
-  LogLevel2[LogLevel2["VERBOSE"] = 11] = "VERBOSE";
-  LogLevel2[LogLevel2["INFO"] = 12] = "INFO";
-  LogLevel2[LogLevel2["WARN"] = 13] = "WARN";
-  LogLevel2[LogLevel2["ERROR"] = 14] = "ERROR";
-  return LogLevel2;
-})({});
-var levels = {
-  "*": 5,
-  trace: 5,
-  debug: 10,
-  verbose: 11,
-  info: 12,
-  warn: 13,
-  error: 14
-};
-var shortLevelName = {
-  [5]: "T",
-  [10]: "D",
-  [11]: "V",
-  [12]: "I",
-  [13]: "W",
-  [14]: "E"
-};
-var LogProcessorType = /* @__PURE__ */ (function(LogProcessorType2) {
-  LogProcessorType2["CONSOLE"] = "console";
-  LogProcessorType2["BROWSER"] = "browser";
-  LogProcessorType2["DEBUG"] = "debug";
-  return LogProcessorType2;
-})({});
-
-// src/scope.ts
-var logInfoProperties = Symbol("logInfoProperties");
-var logInfo = (target, propertyKey, descriptor) => {
-  (target[logInfoProperties] ??= []).push(propertyKey);
-};
-var gatherLogInfoFromScope = (scope) => {
-  if (!scope) {
-    return {};
-  }
-  const res = {};
-  const prototype = Object.getPrototypeOf(scope);
-  const infoProps = (typeof prototype === "object" && prototype !== null ? prototype[logInfoProperties] : []) ?? [];
-  for (const prop of infoProps) {
-    try {
-      res[prop] = typeof scope[prop] === "function" ? scope[prop]() : scope[prop];
-    } catch (err) {
-      res[prop] = err.message;
-    }
-  }
-  return res;
-};
-
-// src/context.ts
-var matchFilter = (filter, level, path) => {
-  if (filter.pattern?.startsWith("-")) {
-    if (path?.includes(filter.pattern.slice(1))) {
-      if (level >= filter.level) {
-        return false;
-      }
-    }
-  } else {
-    if (filter.pattern?.length) {
-      if (path?.includes(filter.pattern)) {
-        return level >= filter.level;
-      }
-    } else {
-      if (level >= filter.level) {
-        return true;
-      }
-    }
-  }
-};
-var shouldLog = (entry, filters) => {
-  if (filters === void 0) {
-    return false;
-  }
-  const results = filters.map((filter) => matchFilter(filter, entry.level, entry.meta?.F)).filter((result) => result !== void 0);
-  return results.length > 0 && !results.some((results2) => results2 === false);
-};
-var getContextFromEntry = (entry) => {
-  let context;
-  if (entry.meta) {
-    const scopeInfo = gatherLogInfoFromScope(entry.meta.S);
-    if (Object.keys(scopeInfo).length > 0) {
-      context = Object.assign(context ?? {}, scopeInfo);
-    }
-  }
-  const entryContext = typeof entry.context === "function" ? entry.context() : entry.context;
-  if (entryContext) {
-    if (entryContext instanceof Error) {
-      const c = entryContext.context;
-      context = Object.assign(context ?? {}, {
-        error: entryContext.stack,
-        ...c
-      });
-    } else if (typeof entryContext === "object") {
-      context = Object.assign(context ?? {}, entryContext);
-    }
-  }
-  if (entry.error) {
-    context = Object.assign(context ?? {}, {
-      error: entry.error
-    });
-  }
-  return context && Object.keys(context).length > 0 ? context : void 0;
-};
-
-// src/processors/common.ts
-var getRelativeFilename = (filename) => {
-  const match = filename.match(/.+\/(packages\/.+\/.+)/);
-  if (match) {
-    const [, filePath] = match;
-    return filePath;
-  }
-  return filename;
-};
-
-export {
-  LogLevel,
-  levels,
-  shortLevelName,
-  LogProcessorType,
-  logInfo,
-  gatherLogInfoFromScope,
-  shouldLog,
-  getContextFromEntry,
-  getRelativeFilename
-};
-//# sourceMappingURL=chunk-GPOFUMLO.mjs.map

package/dist/lib/browser/chunk-GPOFUMLO.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/config.ts", "../../../src/scope.ts", "../../../src/context.ts", "../../../src/processors/common.ts"],
-  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { type LogProcessor } from './context';\n\n/**\n * Standard levels.\n * NOTE: Keep aligned with LogLevel in @dxos/protocols.\n */\n// TODO(burdon): Update numbers?\nexport enum LogLevel {\n  TRACE = 5,\n  DEBUG = 10,\n  VERBOSE = 11,\n  INFO = 12,\n  WARN = 13,\n  ERROR = 14,\n}\n\nexport const levels: Record<string, LogLevel> = {\n  '*': LogLevel.TRACE,\n  trace: LogLevel.TRACE,\n  debug: LogLevel.DEBUG,\n  verbose: LogLevel.VERBOSE,\n  info: LogLevel.INFO,\n  warn: LogLevel.WARN,\n  error: LogLevel.ERROR,\n};\n\nexport const shortLevelName = {\n  [LogLevel.TRACE]: 'T',\n  [LogLevel.DEBUG]: 'D',\n  [LogLevel.VERBOSE]: 'V',\n  [LogLevel.INFO]: 'I',\n  [LogLevel.WARN]: 'W',\n  [LogLevel.ERROR]: 'E',\n};\n\nexport enum LogProcessorType {\n  CONSOLE = 'console',\n  BROWSER = 'browser',\n  DEBUG = 'debug',\n}\n\n/**\n * Individual filter condition.\n */\nexport type LogFilter = {\n  level: LogLevel;\n  pattern?: string;\n};\n\n/**\n * Options to set inline or load from the YML file.\n */\nexport type LogOptions = {\n  file?: string;\n  filter?: string | string[] | LogLevel;\n  captureFilter?: string | string[] | LogLevel;\n  depth?: number; // Context object depth.\n  processor?: string | LogProcessorType;\n  formatter?: {\n    column: number;\n    timestamp: boolean;\n    timestampFirst: boolean;\n  };\n  prefix?: string;\n};\n\n/**\n * Runtime config.\n */\nexport interface LogConfig {\n  options: LogOptions;\n  filters?: LogFilter[];\n  captureFilters?: LogFilter[];\n  processors: LogProcessor[];\n  prefix?: string;\n}\n", "//\n// Copyright 2022 DXOS.org\n//\n\nconst logInfoProperties = Symbol('logInfoProperties');\n\n/**\n * Decorate fields, properties, or methods to automatically include their values in log messages.\n *\n * Example:\n *\n * ```typescript\n * class Example {\n *   @logInfo\n *   peerId: PublicKey;\n * }\n * ```\n */\nexport const logInfo = (target: any, propertyKey: string, descriptor?: PropertyDescriptor) => {\n  // console.log(target, propertyKey, descriptor);\n  (target[logInfoProperties] ??= []).push(propertyKey);\n};\n\n/**\n * Introspects class instance to find decorated metadata.\n * @param scope Class instance.\n */\nexport const gatherLogInfoFromScope = (scope: any): Record<string, any> => {\n  if (!scope) {\n    return {};\n  }\n\n  const res: Record<string, any> = {};\n\n  const prototype = Object.getPrototypeOf(scope);\n  const infoProps = (typeof prototype === 'object' && prototype !== null ? prototype[logInfoProperties] : []) ?? [];\n  for (const prop of infoProps) {\n    try {\n      res[prop] = typeof scope[prop] === 'function' ? scope[prop]() : scope[prop];\n    } catch (err: any) {\n      res[prop] = err.message;\n    }\n  }\n\n  return res;\n};\n", "//\n// Copyright 2022 DXOS.org\n//\n\nimport { type LogConfig, type LogFilter, type LogLevel } from './config';\nimport { type CallMetadata } from './meta';\nimport { gatherLogInfoFromScope } from './scope';\n\n/**\n * Optional object passed to the logging API.\n */\nexport type LogContext = Record<string, any> | Error | any;\n\n/**\n * Record for current log line.\n */\nexport interface LogEntry {\n  level: LogLevel;\n  message?: string;\n  context?: LogContext;\n  meta?: CallMetadata;\n  error?: Error;\n}\n\n/**\n * Processes (e.g., prints, forwards) log entries.\n */\nexport type LogProcessor = (config: LogConfig, entry: LogEntry) => void;\n\n/**\n * Returns:\n * true if the log entry matches the filter,\n * false if should be excluded, or\n * undefined if it the filter doesn't match the level.\n */\nconst matchFilter = (filter: LogFilter, level: LogLevel, path?: string): boolean | undefined => {\n  // TODO(burdon): Support regexp.\n  if (filter.pattern?.startsWith('-')) {\n    // Exclude.\n    if (path?.includes(filter.pattern.slice(1))) {\n      if (level >= filter.level) {\n        return false;\n      }\n    }\n  } else {\n    // Include.\n    if (filter.pattern?.length) {\n      if (path?.includes(filter.pattern)) {\n        return level >= filter.level;\n      }\n    } else {\n      if (level >= filter.level) {\n        return true;\n      }\n    }\n  }\n};\n\n/**\n * Determines if the current line should be logged (called by the processor).\n */\nexport const shouldLog = (entry: LogEntry, filters?: LogFilter[]): boolean => {\n  if (filters === undefined) {\n    return false;\n  }\n\n  const results = filters\n    .map((filter) => matchFilter(filter, entry.level, entry.meta?.F))\n    .filter((result): result is boolean => result !== undefined);\n\n  // Skip if any are explicitely false.\n  // console.log({ level: entry.level, path: entry.meta?.F }, filters, results, results.length);\n  return results.length > 0 && !results.some((results) => results === false);\n};\n\nexport const getContextFromEntry = (entry: LogEntry): Record<string, any> | undefined => {\n  let context;\n  if (entry.meta) {\n    const scopeInfo = gatherLogInfoFromScope(entry.meta.S);\n    if (Object.keys(scopeInfo).length > 0) {\n      context = Object.assign(context ?? {}, scopeInfo);\n    }\n  }\n\n  const entryContext = typeof entry.context === 'function' ? entry.context() : entry.context;\n  if (entryContext) {\n    if (entryContext instanceof Error) {\n      // Additional context from Error.\n      const c = (entryContext as any).context;\n      // If ERROR then show stacktrace.\n      context = Object.assign(context ?? {}, { error: entryContext.stack, ...c });\n    } else if (typeof entryContext === 'object') {\n      context = Object.assign(context ?? {}, entryContext);\n    }\n  }\n\n  if (entry.error) {\n    context = Object.assign(context ?? {}, { error: entry.error });\n  }\n\n  return context && Object.keys(context).length > 0 ? context : undefined;\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nexport const getRelativeFilename = (filename: string) => {\n  // TODO(burdon): Hack uses \"packages\" as an anchor (pre-parse NX?)\n  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.\n  const match = filename.match(/.+\\/(packages\\/.+\\/.+)/);\n  if (match) {\n    const [, filePath] = match;\n    return filePath;\n  }\n\n  return filename;\n};\n"],
-  "mappings": ";AAWO,IAAKA,WAAAA,0BAAAA,WAAAA;;;;;;;SAAAA;;AASL,IAAMC,SAAmC;EAC9C,KAAG;EACHC,OAAK;EACLC,OAAK;EACLC,SAAO;EACPC,MAAI;EACJC,MAAI;EACJC,OAAK;AACP;AAEO,IAAMC,iBAAiB;EAC5B,CAAA,CAAA,GAAkB;EAClB,CAAA,EAAA,GAAkB;EAClB,CAAA,EAAA,GAAoB;EACpB,CAAA,EAAA,GAAiB;EACjB,CAAA,EAAA,GAAiB;EACjB,CAAA,EAAA,GAAkB;AACpB;AAEO,IAAKC,mBAAAA,0BAAAA,mBAAAA;;;;SAAAA;;;;ACnCZ,IAAMC,oBAAoBC,OAAO,mBAAA;AAc1B,IAAMC,UAAU,CAACC,QAAaC,aAAqBC,eAAAA;AAEvDF,GAAAA,OAAOH,iBAAAA,MAAuB,CAAA,GAAIM,KAAKF,WAAAA;AAC1C;AAMO,IAAMG,yBAAyB,CAACC,UAAAA;AACrC,MAAI,CAACA,OAAO;AACV,WAAO,CAAC;EACV;AAEA,QAAMC,MAA2B,CAAC;AAElC,QAAMC,YAAYC,OAAOC,eAAeJ,KAAAA;AACxC,QAAMK,aAAa,OAAOH,cAAc,YAAYA,cAAc,OAAOA,UAAUV,iBAAAA,IAAqB,CAAA,MAAO,CAAA;AAC/G,aAAWc,QAAQD,WAAW;AAC5B,QAAI;AACFJ,UAAIK,IAAAA,IAAQ,OAAON,MAAMM,IAAAA,MAAU,aAAaN,MAAMM,IAAAA,EAAK,IAAKN,MAAMM,IAAAA;IACxE,SAASC,KAAU;AACjBN,UAAIK,IAAAA,IAAQC,IAAIC;IAClB;EACF;AAEA,SAAOP;AACT;;;ACVA,IAAMQ,cAAc,CAACC,QAAmBC,OAAiBC,SAAAA;AAEvD,MAAIF,OAAOG,SAASC,WAAW,GAAA,GAAM;AAEnC,QAAIF,MAAMG,SAASL,OAAOG,QAAQG,MAAM,CAAA,CAAA,GAAK;AAC3C,UAAIL,SAASD,OAAOC,OAAO;AACzB,eAAO;MACT;IACF;EACF,OAAO;AAEL,QAAID,OAAOG,SAASI,QAAQ;AAC1B,UAAIL,MAAMG,SAASL,OAAOG,OAAO,GAAG;AAClC,eAAOF,SAASD,OAAOC;MACzB;IACF,OAAO;AACL,UAAIA,SAASD,OAAOC,OAAO;AACzB,eAAO;MACT;IACF;EACF;AACF;AAKO,IAAMO,YAAY,CAACC,OAAiBC,YAAAA;AACzC,MAAIA,YAAYC,QAAW;AACzB,WAAO;EACT;AAEA,QAAMC,UAAUF,QACbG,IAAI,CAACb,WAAWD,YAAYC,QAAQS,MAAMR,OAAOQ,MAAMK,MAAMC,CAAAA,CAAAA,EAC7Df,OAAO,CAACgB,WAA8BA,WAAWL,MAAAA;AAIpD,SAAOC,QAAQL,SAAS,KAAK,CAACK,QAAQK,KAAK,CAACL,aAAYA,aAAY,KAAA;AACtE;AAEO,IAAMM,sBAAsB,CAACT,UAAAA;AAClC,MAAIU;AACJ,MAAIV,MAAMK,MAAM;AACd,UAAMM,YAAYC,uBAAuBZ,MAAMK,KAAKQ,CAAC;AACrD,QAAIC,OAAOC,KAAKJ,SAAAA,EAAWb,SAAS,GAAG;AACrCY,gBAAUI,OAAOE,OAAON,WAAW,CAAC,GAAGC,SAAAA;IACzC;EACF;AAEA,QAAMM,eAAe,OAAOjB,MAAMU,YAAY,aAAaV,MAAMU,QAAO,IAAKV,MAAMU;AACnF,MAAIO,cAAc;AAChB,QAAIA,wBAAwBC,OAAO;AAEjC,YAAMC,IAAKF,aAAqBP;AAEhCA,gBAAUI,OAAOE,OAAON,WAAW,CAAC,GAAG;QAAEU,OAAOH,aAAaI;QAAO,GAAGF;MAAE,CAAA;IAC3E,WAAW,OAAOF,iBAAiB,UAAU;AAC3CP,gBAAUI,OAAOE,OAAON,WAAW,CAAC,GAAGO,YAAAA;IACzC;EACF;AAEA,MAAIjB,MAAMoB,OAAO;AACfV,cAAUI,OAAOE,OAAON,WAAW,CAAC,GAAG;MAAEU,OAAOpB,MAAMoB;IAAM,CAAA;EAC9D;AAEA,SAAOV,WAAWI,OAAOC,KAAKL,OAAAA,EAASZ,SAAS,IAAIY,UAAUR;AAChE;;;ACjGO,IAAMoB,sBAAsB,CAACC,aAAAA;AAGlC,QAAMC,QAAQD,SAASC,MAAM,wBAAA;AAC7B,MAAIA,OAAO;AACT,UAAM,CAAA,EAAGC,QAAAA,IAAYD;AACrB,WAAOC;EACT;AAEA,SAAOF;AACT;",
-  "names": ["LogLevel", "levels", "trace", "debug", "verbose", "info", "warn", "error", "shortLevelName", "LogProcessorType", "logInfoProperties", "Symbol", "logInfo", "target", "propertyKey", "descriptor", "push", "gatherLogInfoFromScope", "scope", "res", "prototype", "Object", "getPrototypeOf", "infoProps", "prop", "err", "message", "matchFilter", "filter", "level", "path", "pattern", "startsWith", "includes", "slice", "length", "shouldLog", "entry", "filters", "undefined", "results", "map", "meta", "F", "result", "some", "getContextFromEntry", "context", "scopeInfo", "gatherLogInfoFromScope", "S", "Object", "keys", "assign", "entryContext", "Error", "c", "error", "stack", "getRelativeFilename", "filename", "match", "filePath"]
-}

package/dist/lib/node-esm/chunk-QPYJZ4SO.mjs

@@ -1,135 +0,0 @@
-import { createRequire } from 'node:module';const require = createRequire(import.meta.url);
-
-// src/config.ts
-var LogLevel = /* @__PURE__ */ (function(LogLevel2) {
-  LogLevel2[LogLevel2["TRACE"] = 5] = "TRACE";
-  LogLevel2[LogLevel2["DEBUG"] = 10] = "DEBUG";
-  LogLevel2[LogLevel2["VERBOSE"] = 11] = "VERBOSE";
-  LogLevel2[LogLevel2["INFO"] = 12] = "INFO";
-  LogLevel2[LogLevel2["WARN"] = 13] = "WARN";
-  LogLevel2[LogLevel2["ERROR"] = 14] = "ERROR";
-  return LogLevel2;
-})({});
-var levels = {
-  "*": 5,
-  trace: 5,
-  debug: 10,
-  verbose: 11,
-  info: 12,
-  warn: 13,
-  error: 14
-};
-var shortLevelName = {
-  [5]: "T",
-  [10]: "D",
-  [11]: "V",
-  [12]: "I",
-  [13]: "W",
-  [14]: "E"
-};
-var LogProcessorType = /* @__PURE__ */ (function(LogProcessorType2) {
-  LogProcessorType2["CONSOLE"] = "console";
-  LogProcessorType2["BROWSER"] = "browser";
-  LogProcessorType2["DEBUG"] = "debug";
-  return LogProcessorType2;
-})({});
-
-// src/scope.ts
-var logInfoProperties = Symbol("logInfoProperties");
-var logInfo = (target, propertyKey, descriptor) => {
-  (target[logInfoProperties] ??= []).push(propertyKey);
-};
-var gatherLogInfoFromScope = (scope) => {
-  if (!scope) {
-    return {};
-  }
-  const res = {};
-  const prototype = Object.getPrototypeOf(scope);
-  const infoProps = (typeof prototype === "object" && prototype !== null ? prototype[logInfoProperties] : []) ?? [];
-  for (const prop of infoProps) {
-    try {
-      res[prop] = typeof scope[prop] === "function" ? scope[prop]() : scope[prop];
-    } catch (err) {
-      res[prop] = err.message;
-    }
-  }
-  return res;
-};
-
-// src/context.ts
-var matchFilter = (filter, level, path) => {
-  if (filter.pattern?.startsWith("-")) {
-    if (path?.includes(filter.pattern.slice(1))) {
-      if (level >= filter.level) {
-        return false;
-      }
-    }
-  } else {
-    if (filter.pattern?.length) {
-      if (path?.includes(filter.pattern)) {
-        return level >= filter.level;
-      }
-    } else {
-      if (level >= filter.level) {
-        return true;
-      }
-    }
-  }
-};
-var shouldLog = (entry, filters) => {
-  if (filters === void 0) {
-    return false;
-  }
-  const results = filters.map((filter) => matchFilter(filter, entry.level, entry.meta?.F)).filter((result) => result !== void 0);
-  return results.length > 0 && !results.some((results2) => results2 === false);
-};
-var getContextFromEntry = (entry) => {
-  let context;
-  if (entry.meta) {
-    const scopeInfo = gatherLogInfoFromScope(entry.meta.S);
-    if (Object.keys(scopeInfo).length > 0) {
-      context = Object.assign(context ?? {}, scopeInfo);
-    }
-  }
-  const entryContext = typeof entry.context === "function" ? entry.context() : entry.context;
-  if (entryContext) {
-    if (entryContext instanceof Error) {
-      const c = entryContext.context;
-      context = Object.assign(context ?? {}, {
-        error: entryContext.stack,
-        ...c
-      });
-    } else if (typeof entryContext === "object") {
-      context = Object.assign(context ?? {}, entryContext);
-    }
-  }
-  if (entry.error) {
-    context = Object.assign(context ?? {}, {
-      error: entry.error
-    });
-  }
-  return context && Object.keys(context).length > 0 ? context : void 0;
-};
-
-// src/processors/common.ts
-var getRelativeFilename = (filename) => {
-  const match = filename.match(/.+\/(packages\/.+\/.+)/);
-  if (match) {
-    const [, filePath] = match;
-    return filePath;
-  }
-  return filename;
-};
-
-export {
-  LogLevel,
-  levels,
-  shortLevelName,
-  LogProcessorType,
-  logInfo,
-  gatherLogInfoFromScope,
-  shouldLog,
-  getContextFromEntry,
-  getRelativeFilename
-};
-//# sourceMappingURL=chunk-QPYJZ4SO.mjs.map

package/dist/lib/node-esm/chunk-QPYJZ4SO.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/config.ts", "../../../src/scope.ts", "../../../src/context.ts", "../../../src/processors/common.ts"],
-  "sourcesContent": ["//\n// Copyright 2022 DXOS.org\n//\n\nimport { type LogProcessor } from './context';\n\n/**\n * Standard levels.\n * NOTE: Keep aligned with LogLevel in @dxos/protocols.\n */\n// TODO(burdon): Update numbers?\nexport enum LogLevel {\n  TRACE = 5,\n  DEBUG = 10,\n  VERBOSE = 11,\n  INFO = 12,\n  WARN = 13,\n  ERROR = 14,\n}\n\nexport const levels: Record<string, LogLevel> = {\n  '*': LogLevel.TRACE,\n  trace: LogLevel.TRACE,\n  debug: LogLevel.DEBUG,\n  verbose: LogLevel.VERBOSE,\n  info: LogLevel.INFO,\n  warn: LogLevel.WARN,\n  error: LogLevel.ERROR,\n};\n\nexport const shortLevelName = {\n  [LogLevel.TRACE]: 'T',\n  [LogLevel.DEBUG]: 'D',\n  [LogLevel.VERBOSE]: 'V',\n  [LogLevel.INFO]: 'I',\n  [LogLevel.WARN]: 'W',\n  [LogLevel.ERROR]: 'E',\n};\n\nexport enum LogProcessorType {\n  CONSOLE = 'console',\n  BROWSER = 'browser',\n  DEBUG = 'debug',\n}\n\n/**\n * Individual filter condition.\n */\nexport type LogFilter = {\n  level: LogLevel;\n  pattern?: string;\n};\n\n/**\n * Options to set inline or load from the YML file.\n */\nexport type LogOptions = {\n  file?: string;\n  filter?: string | string[] | LogLevel;\n  captureFilter?: string | string[] | LogLevel;\n  depth?: number; // Context object depth.\n  processor?: string | LogProcessorType;\n  formatter?: {\n    column: number;\n    timestamp: boolean;\n    timestampFirst: boolean;\n  };\n  prefix?: string;\n};\n\n/**\n * Runtime config.\n */\nexport interface LogConfig {\n  options: LogOptions;\n  filters?: LogFilter[];\n  captureFilters?: LogFilter[];\n  processors: LogProcessor[];\n  prefix?: string;\n}\n", "//\n// Copyright 2022 DXOS.org\n//\n\nconst logInfoProperties = Symbol('logInfoProperties');\n\n/**\n * Decorate fields, properties, or methods to automatically include their values in log messages.\n *\n * Example:\n *\n * ```typescript\n * class Example {\n *   @logInfo\n *   peerId: PublicKey;\n * }\n * ```\n */\nexport const logInfo = (target: any, propertyKey: string, descriptor?: PropertyDescriptor) => {\n  // console.log(target, propertyKey, descriptor);\n  (target[logInfoProperties] ??= []).push(propertyKey);\n};\n\n/**\n * Introspects class instance to find decorated metadata.\n * @param scope Class instance.\n */\nexport const gatherLogInfoFromScope = (scope: any): Record<string, any> => {\n  if (!scope) {\n    return {};\n  }\n\n  const res: Record<string, any> = {};\n\n  const prototype = Object.getPrototypeOf(scope);\n  const infoProps = (typeof prototype === 'object' && prototype !== null ? prototype[logInfoProperties] : []) ?? [];\n  for (const prop of infoProps) {\n    try {\n      res[prop] = typeof scope[prop] === 'function' ? scope[prop]() : scope[prop];\n    } catch (err: any) {\n      res[prop] = err.message;\n    }\n  }\n\n  return res;\n};\n", "//\n// Copyright 2022 DXOS.org\n//\n\nimport { type LogConfig, type LogFilter, type LogLevel } from './config';\nimport { type CallMetadata } from './meta';\nimport { gatherLogInfoFromScope } from './scope';\n\n/**\n * Optional object passed to the logging API.\n */\nexport type LogContext = Record<string, any> | Error | any;\n\n/**\n * Record for current log line.\n */\nexport interface LogEntry {\n  level: LogLevel;\n  message?: string;\n  context?: LogContext;\n  meta?: CallMetadata;\n  error?: Error;\n}\n\n/**\n * Processes (e.g., prints, forwards) log entries.\n */\nexport type LogProcessor = (config: LogConfig, entry: LogEntry) => void;\n\n/**\n * Returns:\n * true if the log entry matches the filter,\n * false if should be excluded, or\n * undefined if it the filter doesn't match the level.\n */\nconst matchFilter = (filter: LogFilter, level: LogLevel, path?: string): boolean | undefined => {\n  // TODO(burdon): Support regexp.\n  if (filter.pattern?.startsWith('-')) {\n    // Exclude.\n    if (path?.includes(filter.pattern.slice(1))) {\n      if (level >= filter.level) {\n        return false;\n      }\n    }\n  } else {\n    // Include.\n    if (filter.pattern?.length) {\n      if (path?.includes(filter.pattern)) {\n        return level >= filter.level;\n      }\n    } else {\n      if (level >= filter.level) {\n        return true;\n      }\n    }\n  }\n};\n\n/**\n * Determines if the current line should be logged (called by the processor).\n */\nexport const shouldLog = (entry: LogEntry, filters?: LogFilter[]): boolean => {\n  if (filters === undefined) {\n    return false;\n  }\n\n  const results = filters\n    .map((filter) => matchFilter(filter, entry.level, entry.meta?.F))\n    .filter((result): result is boolean => result !== undefined);\n\n  // Skip if any are explicitely false.\n  // console.log({ level: entry.level, path: entry.meta?.F }, filters, results, results.length);\n  return results.length > 0 && !results.some((results) => results === false);\n};\n\nexport const getContextFromEntry = (entry: LogEntry): Record<string, any> | undefined => {\n  let context;\n  if (entry.meta) {\n    const scopeInfo = gatherLogInfoFromScope(entry.meta.S);\n    if (Object.keys(scopeInfo).length > 0) {\n      context = Object.assign(context ?? {}, scopeInfo);\n    }\n  }\n\n  const entryContext = typeof entry.context === 'function' ? entry.context() : entry.context;\n  if (entryContext) {\n    if (entryContext instanceof Error) {\n      // Additional context from Error.\n      const c = (entryContext as any).context;\n      // If ERROR then show stacktrace.\n      context = Object.assign(context ?? {}, { error: entryContext.stack, ...c });\n    } else if (typeof entryContext === 'object') {\n      context = Object.assign(context ?? {}, entryContext);\n    }\n  }\n\n  if (entry.error) {\n    context = Object.assign(context ?? {}, { error: entry.error });\n  }\n\n  return context && Object.keys(context).length > 0 ? context : undefined;\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nexport const getRelativeFilename = (filename: string) => {\n  // TODO(burdon): Hack uses \"packages\" as an anchor (pre-parse NX?)\n  // Including `packages/` part of the path so that excluded paths (e.g. from dist) are clickable in vscode.\n  const match = filename.match(/.+\\/(packages\\/.+\\/.+)/);\n  if (match) {\n    const [, filePath] = match;\n    return filePath;\n  }\n\n  return filename;\n};\n"],
-  "mappings": ";;;AAWO,IAAKA,WAAAA,0BAAAA,WAAAA;;;;;;;SAAAA;;AASL,IAAMC,SAAmC;EAC9C,KAAG;EACHC,OAAK;EACLC,OAAK;EACLC,SAAO;EACPC,MAAI;EACJC,MAAI;EACJC,OAAK;AACP;AAEO,IAAMC,iBAAiB;EAC5B,CAAA,CAAA,GAAkB;EAClB,CAAA,EAAA,GAAkB;EAClB,CAAA,EAAA,GAAoB;EACpB,CAAA,EAAA,GAAiB;EACjB,CAAA,EAAA,GAAiB;EACjB,CAAA,EAAA,GAAkB;AACpB;AAEO,IAAKC,mBAAAA,0BAAAA,mBAAAA;;;;SAAAA;;;;ACnCZ,IAAMC,oBAAoBC,OAAO,mBAAA;AAc1B,IAAMC,UAAU,CAACC,QAAaC,aAAqBC,eAAAA;AAEvDF,GAAAA,OAAOH,iBAAAA,MAAuB,CAAA,GAAIM,KAAKF,WAAAA;AAC1C;AAMO,IAAMG,yBAAyB,CAACC,UAAAA;AACrC,MAAI,CAACA,OAAO;AACV,WAAO,CAAC;EACV;AAEA,QAAMC,MAA2B,CAAC;AAElC,QAAMC,YAAYC,OAAOC,eAAeJ,KAAAA;AACxC,QAAMK,aAAa,OAAOH,cAAc,YAAYA,cAAc,OAAOA,UAAUV,iBAAAA,IAAqB,CAAA,MAAO,CAAA;AAC/G,aAAWc,QAAQD,WAAW;AAC5B,QAAI;AACFJ,UAAIK,IAAAA,IAAQ,OAAON,MAAMM,IAAAA,MAAU,aAAaN,MAAMM,IAAAA,EAAK,IAAKN,MAAMM,IAAAA;IACxE,SAASC,KAAU;AACjBN,UAAIK,IAAAA,IAAQC,IAAIC;IAClB;EACF;AAEA,SAAOP;AACT;;;ACVA,IAAMQ,cAAc,CAACC,QAAmBC,OAAiBC,SAAAA;AAEvD,MAAIF,OAAOG,SAASC,WAAW,GAAA,GAAM;AAEnC,QAAIF,MAAMG,SAASL,OAAOG,QAAQG,MAAM,CAAA,CAAA,GAAK;AAC3C,UAAIL,SAASD,OAAOC,OAAO;AACzB,eAAO;MACT;IACF;EACF,OAAO;AAEL,QAAID,OAAOG,SAASI,QAAQ;AAC1B,UAAIL,MAAMG,SAASL,OAAOG,OAAO,GAAG;AAClC,eAAOF,SAASD,OAAOC;MACzB;IACF,OAAO;AACL,UAAIA,SAASD,OAAOC,OAAO;AACzB,eAAO;MACT;IACF;EACF;AACF;AAKO,IAAMO,YAAY,CAACC,OAAiBC,YAAAA;AACzC,MAAIA,YAAYC,QAAW;AACzB,WAAO;EACT;AAEA,QAAMC,UAAUF,QACbG,IAAI,CAACb,WAAWD,YAAYC,QAAQS,MAAMR,OAAOQ,MAAMK,MAAMC,CAAAA,CAAAA,EAC7Df,OAAO,CAACgB,WAA8BA,WAAWL,MAAAA;AAIpD,SAAOC,QAAQL,SAAS,KAAK,CAACK,QAAQK,KAAK,CAACL,aAAYA,aAAY,KAAA;AACtE;AAEO,IAAMM,sBAAsB,CAACT,UAAAA;AAClC,MAAIU;AACJ,MAAIV,MAAMK,MAAM;AACd,UAAMM,YAAYC,uBAAuBZ,MAAMK,KAAKQ,CAAC;AACrD,QAAIC,OAAOC,KAAKJ,SAAAA,EAAWb,SAAS,GAAG;AACrCY,gBAAUI,OAAOE,OAAON,WAAW,CAAC,GAAGC,SAAAA;IACzC;EACF;AAEA,QAAMM,eAAe,OAAOjB,MAAMU,YAAY,aAAaV,MAAMU,QAAO,IAAKV,MAAMU;AACnF,MAAIO,cAAc;AAChB,QAAIA,wBAAwBC,OAAO;AAEjC,YAAMC,IAAKF,aAAqBP;AAEhCA,gBAAUI,OAAOE,OAAON,WAAW,CAAC,GAAG;QAAEU,OAAOH,aAAaI;QAAO,GAAGF;MAAE,CAAA;IAC3E,WAAW,OAAOF,iBAAiB,UAAU;AAC3CP,gBAAUI,OAAOE,OAAON,WAAW,CAAC,GAAGO,YAAAA;IACzC;EACF;AAEA,MAAIjB,MAAMoB,OAAO;AACfV,cAAUI,OAAOE,OAAON,WAAW,CAAC,GAAG;MAAEU,OAAOpB,MAAMoB;IAAM,CAAA;EAC9D;AAEA,SAAOV,WAAWI,OAAOC,KAAKL,OAAAA,EAASZ,SAAS,IAAIY,UAAUR;AAChE;;;ACjGO,IAAMoB,sBAAsB,CAACC,aAAAA;AAGlC,QAAMC,QAAQD,SAASC,MAAM,wBAAA;AAC7B,MAAIA,OAAO;AACT,UAAM,CAAA,EAAGC,QAAAA,IAAYD;AACrB,WAAOC;EACT;AAEA,SAAOF;AACT;",
-  "names": ["LogLevel", "levels", "trace", "debug", "verbose", "info", "warn", "error", "shortLevelName", "LogProcessorType", "logInfoProperties", "Symbol", "logInfo", "target", "propertyKey", "descriptor", "push", "gatherLogInfoFromScope", "scope", "res", "prototype", "Object", "getPrototypeOf", "infoProps", "prop", "err", "message", "matchFilter", "filter", "level", "path", "pattern", "startsWith", "includes", "slice", "length", "shouldLog", "entry", "filters", "undefined", "results", "map", "meta", "F", "result", "some", "getContextFromEntry", "context", "scopeInfo", "gatherLogInfoFromScope", "S", "Object", "keys", "assign", "entryContext", "Error", "c", "error", "stack", "getRelativeFilename", "filename", "match", "filePath"]
-}