@darksheep/logger 1.3.0 → 1.4.0

package/types/utilities/legacy-secrets.d.ts

@@ -0,0 +1,33 @@
+export type Filters = {
+    allowed: RegExp[];
+    blocked: RegExp[];
+};
+/**
+ * @typedef {{ allowed: RegExp[], blocked: RegExp[] }} Filters
+ */
+/**
+ * Resolves the redact and remove filters, mapping the legacy `LOG_SECRETS`
+ * control onto them when the split vars are not set.
+ *
+ * In `LOG_SECRETS` a bare pattern obscured (redacted) the value and a
+ * `-`-prefixed pattern removed the key -- which is exactly the `allowed` /
+ * `blocked` split that `parseFilters` already produces. So the legacy
+ * `allowed` patterns become the redact set and the legacy `blocked` patterns
+ * become the remove set (neither carried exemptions). Whenever the matching
+ * split var is set it wins and the legacy value is ignored for that half.
+ *
+ * @param {{
+ *   secrets?: string | undefined;
+ *   redact?: string | undefined;
+ *   remove?: string | undefined;
+ * }} options - The raw environment values.
+ * @returns {{ redactFilters: Filters, removeFilters: Filters }}
+ */
+export declare function resolveSecretFilters({ secrets, redact, remove }: {
+    secrets?: string | undefined;
+    redact?: string | undefined;
+    remove?: string | undefined;
+}): {
+    redactFilters: Filters;
+    removeFilters: Filters;
+};

package/types/utilities/log-filters.d.ts

@@ -3,10 +3,10 @@
  * @param {import('./log-types.js').LogLevel} level - The log level to check.
  * @returns {boolean}
  */
-export function checkLogLevel(level: import("./log-types.js").LogLevel): boolean;
+export declare function checkLogLevel(level: import('./log-types.js').LogLevel): boolean;
 /**
  * Check to see if a message with {channel} should get logged.
  * @param {string} [channel] - The channel to check.
  * @returns {boolean}
  */
-export function checkLogFilters(channel?: string): boolean;
+export declare function checkLogFilters(channel?: string): boolean;

package/types/utilities/log-types.d.ts

@@ -39,14 +39,14 @@ export type LogLevels = {
  * @property {6} silly - Information to help resolve complex logic issues.
  */
 /** @type {LogLevels} */
-export const LogLevels: LogLevels;
-export const LogNames: {
+export declare const LogLevels: LogLevels;
+export declare const LogNames: {
     [k: string]: string;
 };
 export type LogLevelNames = keyof LogLevels;
 export type LogLevel = LogLevels[LogLevelNames];
-export type Callsite = import("./stacktrace.js").Callsite;
-export type NormalisedError = import("../replacers/error.js").NormalisedError;
+export type Callsite = import('./stacktrace.js').Callsite;
+export type NormalisedError = import('../replacers/error.js').NormalisedError;
 export type LogInternal = {
     /**
      * - A timestamp for the log message.
@@ -82,3 +82,29 @@ export type LogEntry = {
     level: LogLevel;
     message: string;
 } & LogInternal & Record<string, unknown>;
+/**
+ * @typedef {keyof LogLevels} LogLevelNames
+ */
+/**
+ * @typedef {LogLevels[LogLevelNames]} LogLevel
+ */
+/**
+ * @typedef {import('./stacktrace.js').Callsite} Callsite
+ */
+/**
+ * @typedef {import('../replacers/error.js').NormalisedError} NormalisedError
+ */
+/**
+ * @typedef {Object} LogInternal
+ * @property {Date} [timestamp] - A timestamp for the log message.
+ * @property {string} [channel] - A channel to bind to the log.
+ * @property {LogLevel} [level] - The log level.
+ * @property {string} [message] - A message to use.
+ * @property {string | Callsite[]} [stack] - The stack trace bound to the log.
+ * @property {NormalisedError | Error} [cause] - A child error for the core error.
+ * @property {string} [trail] - The trail id bound to the callsite.
+ */
+/**
+ * @typedef {LogInternal & Record<string, unknown>} LogContext
+ * @typedef {{ level: LogLevel, message: string } & LogInternal & Record<string, unknown>} LogEntry
+ */

package/types/utilities/parse-filters.d.ts

@@ -3,7 +3,7 @@
  * @param {RegExp[]} [fallback] - Fallback to the following allowed regexp.
  * @returns {{ allowed: RegExp[], blocked: RegExp[] }}
  */
-export function parseFilters(filter?: string, fallback?: RegExp[]): {
+export declare function parseFilters(filter?: string, fallback?: RegExp[]): {
     allowed: RegExp[];
     blocked: RegExp[];
 };

package/types/utilities/parse-log-level.d.ts

@@ -1,7 +1,11 @@
+/**
+ * @import { LogLevel } from './log-types.js';
+ */
+import type { LogLevel } from './log-types.js';
 /**
  * Convert a given string to a LogLevel.
  * @param {string} [input] - The string to convert.
  * @param {string} [node] - The current NODE_ENV.
- * @returns {import('./log-types.js').LogLevel}
+ * @returns {LogLevel}
  */
-export function parseLogLevel(input?: string, node?: string): import("./log-types.js").LogLevel;
+export declare function parseLogLevel(input?: string, node?: string): LogLevel;

package/types/utilities/resource-usage.d.ts

@@ -2,9 +2,9 @@
  * Get the current memory consumption.
  * @returns {NodeJS.MemoryUsage}
  */
-export function getMemoryUsage(): NodeJS.MemoryUsage;
+export declare function getMemoryUsage(): NodeJS.MemoryUsage;
 /**
  * Get the callsite that we think is outside the package.
  * @returns {Record<'elapsed'|'total'|'system'|'user', number> | void}
  */
-export function getCPUUsage(): Record<"elapsed" | "total" | "system" | "user", number> | void;
+export declare function getCPUUsage(): Record<'elapsed' | 'total' | 'system' | 'user', number> | void;

package/types/utilities/stacktrace.d.ts

@@ -1,18 +1,3 @@
-/**
- * @typedef {Object} Callsite
- * @property {string} file - The file name for the callsite.
- * @property {string} [relativePath] - The relative path for the callsite.file.
- * @property {string} [absolutePath] - The absolute path for the callsite.file.
- * @property {string} methodName - The methodName from the callsite.
- * @property {number} line - The line number in the file.
- * @property {number} column - The column number in the file.
- */
-/**
- * Get the callsite that we think is outside the package.
- * @param {string} [stack] - The stacktrace to parse.
- * @returns {Callsite[]}
- */
-export function parseStack(stack?: string): Callsite[];
 export type Callsite = {
     /**
      * - The file name for the callsite.
@@ -39,3 +24,18 @@ export type Callsite = {
      */
     column: number;
 };
+/**
+ * @typedef {Object} Callsite
+ * @property {string} file - The file name for the callsite.
+ * @property {string} [relativePath] - The relative path for the callsite.file.
+ * @property {string} [absolutePath] - The absolute path for the callsite.file.
+ * @property {string} methodName - The methodName from the callsite.
+ * @property {number} line - The line number in the file.
+ * @property {number} column - The column number in the file.
+ */
+/**
+ * Get the callsite that we think is outside the package.
+ * @param {string} [stack] - The stacktrace to parse.
+ * @returns {Callsite[]}
+ */
+export declare function parseStack(stack?: string): Callsite[];