@geekmidas/logger 10.0.0-alpha.99 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/CHANGELOG.md +48 -0
  2. package/dist/console.cjs +25 -24
  3. package/dist/console.cjs.map +1 -1
  4. package/dist/console.d.cts +7 -4
  5. package/dist/console.d.cts.map +1 -1
  6. package/dist/console.d.mts +7 -4
  7. package/dist/console.d.mts.map +1 -1
  8. package/dist/console.mjs +25 -23
  9. package/dist/console.mjs.map +1 -1
  10. package/dist/index.cjs +3 -3
  11. package/dist/index.d.cts +2 -2
  12. package/dist/index.d.mts +2 -2
  13. package/dist/index.mjs +3 -2
  14. package/dist/pino.cjs +39 -67
  15. package/dist/pino.cjs.map +1 -1
  16. package/dist/pino.d.cts +12 -9
  17. package/dist/pino.d.cts.map +1 -1
  18. package/dist/pino.d.mts +12 -9
  19. package/dist/pino.d.mts.map +1 -1
  20. package/dist/pino.mjs +16 -66
  21. package/dist/pino.mjs.map +1 -1
  22. package/dist/redact-paths-CsK0_uz-.d.cts +19 -0
  23. package/dist/redact-paths-CsK0_uz-.d.cts.map +1 -0
  24. package/dist/redact-paths-D07eTMlH.d.mts +19 -0
  25. package/dist/redact-paths-D07eTMlH.d.mts.map +1 -0
  26. package/dist/redact-paths-D0m0DIuQ.cjs +73 -0
  27. package/dist/redact-paths-D0m0DIuQ.cjs.map +1 -0
  28. package/dist/redact-paths-DQoIXhkS.mjs +67 -0
  29. package/dist/redact-paths-DQoIXhkS.mjs.map +1 -0
  30. package/dist/redact-paths.cjs +2 -116
  31. package/dist/redact-paths.d.cts +2 -31
  32. package/dist/redact-paths.d.mts +2 -31
  33. package/dist/redact-paths.mjs +2 -113
  34. package/dist/types-BDdpcrpy.d.mts +166 -0
  35. package/dist/types-BDdpcrpy.d.mts.map +1 -0
  36. package/dist/types-Dk_k2-f_.d.cts +166 -0
  37. package/dist/types-Dk_k2-f_.d.cts.map +1 -0
  38. package/dist/types-ag_0Cvbg.cjs +38 -0
  39. package/dist/types-ag_0Cvbg.cjs.map +1 -0
  40. package/dist/types-yQ6XOihF.mjs +32 -0
  41. package/dist/types-yQ6XOihF.mjs.map +1 -0
  42. package/dist/types.cjs +2 -32
  43. package/dist/types.d.cts +2 -175
  44. package/dist/types.d.mts +2 -175
  45. package/dist/types.mjs +2 -31
  46. package/package.json +5 -35
  47. package/src/__tests__/console.spec.ts +661 -0
  48. package/src/__tests__/pino-redaction.integration.spec.ts +307 -0
  49. package/src/__tests__/pino.spec.ts +355 -0
  50. package/src/console.ts +165 -0
  51. package/src/index.ts +7 -0
  52. package/src/pino.ts +129 -0
  53. package/src/redact-paths.ts +71 -0
  54. package/src/types.ts +167 -0
  55. package/tsconfig.json +9 -0
  56. package/tsdown.config.ts +3 -0
  57. package/dist/otel.cjs +0 -113
  58. package/dist/otel.cjs.map +0 -1
  59. package/dist/otel.d.cts +0 -31
  60. package/dist/otel.d.cts.map +0 -1
  61. package/dist/otel.d.mts +0 -31
  62. package/dist/otel.d.mts.map +0 -1
  63. package/dist/otel.mjs +0 -110
  64. package/dist/otel.mjs.map +0 -1
  65. package/dist/redact-paths.cjs.map +0 -1
  66. package/dist/redact-paths.d.cts.map +0 -1
  67. package/dist/redact-paths.d.mts.map +0 -1
  68. package/dist/redact-paths.mjs.map +0 -1
  69. package/dist/types.cjs.map +0 -1
  70. package/dist/types.d.cts.map +0 -1
  71. package/dist/types.d.mts.map +0 -1
  72. package/dist/types.mjs.map +0 -1
@@ -1,114 +1,3 @@
1
- //#region src/redact-paths.ts
2
- /**
3
- * Default sensitive field paths for redaction.
4
- *
5
- * These paths are automatically used when `redact: true` is set,
6
- * and merged with custom paths unless `resolution: 'override'` is specified.
7
- *
8
- * Includes:
9
- * - Authentication: password, token, apiKey, authorization, credentials
10
- * - Headers: authorization, cookie, x-api-key, x-auth-token
11
- * - Personal data: ssn, creditCard, cvv, pin
12
- * - Secrets: secret, connectionString, databaseUrl
13
- * - Wildcards: *.password, *.secret, *.token (catches nested fields)
14
- */
15
- const DEFAULT_REDACT_PATHS = [
16
- "password",
17
- "pass",
18
- "passwd",
19
- "secret",
20
- "token",
21
- "accessToken",
22
- "refreshToken",
23
- "idToken",
24
- "apiKey",
25
- "api_key",
26
- "apikey",
27
- "auth",
28
- "authorization",
29
- "credential",
30
- "credentials",
31
- "*.password",
32
- "*.secret",
33
- "*.token",
34
- "*.apiKey",
35
- "*.api_key",
36
- "*.authorization",
37
- "*.accessToken",
38
- "*.refreshToken",
39
- "headers.authorization",
40
- "headers.Authorization",
41
- "headers[\"authorization\"]",
42
- "headers[\"Authorization\"]",
43
- "headers.cookie",
44
- "headers.Cookie",
45
- "headers[\"x-api-key\"]",
46
- "headers[\"X-Api-Key\"]",
47
- "headers[\"x-auth-token\"]",
48
- "headers[\"X-Auth-Token\"]",
49
- "ssn",
50
- "socialSecurityNumber",
51
- "social_security_number",
52
- "creditCard",
53
- "credit_card",
54
- "cardNumber",
55
- "card_number",
56
- "cvv",
57
- "cvc",
58
- "pin",
59
- "connectionString",
60
- "connection_string",
61
- "databaseUrl",
62
- "database_url"
63
- ];
64
- /**
65
- * `scheme://user:password@` — the userinfo of a URL that carries a secret.
66
- * A user with no password (`ssh://git@host`) names nobody's secret and is left
67
- * alone.
68
- */
69
- const URL_CREDENTIALS = /\b([a-z][a-z0-9+.-]*:\/\/)[^\s/?#@:]*:[^\s/?#@]*@/gi;
70
- /**
71
- * Replace the credentials of every URL in `text` with `REDACTED`, so
72
- * `s3://KEY:SECRET@uploads` is logged as `s3://REDACTED@uploads`.
73
- *
74
- * Path redaction cannot catch these: a URL turns up under any field name —
75
- * `url`, `origin`, `endpoint` — or inside a message, and blanking every such
76
- * field would hide the half of it that is useful.
77
- */
78
- function redactUrlCredentials(text) {
79
- return text.replace(URL_CREDENTIALS, "$1REDACTED@");
80
- }
81
- /** Deep enough for a log object; past it, values are logged as they are. */
82
- const MAX_DEPTH = 6;
83
- /**
84
- * A copy of `value` with {@link redactUrlCredentials} applied to every string
85
- * in it. Objects and arrays without such a string are returned as they were.
86
- */
87
- function redactUrlCredentialsIn(value, depth = 0) {
88
- if (typeof value === "string") return redactUrlCredentials(value);
89
- if (depth >= MAX_DEPTH || value === null || typeof value !== "object") return value;
90
- if (Array.isArray(value)) {
91
- let changed = false;
92
- const next = value.map((item) => {
93
- const redacted = redactUrlCredentialsIn(item, depth + 1);
94
- if (redacted !== item) changed = true;
95
- return redacted;
96
- });
97
- return changed ? next : value;
98
- }
99
- const proto = Object.getPrototypeOf(value);
100
- if (proto !== Object.prototype && proto !== null) return value;
101
- let next;
102
- for (const [key, item] of Object.entries(value)) {
103
- const redacted = redactUrlCredentialsIn(item, depth + 1);
104
- if (redacted !== item) {
105
- next ??= { ...value };
106
- next[key] = redacted;
107
- }
108
- }
109
- return next ?? value;
110
- }
111
- //#endregion
112
- export { DEFAULT_REDACT_PATHS, redactUrlCredentials, redactUrlCredentialsIn };
1
+ import { DEFAULT_REDACT_PATHS } from "./redact-paths-DQoIXhkS.mjs";
113
2
 
114
- //# sourceMappingURL=redact-paths.mjs.map
3
+ export { DEFAULT_REDACT_PATHS };
@@ -0,0 +1,166 @@
1
+ //#region src/types.d.ts
2
+ /**
3
+ * Logging function type that supports both structured and simple logging.
4
+ * Can be called with an object for structured logging or just a message string.
5
+ *
6
+ * @example
7
+ * ```typescript
8
+ * // Structured logging with context object
9
+ * logger.info({ userId: 123, action: 'login' }, 'User logged in');
10
+ *
11
+ * // Simple string logging
12
+ * logger.info('Application started');
13
+ * ```
14
+ */
15
+ type LogFn = {
16
+ /** Structured logging with context object, optional message, and additional arguments */
17
+ <T extends object>(obj: T, msg?: string, ...args: any[]): void;
18
+ /** Simple string logging */
19
+ (msg: string): void;
20
+ };
21
+ /**
22
+ * Standard logger interface with multiple log levels and child logger support.
23
+ * Follows common logging patterns with structured logging capabilities.
24
+ *
25
+ * @interface Logger
26
+ */
27
+ interface Logger {
28
+ /** Debug level logging - verbose information for debugging */
29
+ debug: LogFn;
30
+ /** Info level logging - general informational messages */
31
+ info: LogFn;
32
+ /** Warning level logging - potentially harmful situations */
33
+ warn: LogFn;
34
+ /** Error level logging - error events that might still allow the application to continue */
35
+ error: LogFn;
36
+ /** Fatal level logging - severe errors that will likely cause the application to abort */
37
+ fatal: LogFn;
38
+ /** Trace level logging - most detailed information */
39
+ trace: LogFn;
40
+ /**
41
+ * Creates a child logger with additional context.
42
+ * Child loggers inherit parent context and add their own.
43
+ *
44
+ * @param obj - Additional context to include in all child logger calls
45
+ * @returns A new Logger instance with merged context
46
+ */
47
+ child: (obj: object) => Logger;
48
+ }
49
+ /**
50
+ * Console-based logger implementation that outputs to standard console methods.
51
+ * Supports structured logging with automatic timestamp injection and context inheritance.
52
+ *
53
+ * @implements {Logger}
54
+ *
55
+ * @example
56
+ * ```typescript
57
+ * const logger = new ConsoleLogger({ app: 'myApp', version: '1.0.0' });
58
+ * logger.info({ userId: 123 }, 'User action performed');
59
+ * // Output: { app: 'myApp', version: '1.0.0', userId: 123, ts: 1234567890 } User action performed
60
+ *
61
+ * const childLogger = logger.child({ module: 'auth' });
62
+ * childLogger.debug({ action: 'validate' }, 'Validating token');
63
+ * // Output: { app: 'myApp', version: '1.0.0', module: 'auth', action: 'validate', ts: 1234567891 } Validating token
64
+ * ```
65
+ */
66
+ declare enum LogLevel {
67
+ Trace = "trace",
68
+ Debug = "debug",
69
+ Info = "info",
70
+ Warn = "warn",
71
+ Error = "error",
72
+ Fatal = "fatal",
73
+ Silent = "silent",
74
+ }
75
+ /**
76
+ * Redaction configuration for masking sensitive data in logs.
77
+ * Uses pino's fast-redact library under the hood.
78
+ *
79
+ * By default, custom paths are merged with the default sensitive paths.
80
+ * Use `resolution: 'override'` to use only your custom paths.
81
+ *
82
+ * @example
83
+ * ```typescript
84
+ * // Simple path array (merges with defaults)
85
+ * redact: ['user.ssn', 'custom.field']
86
+ *
87
+ * // Override defaults completely
88
+ * redact: {
89
+ * paths: ['only.these.paths'],
90
+ * resolution: 'override',
91
+ * }
92
+ *
93
+ * // With custom censor
94
+ * redact: {
95
+ * paths: ['extra.secret'],
96
+ * censor: '***',
97
+ * }
98
+ *
99
+ * // Remove fields entirely
100
+ * redact: {
101
+ * paths: ['temporary.data'],
102
+ * remove: true,
103
+ * }
104
+ * ```
105
+ */
106
+ type RedactOptions = string[] | {
107
+ /** Paths to redact using dot notation or bracket notation for special chars */
108
+ paths: string[];
109
+ /** Custom replacement text (default: '[REDACTED]') */
110
+ censor?: string | ((value: unknown, path: string[]) => unknown);
111
+ /** Remove the field entirely instead of replacing (default: false) */
112
+ remove?: boolean;
113
+ /**
114
+ * How to combine custom paths with default sensitive paths.
115
+ * - 'merge': Custom paths are added to default paths (default)
116
+ * - 'override': Only custom paths are used, defaults are ignored
117
+ */
118
+ resolution?: 'merge' | 'override';
119
+ };
120
+ type CreateLoggerOptions = {
121
+ /** Enable pretty printing with colors (disabled in production) */
122
+ pretty?: boolean;
123
+ /** Minimum log level to output */
124
+ level?: LogLevel;
125
+ /**
126
+ * Redaction configuration for masking sensitive data.
127
+ *
128
+ * - `true`: Uses default sensitive paths (password, token, secret, etc.)
129
+ * - `false` or `undefined`: No redaction applied
130
+ * - `string[]`: Custom paths merged with defaults
131
+ * - `object`: Advanced config with paths, censor, remove, and resolution options
132
+ *
133
+ * By default, custom paths are **merged** with the default sensitive paths.
134
+ * Use `resolution: 'override'` to disable defaults and use only your paths.
135
+ *
136
+ * @example
137
+ * ```typescript
138
+ * // Use defaults only
139
+ * createLogger({ redact: true });
140
+ *
141
+ * // Add custom paths (merged with defaults)
142
+ * createLogger({ redact: ['user.ssn', 'custom.field'] });
143
+ *
144
+ * // Override defaults completely
145
+ * createLogger({
146
+ * redact: {
147
+ * paths: ['only.these.paths'],
148
+ * resolution: 'override',
149
+ * }
150
+ * });
151
+ *
152
+ * // Merge with custom censor
153
+ * createLogger({
154
+ * redact: {
155
+ * paths: ['extra.secret'],
156
+ * censor: '***',
157
+ * }
158
+ * });
159
+ * ```
160
+ */
161
+ redact?: boolean | RedactOptions;
162
+ };
163
+ //# sourceMappingURL=types.d.ts.map
164
+ //#endregion
165
+ export { CreateLoggerOptions, LogFn, LogLevel, Logger, RedactOptions };
166
+ //# sourceMappingURL=types-BDdpcrpy.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types-BDdpcrpy.d.mts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;AAaA;AAaA;;;;;;;;;AAoB+B;AAoB/B;AAyCY,KA9FA,KAAA,GA8Fa;EAiBb;EAAmB,CAAA,UAAA,MAAA,CAAA,CAAA,GAAA,EA7GN,CA6GM,EAAA,GAAA,CAAA,EAAA,MAAA,EAAA,GAAA,IAAA,EAAA,GAAA,EAAA,CAAA,EAAA,IAAA;EAAA;EAId,CAAA,GAqCG,EAAA,MAAA,CAAA,EAAA,IAAA;AAAa,CAAA;;;;;;;UA3IhB,MAAA;;SAET;;QAED;;QAEA;;SAEC;;SAEA;;SAEA;;;;;;;;0BAQiB;;;;;;;;;;;;;;;;;;;aAoBb,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAyCA,aAAA;;;;;;;;;;;;;;KAiBA,mBAAA;;;;UAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAqCW"}
@@ -0,0 +1,166 @@
1
+ //#region src/types.d.ts
2
+ /**
3
+ * Logging function type that supports both structured and simple logging.
4
+ * Can be called with an object for structured logging or just a message string.
5
+ *
6
+ * @example
7
+ * ```typescript
8
+ * // Structured logging with context object
9
+ * logger.info({ userId: 123, action: 'login' }, 'User logged in');
10
+ *
11
+ * // Simple string logging
12
+ * logger.info('Application started');
13
+ * ```
14
+ */
15
+ type LogFn = {
16
+ /** Structured logging with context object, optional message, and additional arguments */
17
+ <T extends object>(obj: T, msg?: string, ...args: any[]): void;
18
+ /** Simple string logging */
19
+ (msg: string): void;
20
+ };
21
+ /**
22
+ * Standard logger interface with multiple log levels and child logger support.
23
+ * Follows common logging patterns with structured logging capabilities.
24
+ *
25
+ * @interface Logger
26
+ */
27
+ interface Logger {
28
+ /** Debug level logging - verbose information for debugging */
29
+ debug: LogFn;
30
+ /** Info level logging - general informational messages */
31
+ info: LogFn;
32
+ /** Warning level logging - potentially harmful situations */
33
+ warn: LogFn;
34
+ /** Error level logging - error events that might still allow the application to continue */
35
+ error: LogFn;
36
+ /** Fatal level logging - severe errors that will likely cause the application to abort */
37
+ fatal: LogFn;
38
+ /** Trace level logging - most detailed information */
39
+ trace: LogFn;
40
+ /**
41
+ * Creates a child logger with additional context.
42
+ * Child loggers inherit parent context and add their own.
43
+ *
44
+ * @param obj - Additional context to include in all child logger calls
45
+ * @returns A new Logger instance with merged context
46
+ */
47
+ child: (obj: object) => Logger;
48
+ }
49
+ /**
50
+ * Console-based logger implementation that outputs to standard console methods.
51
+ * Supports structured logging with automatic timestamp injection and context inheritance.
52
+ *
53
+ * @implements {Logger}
54
+ *
55
+ * @example
56
+ * ```typescript
57
+ * const logger = new ConsoleLogger({ app: 'myApp', version: '1.0.0' });
58
+ * logger.info({ userId: 123 }, 'User action performed');
59
+ * // Output: { app: 'myApp', version: '1.0.0', userId: 123, ts: 1234567890 } User action performed
60
+ *
61
+ * const childLogger = logger.child({ module: 'auth' });
62
+ * childLogger.debug({ action: 'validate' }, 'Validating token');
63
+ * // Output: { app: 'myApp', version: '1.0.0', module: 'auth', action: 'validate', ts: 1234567891 } Validating token
64
+ * ```
65
+ */
66
+ declare enum LogLevel {
67
+ Trace = "trace",
68
+ Debug = "debug",
69
+ Info = "info",
70
+ Warn = "warn",
71
+ Error = "error",
72
+ Fatal = "fatal",
73
+ Silent = "silent",
74
+ }
75
+ /**
76
+ * Redaction configuration for masking sensitive data in logs.
77
+ * Uses pino's fast-redact library under the hood.
78
+ *
79
+ * By default, custom paths are merged with the default sensitive paths.
80
+ * Use `resolution: 'override'` to use only your custom paths.
81
+ *
82
+ * @example
83
+ * ```typescript
84
+ * // Simple path array (merges with defaults)
85
+ * redact: ['user.ssn', 'custom.field']
86
+ *
87
+ * // Override defaults completely
88
+ * redact: {
89
+ * paths: ['only.these.paths'],
90
+ * resolution: 'override',
91
+ * }
92
+ *
93
+ * // With custom censor
94
+ * redact: {
95
+ * paths: ['extra.secret'],
96
+ * censor: '***',
97
+ * }
98
+ *
99
+ * // Remove fields entirely
100
+ * redact: {
101
+ * paths: ['temporary.data'],
102
+ * remove: true,
103
+ * }
104
+ * ```
105
+ */
106
+ type RedactOptions = string[] | {
107
+ /** Paths to redact using dot notation or bracket notation for special chars */
108
+ paths: string[];
109
+ /** Custom replacement text (default: '[REDACTED]') */
110
+ censor?: string | ((value: unknown, path: string[]) => unknown);
111
+ /** Remove the field entirely instead of replacing (default: false) */
112
+ remove?: boolean;
113
+ /**
114
+ * How to combine custom paths with default sensitive paths.
115
+ * - 'merge': Custom paths are added to default paths (default)
116
+ * - 'override': Only custom paths are used, defaults are ignored
117
+ */
118
+ resolution?: 'merge' | 'override';
119
+ };
120
+ type CreateLoggerOptions = {
121
+ /** Enable pretty printing with colors (disabled in production) */
122
+ pretty?: boolean;
123
+ /** Minimum log level to output */
124
+ level?: LogLevel;
125
+ /**
126
+ * Redaction configuration for masking sensitive data.
127
+ *
128
+ * - `true`: Uses default sensitive paths (password, token, secret, etc.)
129
+ * - `false` or `undefined`: No redaction applied
130
+ * - `string[]`: Custom paths merged with defaults
131
+ * - `object`: Advanced config with paths, censor, remove, and resolution options
132
+ *
133
+ * By default, custom paths are **merged** with the default sensitive paths.
134
+ * Use `resolution: 'override'` to disable defaults and use only your paths.
135
+ *
136
+ * @example
137
+ * ```typescript
138
+ * // Use defaults only
139
+ * createLogger({ redact: true });
140
+ *
141
+ * // Add custom paths (merged with defaults)
142
+ * createLogger({ redact: ['user.ssn', 'custom.field'] });
143
+ *
144
+ * // Override defaults completely
145
+ * createLogger({
146
+ * redact: {
147
+ * paths: ['only.these.paths'],
148
+ * resolution: 'override',
149
+ * }
150
+ * });
151
+ *
152
+ * // Merge with custom censor
153
+ * createLogger({
154
+ * redact: {
155
+ * paths: ['extra.secret'],
156
+ * censor: '***',
157
+ * }
158
+ * });
159
+ * ```
160
+ */
161
+ redact?: boolean | RedactOptions;
162
+ };
163
+ //# sourceMappingURL=types.d.ts.map
164
+ //#endregion
165
+ export { CreateLoggerOptions, LogFn, LogLevel, Logger, RedactOptions };
166
+ //# sourceMappingURL=types-Dk_k2-f_.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types-Dk_k2-f_.d.cts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;AAaA;AAaA;;;;;;;;;AAoB+B;AAoB/B;AAyCY,KA9FA,KAAA,GA8Fa;EAiBb;EAAmB,CAAA,UAAA,MAAA,CAAA,CAAA,GAAA,EA7GN,CA6GM,EAAA,GAAA,CAAA,EAAA,MAAA,EAAA,GAAA,IAAA,EAAA,GAAA,EAAA,CAAA,EAAA,IAAA;EAAA;EAId,CAAA,GAqCG,EAAA,MAAA,CAAA,EAAA,IAAA;AAAa,CAAA;;;;;;;UA3IhB,MAAA;;SAET;;QAED;;QAEA;;SAEC;;SAEA;;SAEA;;;;;;;;0BAQiB;;;;;;;;;;;;;;;;;;;aAoBb,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAyCA,aAAA;;;;;;;;;;;;;;KAiBA,mBAAA;;;;UAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAqCW"}
@@ -0,0 +1,38 @@
1
+
2
+ //#region src/types.ts
3
+ /**
4
+ * Console-based logger implementation that outputs to standard console methods.
5
+ * Supports structured logging with automatic timestamp injection and context inheritance.
6
+ *
7
+ * @implements {Logger}
8
+ *
9
+ * @example
10
+ * ```typescript
11
+ * const logger = new ConsoleLogger({ app: 'myApp', version: '1.0.0' });
12
+ * logger.info({ userId: 123 }, 'User action performed');
13
+ * // Output: { app: 'myApp', version: '1.0.0', userId: 123, ts: 1234567890 } User action performed
14
+ *
15
+ * const childLogger = logger.child({ module: 'auth' });
16
+ * childLogger.debug({ action: 'validate' }, 'Validating token');
17
+ * // Output: { app: 'myApp', version: '1.0.0', module: 'auth', action: 'validate', ts: 1234567891 } Validating token
18
+ * ```
19
+ */
20
+ let LogLevel = /* @__PURE__ */ function(LogLevel$1) {
21
+ LogLevel$1["Trace"] = "trace";
22
+ LogLevel$1["Debug"] = "debug";
23
+ LogLevel$1["Info"] = "info";
24
+ LogLevel$1["Warn"] = "warn";
25
+ LogLevel$1["Error"] = "error";
26
+ LogLevel$1["Fatal"] = "fatal";
27
+ LogLevel$1["Silent"] = "silent";
28
+ return LogLevel$1;
29
+ }({});
30
+
31
+ //#endregion
32
+ Object.defineProperty(exports, 'LogLevel', {
33
+ enumerable: true,
34
+ get: function () {
35
+ return LogLevel;
36
+ }
37
+ });
38
+ //# sourceMappingURL=types-ag_0Cvbg.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types-ag_0Cvbg.cjs","names":[],"sources":["../src/types.ts"],"sourcesContent":["/**\n * Logging function type that supports both structured and simple logging.\n * Can be called with an object for structured logging or just a message string.\n *\n * @example\n * ```typescript\n * // Structured logging with context object\n * logger.info({ userId: 123, action: 'login' }, 'User logged in');\n *\n * // Simple string logging\n * logger.info('Application started');\n * ```\n */\nexport type LogFn = {\n\t/** Structured logging with context object, optional message, and additional arguments */\n\t<T extends object>(obj: T, msg?: string, ...args: any[]): void;\n\t/** Simple string logging */\n\t(msg: string): void;\n};\n\n/**\n * Standard logger interface with multiple log levels and child logger support.\n * Follows common logging patterns with structured logging capabilities.\n *\n * @interface Logger\n */\nexport interface Logger {\n\t/** Debug level logging - verbose information for debugging */\n\tdebug: LogFn;\n\t/** Info level logging - general informational messages */\n\tinfo: LogFn;\n\t/** Warning level logging - potentially harmful situations */\n\twarn: LogFn;\n\t/** Error level logging - error events that might still allow the application to continue */\n\terror: LogFn;\n\t/** Fatal level logging - severe errors that will likely cause the application to abort */\n\tfatal: LogFn;\n\t/** Trace level logging - most detailed information */\n\ttrace: LogFn;\n\t/**\n\t * Creates a child logger with additional context.\n\t * Child loggers inherit parent context and add their own.\n\t *\n\t * @param obj - Additional context to include in all child logger calls\n\t * @returns A new Logger instance with merged context\n\t */\n\tchild: (obj: object) => Logger;\n}\n\n/**\n * Console-based logger implementation that outputs to standard console methods.\n * Supports structured logging with automatic timestamp injection and context inheritance.\n *\n * @implements {Logger}\n *\n * @example\n * ```typescript\n * const logger = new ConsoleLogger({ app: 'myApp', version: '1.0.0' });\n * logger.info({ userId: 123 }, 'User action performed');\n * // Output: { app: 'myApp', version: '1.0.0', userId: 123, ts: 1234567890 } User action performed\n *\n * const childLogger = logger.child({ module: 'auth' });\n * childLogger.debug({ action: 'validate' }, 'Validating token');\n * // Output: { app: 'myApp', version: '1.0.0', module: 'auth', action: 'validate', ts: 1234567891 } Validating token\n * ```\n */\nexport enum LogLevel {\n\tTrace = 'trace',\n\tDebug = 'debug',\n\tInfo = 'info',\n\tWarn = 'warn',\n\tError = 'error',\n\tFatal = 'fatal',\n\tSilent = 'silent',\n}\n\n/**\n * Redaction configuration for masking sensitive data in logs.\n * Uses pino's fast-redact library under the hood.\n *\n * By default, custom paths are merged with the default sensitive paths.\n * Use `resolution: 'override'` to use only your custom paths.\n *\n * @example\n * ```typescript\n * // Simple path array (merges with defaults)\n * redact: ['user.ssn', 'custom.field']\n *\n * // Override defaults completely\n * redact: {\n * paths: ['only.these.paths'],\n * resolution: 'override',\n * }\n *\n * // With custom censor\n * redact: {\n * paths: ['extra.secret'],\n * censor: '***',\n * }\n *\n * // Remove fields entirely\n * redact: {\n * paths: ['temporary.data'],\n * remove: true,\n * }\n * ```\n */\nexport type RedactOptions =\n\t| string[]\n\t| {\n\t\t\t/** Paths to redact using dot notation or bracket notation for special chars */\n\t\t\tpaths: string[];\n\t\t\t/** Custom replacement text (default: '[REDACTED]') */\n\t\t\tcensor?: string | ((value: unknown, path: string[]) => unknown);\n\t\t\t/** Remove the field entirely instead of replacing (default: false) */\n\t\t\tremove?: boolean;\n\t\t\t/**\n\t\t\t * How to combine custom paths with default sensitive paths.\n\t\t\t * - 'merge': Custom paths are added to default paths (default)\n\t\t\t * - 'override': Only custom paths are used, defaults are ignored\n\t\t\t */\n\t\t\tresolution?: 'merge' | 'override';\n\t };\n\nexport type CreateLoggerOptions = {\n\t/** Enable pretty printing with colors (disabled in production) */\n\tpretty?: boolean;\n\t/** Minimum log level to output */\n\tlevel?: LogLevel;\n\t/**\n\t * Redaction configuration for masking sensitive data.\n\t *\n\t * - `true`: Uses default sensitive paths (password, token, secret, etc.)\n\t * - `false` or `undefined`: No redaction applied\n\t * - `string[]`: Custom paths merged with defaults\n\t * - `object`: Advanced config with paths, censor, remove, and resolution options\n\t *\n\t * By default, custom paths are **merged** with the default sensitive paths.\n\t * Use `resolution: 'override'` to disable defaults and use only your paths.\n\t *\n\t * @example\n\t * ```typescript\n\t * // Use defaults only\n\t * createLogger({ redact: true });\n\t *\n\t * // Add custom paths (merged with defaults)\n\t * createLogger({ redact: ['user.ssn', 'custom.field'] });\n\t *\n\t * // Override defaults completely\n\t * createLogger({\n\t * redact: {\n\t * paths: ['only.these.paths'],\n\t * resolution: 'override',\n\t * }\n\t * });\n\t *\n\t * // Merge with custom censor\n\t * createLogger({\n\t * redact: {\n\t * paths: ['extra.secret'],\n\t * censor: '***',\n\t * }\n\t * });\n\t * ```\n\t */\n\tredact?: boolean | RedactOptions;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAkEA,IAAY,gDAAL;AACN;AACA;AACA;AACA;AACA;AACA;AACA;;AACA"}
@@ -0,0 +1,32 @@
1
+ //#region src/types.ts
2
+ /**
3
+ * Console-based logger implementation that outputs to standard console methods.
4
+ * Supports structured logging with automatic timestamp injection and context inheritance.
5
+ *
6
+ * @implements {Logger}
7
+ *
8
+ * @example
9
+ * ```typescript
10
+ * const logger = new ConsoleLogger({ app: 'myApp', version: '1.0.0' });
11
+ * logger.info({ userId: 123 }, 'User action performed');
12
+ * // Output: { app: 'myApp', version: '1.0.0', userId: 123, ts: 1234567890 } User action performed
13
+ *
14
+ * const childLogger = logger.child({ module: 'auth' });
15
+ * childLogger.debug({ action: 'validate' }, 'Validating token');
16
+ * // Output: { app: 'myApp', version: '1.0.0', module: 'auth', action: 'validate', ts: 1234567891 } Validating token
17
+ * ```
18
+ */
19
+ let LogLevel = /* @__PURE__ */ function(LogLevel$1) {
20
+ LogLevel$1["Trace"] = "trace";
21
+ LogLevel$1["Debug"] = "debug";
22
+ LogLevel$1["Info"] = "info";
23
+ LogLevel$1["Warn"] = "warn";
24
+ LogLevel$1["Error"] = "error";
25
+ LogLevel$1["Fatal"] = "fatal";
26
+ LogLevel$1["Silent"] = "silent";
27
+ return LogLevel$1;
28
+ }({});
29
+
30
+ //#endregion
31
+ export { LogLevel };
32
+ //# sourceMappingURL=types-yQ6XOihF.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types-yQ6XOihF.mjs","names":[],"sources":["../src/types.ts"],"sourcesContent":["/**\n * Logging function type that supports both structured and simple logging.\n * Can be called with an object for structured logging or just a message string.\n *\n * @example\n * ```typescript\n * // Structured logging with context object\n * logger.info({ userId: 123, action: 'login' }, 'User logged in');\n *\n * // Simple string logging\n * logger.info('Application started');\n * ```\n */\nexport type LogFn = {\n\t/** Structured logging with context object, optional message, and additional arguments */\n\t<T extends object>(obj: T, msg?: string, ...args: any[]): void;\n\t/** Simple string logging */\n\t(msg: string): void;\n};\n\n/**\n * Standard logger interface with multiple log levels and child logger support.\n * Follows common logging patterns with structured logging capabilities.\n *\n * @interface Logger\n */\nexport interface Logger {\n\t/** Debug level logging - verbose information for debugging */\n\tdebug: LogFn;\n\t/** Info level logging - general informational messages */\n\tinfo: LogFn;\n\t/** Warning level logging - potentially harmful situations */\n\twarn: LogFn;\n\t/** Error level logging - error events that might still allow the application to continue */\n\terror: LogFn;\n\t/** Fatal level logging - severe errors that will likely cause the application to abort */\n\tfatal: LogFn;\n\t/** Trace level logging - most detailed information */\n\ttrace: LogFn;\n\t/**\n\t * Creates a child logger with additional context.\n\t * Child loggers inherit parent context and add their own.\n\t *\n\t * @param obj - Additional context to include in all child logger calls\n\t * @returns A new Logger instance with merged context\n\t */\n\tchild: (obj: object) => Logger;\n}\n\n/**\n * Console-based logger implementation that outputs to standard console methods.\n * Supports structured logging with automatic timestamp injection and context inheritance.\n *\n * @implements {Logger}\n *\n * @example\n * ```typescript\n * const logger = new ConsoleLogger({ app: 'myApp', version: '1.0.0' });\n * logger.info({ userId: 123 }, 'User action performed');\n * // Output: { app: 'myApp', version: '1.0.0', userId: 123, ts: 1234567890 } User action performed\n *\n * const childLogger = logger.child({ module: 'auth' });\n * childLogger.debug({ action: 'validate' }, 'Validating token');\n * // Output: { app: 'myApp', version: '1.0.0', module: 'auth', action: 'validate', ts: 1234567891 } Validating token\n * ```\n */\nexport enum LogLevel {\n\tTrace = 'trace',\n\tDebug = 'debug',\n\tInfo = 'info',\n\tWarn = 'warn',\n\tError = 'error',\n\tFatal = 'fatal',\n\tSilent = 'silent',\n}\n\n/**\n * Redaction configuration for masking sensitive data in logs.\n * Uses pino's fast-redact library under the hood.\n *\n * By default, custom paths are merged with the default sensitive paths.\n * Use `resolution: 'override'` to use only your custom paths.\n *\n * @example\n * ```typescript\n * // Simple path array (merges with defaults)\n * redact: ['user.ssn', 'custom.field']\n *\n * // Override defaults completely\n * redact: {\n * paths: ['only.these.paths'],\n * resolution: 'override',\n * }\n *\n * // With custom censor\n * redact: {\n * paths: ['extra.secret'],\n * censor: '***',\n * }\n *\n * // Remove fields entirely\n * redact: {\n * paths: ['temporary.data'],\n * remove: true,\n * }\n * ```\n */\nexport type RedactOptions =\n\t| string[]\n\t| {\n\t\t\t/** Paths to redact using dot notation or bracket notation for special chars */\n\t\t\tpaths: string[];\n\t\t\t/** Custom replacement text (default: '[REDACTED]') */\n\t\t\tcensor?: string | ((value: unknown, path: string[]) => unknown);\n\t\t\t/** Remove the field entirely instead of replacing (default: false) */\n\t\t\tremove?: boolean;\n\t\t\t/**\n\t\t\t * How to combine custom paths with default sensitive paths.\n\t\t\t * - 'merge': Custom paths are added to default paths (default)\n\t\t\t * - 'override': Only custom paths are used, defaults are ignored\n\t\t\t */\n\t\t\tresolution?: 'merge' | 'override';\n\t };\n\nexport type CreateLoggerOptions = {\n\t/** Enable pretty printing with colors (disabled in production) */\n\tpretty?: boolean;\n\t/** Minimum log level to output */\n\tlevel?: LogLevel;\n\t/**\n\t * Redaction configuration for masking sensitive data.\n\t *\n\t * - `true`: Uses default sensitive paths (password, token, secret, etc.)\n\t * - `false` or `undefined`: No redaction applied\n\t * - `string[]`: Custom paths merged with defaults\n\t * - `object`: Advanced config with paths, censor, remove, and resolution options\n\t *\n\t * By default, custom paths are **merged** with the default sensitive paths.\n\t * Use `resolution: 'override'` to disable defaults and use only your paths.\n\t *\n\t * @example\n\t * ```typescript\n\t * // Use defaults only\n\t * createLogger({ redact: true });\n\t *\n\t * // Add custom paths (merged with defaults)\n\t * createLogger({ redact: ['user.ssn', 'custom.field'] });\n\t *\n\t * // Override defaults completely\n\t * createLogger({\n\t * redact: {\n\t * paths: ['only.these.paths'],\n\t * resolution: 'override',\n\t * }\n\t * });\n\t *\n\t * // Merge with custom censor\n\t * createLogger({\n\t * redact: {\n\t * paths: ['extra.secret'],\n\t * censor: '***',\n\t * }\n\t * });\n\t * ```\n\t */\n\tredact?: boolean | RedactOptions;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAkEA,IAAY,gDAAL;AACN;AACA;AACA;AACA;AACA;AACA;AACA;;AACA"}
package/dist/types.cjs CHANGED
@@ -1,33 +1,3 @@
1
- Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
- //#region src/types.ts
3
- /**
4
- * Console-based logger implementation that outputs to standard console methods.
5
- * Supports structured logging with automatic timestamp injection and context inheritance.
6
- *
7
- * @implements {Logger}
8
- *
9
- * @example
10
- * ```typescript
11
- * const logger = new ConsoleLogger({ app: 'myApp', version: '1.0.0' });
12
- * logger.info({ userId: 123 }, 'User action performed');
13
- * // Output: { app: 'myApp', version: '1.0.0', userId: 123, ts: 1234567890 } User action performed
14
- *
15
- * const childLogger = logger.child({ module: 'auth' });
16
- * childLogger.debug({ action: 'validate' }, 'Validating token');
17
- * // Output: { app: 'myApp', version: '1.0.0', module: 'auth', action: 'validate', ts: 1234567891 } Validating token
18
- * ```
19
- */
20
- let LogLevel = /* @__PURE__ */ function(LogLevel) {
21
- LogLevel["Trace"] = "trace";
22
- LogLevel["Debug"] = "debug";
23
- LogLevel["Info"] = "info";
24
- LogLevel["Warn"] = "warn";
25
- LogLevel["Error"] = "error";
26
- LogLevel["Fatal"] = "fatal";
27
- LogLevel["Silent"] = "silent";
28
- return LogLevel;
29
- }({});
30
- //#endregion
31
- exports.LogLevel = LogLevel;
1
+ const require_types = require('./types-ag_0Cvbg.cjs');
32
2
 
33
- //# sourceMappingURL=types.cjs.map
3
+ exports.LogLevel = require_types.LogLevel;