@logtape/logtape 2.1.0-dev.564 → 2.1.0-dev.600

package/dist/formatter.cjs

@@ -23,7 +23,7 @@ const levelAbbreviations = {
 *                If `colors` is `true`, the output will be ANSI-colored.
 * @returns The string representation of the value.
 */
-const inspect = typeof document !== "undefined" || typeof navigator !== "undefined" && navigator.product === "ReactNative" ? (v) => JSON.stringify(v) : "Deno" in globalThis && "inspect" in globalThis.Deno && typeof globalThis.Deno.inspect === "function" ? (v, opts) => globalThis.Deno.inspect(v, {
+const platformInspect = typeof document !== "undefined" || typeof navigator !== "undefined" && navigator.product === "ReactNative" ? (v) => JSON.stringify(v) : "Deno" in globalThis && "inspect" in globalThis.Deno && typeof globalThis.Deno.inspect === "function" ? (v, opts) => globalThis.Deno.inspect(v, {
 	strAbbreviateSize: Infinity,
 	iterableLimit: Infinity,
 	...opts
@@ -32,6 +32,20 @@ const inspect = typeof document !== "undefined" || typeof navigator !== "undefin
 	maxStringLength: Infinity,
 	...opts
 }) : (v) => JSON.stringify(v);
+const inspect = (value, options) => String(platformInspect(value, options));
+const utf8Encoder = new TextEncoder();
+function renderMessageParts(msgParts, valueRenderer) {
+	const msgLen = msgParts.length;
+	if (msgLen === 1) return msgParts[0];
+	if (msgLen <= 6) {
+		let message = "";
+		for (let i = 0; i < msgLen; i++) message += i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
+		return message;
+	}
+	const parts = new Array(msgLen);
+	for (let i = 0; i < msgLen; i++) parts[i] = i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
+	return parts.join("");
+}
 function padZero(num) {
 	return num < 10 ? `0${num}` : `${num}`;
 }
@@ -272,18 +286,7 @@ function getTextFormatter(options = {}) {
 	const lineEnding = getLineEndingValue(options.lineEnding);
 	const formatter = options.format ?? (({ timestamp, level, category, message }) => `${timestamp ? `${timestamp} ` : ""}[${level}] ${category}: ${message}`);
 	return (record) => {
-		const msgParts = record.message;
-		const msgLen = msgParts.length;
-		let message;
-		if (msgLen === 1) message = msgParts[0];
-		else if (msgLen <= 6) {
-			message = "";
-			for (let i = 0; i < msgLen; i++) message += i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
-		} else {
-			const parts = new Array(msgLen);
-			for (let i = 0; i < msgLen; i++) parts[i] = i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
-			message = parts.join("");
-		}
+		const message = renderMessageParts(record.message, valueRenderer);
 		const timestamp = timestampRenderer(record.timestamp);
 		const level = levelRenderer(record.level);
 		const category = typeof categorySeparator === "function" ? categorySeparator(record.category) : record.category.join(categorySeparator);
@@ -492,6 +495,146 @@ function getJsonLinesFormatter(options = {}) {
 * @since 0.11.0
 */
 const jsonLinesFormatter = getJsonLinesFormatter();
+function renderStructuredMessage(record, template) {
+	if (template) {
+		if (typeof record.rawMessage === "string") return record.rawMessage;
+		return record.rawMessage.join("{}");
+	}
+	return renderMessageParts(record.message, stringifyLogfmtValue);
+}
+function filterLogfmtKey(key) {
+	if (key === "") return null;
+	let needsEscape = false;
+	for (const char of key) {
+		const code = char.codePointAt(0);
+		if (shouldEscapeLogfmtKeyChar(char, code)) {
+			needsEscape = true;
+			break;
+		}
+	}
+	if (!needsEscape) return key;
+	let result = "";
+	for (const char of key) {
+		const code = char.codePointAt(0);
+		if (shouldEscapeLogfmtKeyChar(char, code)) result += encodeLogfmtKeyChar(char);
+		else result += char;
+	}
+	return result;
+}
+function shouldEscapeLogfmtKeyChar(char, code) {
+	return code <= 32 || code === 127 || code === 65533 || char === "=" || char === "\"" || char === "%";
+}
+function encodeLogfmtKeyChar(char) {
+	let result = "";
+	for (const byte of utf8Encoder.encode(char)) result += `%${byte.toString(16).toUpperCase().padStart(2, "0")}`;
+	return result;
+}
+function stringifyLogfmtValue(value) {
+	if (typeof value === "string") return value;
+	if (value === null) return "null";
+	if (typeof value === "number" || typeof value === "boolean" || typeof value === "bigint" || typeof value === "undefined" || typeof value === "symbol" || typeof value === "function") return String(value);
+	try {
+		const json = JSON.stringify(value, jsonReplacer);
+		if (typeof json === "string") return unwrapJsonStringLiteral(json);
+	} catch {}
+	return inspect(value, { colors: false });
+}
+function unwrapJsonStringLiteral(json) {
+	if (json.startsWith("\"") && json.endsWith("\"")) return JSON.parse(json);
+	return json;
+}
+function quoteLogfmtValue(value, isString) {
+	let needsQuote = value === "" || isString && shouldQuoteStringLiteral(value);
+	for (const char of value) {
+		const code = char.codePointAt(0);
+		if (shouldQuoteLogfmtValueChar(char, code)) {
+			needsQuote = true;
+			break;
+		}
+	}
+	if (!needsQuote) return value;
+	let quoted = "";
+	for (const char of value) {
+		const code = char.codePointAt(0);
+		quoted += escapeLogfmtValueChar(char, code);
+	}
+	return `"${quoted}"`;
+}
+function shouldQuoteStringLiteral(value) {
+	return value === "null" || value === "undefined" || value === "true" || value === "false";
+}
+function shouldQuoteLogfmtValueChar(char, code) {
+	return code <= 32 || code === 127 || code === 65533 || char === "=" || char === "\"" || char === "\\";
+}
+function escapeLogfmtValueChar(char, code) {
+	switch (char) {
+		case "	": return "\\t";
+		case "\n": return "\\n";
+		case "\r": return "\\r";
+		case "\"": return "\\\"";
+		case "\\": return "\\\\";
+		default: return code <= 31 || code === 127 ? `\\u${code.toString(16).padStart(4, "0")}` : char;
+	}
+}
+function formatLogfmtValue(value) {
+	const stringified = stringifyLogfmtValue(value);
+	return quoteLogfmtValue(stringified, typeof value === "string");
+}
+function pushLogfmtPair(pairs, key, value) {
+	const filteredKey = filterLogfmtKey(key);
+	if (filteredKey == null) return;
+	pairs.push(`${filteredKey}=${formatLogfmtValue(value)}`);
+}
+/**
+* Get a [logfmt] formatter with the specified options.  The log records
+* will be rendered as space-delimited key-value pairs, one record per line.
+* It looks like this:
+*
+* ```text
+* time=2023-11-14T22:13:20.000Z level=info logger=my.logger msg="Hello, world!" key=value
+* ```
+*
+* [logfmt]: https://brandur.org/logfmt
+* @param options The options for the logfmt formatter.
+* @returns The logfmt formatter.
+* @since 2.1.0
+*/
+function getLogfmtFormatter(options = {}) {
+	const prependPrefix = "prepend:";
+	const lineEnding = getLineEndingValue(options.lineEnding);
+	const timestampRenderer = createTimestampFormatter("rfc3339", resolveTimeZone(options.timeZone));
+	const isTemplateMessage = options.message === "template";
+	const propertiesOption = options.properties ?? "flatten";
+	let joinCategory;
+	if (typeof options.categorySeparator === "function") joinCategory = options.categorySeparator;
+	else {
+		const separator = options.categorySeparator ?? ".";
+		joinCategory = (category) => category.join(separator);
+	}
+	let propertyPrefix = "";
+	if (propertiesOption === "flatten") propertyPrefix = "";
+	else if (propertiesOption.startsWith(prependPrefix)) {
+		propertyPrefix = propertiesOption.substring(prependPrefix.length);
+		if (propertyPrefix === "") throw new TypeError("Invalid properties option: " + JSON.stringify(propertiesOption) + ". It must be of the form \"prepend:<prefix>\" where <prefix> is a non-empty string.");
+	} else throw new TypeError(`Invalid properties option: ${JSON.stringify(propertiesOption)}. It must be "flatten" or "prepend:<prefix>".`);
+	return (record) => {
+		const pairs = [];
+		pushLogfmtPair(pairs, "time", timestampRenderer(record.timestamp));
+		pushLogfmtPair(pairs, "level", record.level);
+		pushLogfmtPair(pairs, "logger", joinCategory(record.category));
+		pushLogfmtPair(pairs, "msg", renderStructuredMessage(record, isTemplateMessage));
+		for (const key in record.properties) if (Object.prototype.hasOwnProperty.call(record.properties, key)) pushLogfmtPair(pairs, `${propertyPrefix}${key}`, record.properties[key]);
+		return `${pairs.join(" ")}${lineEnding}`;
+	};
+}
+/**
+* The default [logfmt] formatter.  This formatter formats log records as
+* space-delimited key-value pairs, one record per line.
+*
+* [logfmt]: https://brandur.org/logfmt
+* @since 2.1.0
+*/
+const logfmtFormatter = getLogfmtFormatter();
 /**
 * The styles for the log level in the console.
 */
@@ -537,5 +680,7 @@ exports.defaultConsoleFormatter = defaultConsoleFormatter;
 exports.defaultTextFormatter = defaultTextFormatter;
 exports.getAnsiColorFormatter = getAnsiColorFormatter;
 exports.getJsonLinesFormatter = getJsonLinesFormatter;
+exports.getLogfmtFormatter = getLogfmtFormatter;
 exports.getTextFormatter = getTextFormatter;
-exports.jsonLinesFormatter = jsonLinesFormatter;
+exports.jsonLinesFormatter = jsonLinesFormatter;
+exports.logfmtFormatter = logfmtFormatter;

package/dist/formatter.d.cts

@@ -372,6 +372,84 @@ declare function getJsonLinesFormatter(options?: JsonLinesFormatterOptions): Tex
  * @since 0.11.0
  */
 declare const jsonLinesFormatter: TextFormatter;
+/**
+ * Options for the {@link getLogfmtFormatter} function.
+ * @since 2.1.0
+ */
+interface LogfmtFormatterOptions {
+  /**
+   * The separator between category names.  For example, if the separator is
+   * `"."`, the category `["a", "b", "c"]` will be formatted as `"a.b.c"`.
+   * If this is a function, it will be called with the category array and
+   * should return a string, which will be used for rendering the category.
+   *
+   * @default `"."`
+   */
+  readonly categorySeparator?: string | ((category: readonly string[]) => string);
+  /**
+   * The message format.  This can be one of the following:
+   *
+   * - `"template"`: The raw message template is used as the message.
+   * - `"rendered"`: The message is rendered with the values.
+   *
+   * @default `"rendered"`
+   */
+  readonly message?: "template" | "rendered";
+  /**
+   * The properties format.  This can be one of the following:
+   *
+   * - `"flatten"`: The properties are flattened into logfmt key-value pairs.
+   * - `"prepend:<prefix>"`: The properties are prepended with the given prefix
+   *   (e.g., `"prepend:ctx_"` will prepend `ctx_` to each property key).
+   *
+   * @default `"flatten"`
+   */
+  readonly properties?: "flatten" | `prepend:${string}`;
+  /**
+   * The timezone used for timestamp rendering.
+   *
+   * - `undefined` (default): UTC
+   * - `null`: System local timezone
+   * - IANA timezone name such as `"America/Bogota"` or `"Asia/Seoul"`
+   * - Fixed UTC offset string such as `"+09:00"` or `"-05:00"`
+   *
+   * @since 2.1.0
+   */
+  readonly timeZone?: string | null;
+  /**
+   * Line ending style for formatted output.
+   *
+   * - `"lf"`: Unix-style line endings (`\n`)
+   * - `"crlf"`: Windows-style line endings (`\r\n`)
+   *
+   * @default "lf"
+   * @since 2.1.0
+   */
+  readonly lineEnding?: "lf" | "crlf";
+}
+/**
+ * Get a [logfmt] formatter with the specified options.  The log records
+ * will be rendered as space-delimited key-value pairs, one record per line.
+ * It looks like this:
+ *
+ * ```text
+ * time=2023-11-14T22:13:20.000Z level=info logger=my.logger msg="Hello, world!" key=value
+ * ```
+ *
+ * [logfmt]: https://brandur.org/logfmt
+ * @param options The options for the logfmt formatter.
+ * @returns The logfmt formatter.
+ * @since 2.1.0
+ */
+declare function getLogfmtFormatter(options?: LogfmtFormatterOptions): TextFormatter;
+/**
+ * The default [logfmt] formatter.  This formatter formats log records as
+ * space-delimited key-value pairs, one record per line.
+ *
+ * [logfmt]: https://brandur.org/logfmt
+ * @since 2.1.0
+ */
+declare const logfmtFormatter: TextFormatter;
 /**
  * A console formatter is a function that accepts a log record and returns
  * an array of arguments to pass to {@link console.log}.
@@ -391,5 +469,5 @@ type ConsoleFormatter = (record: LogRecord) => readonly unknown[];
 declare function defaultConsoleFormatter(record: LogRecord): readonly unknown[];
 //# sourceMappingURL=formatter.d.ts.map
 //#endregion
-export { AnsiColor, AnsiColorFormatterOptions, AnsiStyle, ConsoleFormatter, FormattedValues, JsonLinesFormatterOptions, TextFormatter, TextFormatterOptions, ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, getAnsiColorFormatter, getJsonLinesFormatter, getTextFormatter, jsonLinesFormatter };
+export { AnsiColor, AnsiColorFormatterOptions, AnsiStyle, ConsoleFormatter, FormattedValues, JsonLinesFormatterOptions, LogfmtFormatterOptions, TextFormatter, TextFormatterOptions, ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, getAnsiColorFormatter, getJsonLinesFormatter, getLogfmtFormatter, getTextFormatter, jsonLinesFormatter, logfmtFormatter };
 //# sourceMappingURL=formatter.d.cts.map

package/dist/formatter.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.d.cts","names":[],"sources":["../src/formatter.ts"],"sourcesContent":[],"mappings":";;;;;;;AAWA;AA+DA;AA+BA;;;AA6IoB,KA3OR,aAAA,GA2OQ,CAAA,MAAA,EA3OiB,SA2OjB,EAAA,GAAA,MAAA;AAAe;AA+TnC;;;AAEG,UA7ec,eAAA,CA6ed;EAAa;AAiHhB;AAQA;EAyBY,SAAA,EAAA,MAAS,GAAA,IAAA;EA4BJ;;;EA0CW,KAKT,EAAA,MAAA;EAAS;;;EAiBc,QAA1B,EAAA,MAAA;EAAM;;;EAhEiD,OAAA,EAAA,MAAA;EAqFvD;;;EACyB,MACtC,EA1tBO,SA0tBP;AAAa;AAgEhB;AAMA;AAiEA;;AACW,UA31BM,oBAAA,CA21BN;EAA8B;AACzB;AA8JhB;AAUA;AAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mEA/8Be;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAmEK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+TJ,gBAAA,WACL,uBACR;;;;;;;;;;;cAiHU,sBAAsB;;;;;KAQvB,SAAA;;;;;KAyBA,SAAA;;;;;UA4BK,yBAAA,SAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA0ChC;;;;mBAKA;;;;eAKJ;;;;;;;;;;;gBAYC,OAAO,UAAU;;;;kBAKf;;;;kBAKA;;;;;;;;;;iBAWF,qBAAA,WACL,4BACR;;;;;;;;;;cAgEU,oBAAoB;;;;;UAMhB,yBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiED,qBAAA,WACL,4BACR;;;;;;;;;;;;;;;;;cA8JU,oBAAoB;;;;;;;;;KAUrB,gBAAA,YAA4B;;;;;;;;iBAqBxB,uBAAA,SAAgC"}
+{"version":3,"file":"formatter.d.cts","names":[],"sources":["../src/formatter.ts"],"sourcesContent":[],"mappings":";;;;;;;AAWA;AAsGA;AA+BA;;;AA6IoB,KAlRR,aAAA,GAkRQ,CAAA,MAAA,EAlRiB,SAkRjB,EAAA,GAAA,MAAA;AAAe;AA+TnC;;;AAEG,UA7ec,eAAA,CA6ed;EAAa;AA0FhB;AAQA;EAyBY,SAAA,EAAA,MAAS,GAAA,IAAA;EA4BJ;;;EA0CW,KAKT,EAAA,MAAA;EAAS;;;EAiBc,QAA1B,EAAA,MAAA;EAAM;;;EAhEiD,OAAA,EAAA,MAAA;EAqFvD;;;EACyB,MACtC,EAnsBO,SAmsBP;AAAa;AAgEhB;AAMA;AAiEA;;AACW,UAp0BM,oBAAA,CAo0BN;EAA8B;AACzB;AA8JhB;AAMA;AAoNA;;;;AAEgB;AA6EhB;AAUA;AAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mEAjuCe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAmEK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+TJ,gBAAA,WACL,uBACR;;;;;;;;;;;cA0FU,sBAAsB;;;;;KAQvB,SAAA;;;;;KAyBA,SAAA;;;;;UA4BK,yBAAA,SAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA0ChC;;;;mBAKA;;;;eAKJ;;;;;;;;;;;gBAYC,OAAO,UAAU;;;;kBAKf;;;;kBAKA;;;;;;;;;;iBAWF,qBAAA,WACL,4BACR;;;;;;;;;;cAgEU,oBAAoB;;;;;UAMhB,yBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiED,qBAAA,WACL,4BACR;;;;;;;;;;;;;;;;;cA8JU,oBAAoB;;;;;UAMhB,sBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoND,kBAAA,WACL,yBACR;;;;;;;;cA6EU,iBAAiB;;;;;;;;;KAUlB,gBAAA,YAA4B;;;;;;;;iBAqBxB,uBAAA,SAAgC"}

package/dist/formatter.d.ts

@@ -372,6 +372,84 @@ declare function getJsonLinesFormatter(options?: JsonLinesFormatterOptions): Tex
  * @since 0.11.0
  */
 declare const jsonLinesFormatter: TextFormatter;
+/**
+ * Options for the {@link getLogfmtFormatter} function.
+ * @since 2.1.0
+ */
+interface LogfmtFormatterOptions {
+  /**
+   * The separator between category names.  For example, if the separator is
+   * `"."`, the category `["a", "b", "c"]` will be formatted as `"a.b.c"`.
+   * If this is a function, it will be called with the category array and
+   * should return a string, which will be used for rendering the category.
+   *
+   * @default `"."`
+   */
+  readonly categorySeparator?: string | ((category: readonly string[]) => string);
+  /**
+   * The message format.  This can be one of the following:
+   *
+   * - `"template"`: The raw message template is used as the message.
+   * - `"rendered"`: The message is rendered with the values.
+   *
+   * @default `"rendered"`
+   */
+  readonly message?: "template" | "rendered";
+  /**
+   * The properties format.  This can be one of the following:
+   *
+   * - `"flatten"`: The properties are flattened into logfmt key-value pairs.
+   * - `"prepend:<prefix>"`: The properties are prepended with the given prefix
+   *   (e.g., `"prepend:ctx_"` will prepend `ctx_` to each property key).
+   *
+   * @default `"flatten"`
+   */
+  readonly properties?: "flatten" | `prepend:${string}`;
+  /**
+   * The timezone used for timestamp rendering.
+   *
+   * - `undefined` (default): UTC
+   * - `null`: System local timezone
+   * - IANA timezone name such as `"America/Bogota"` or `"Asia/Seoul"`
+   * - Fixed UTC offset string such as `"+09:00"` or `"-05:00"`
+   *
+   * @since 2.1.0
+   */
+  readonly timeZone?: string | null;
+  /**
+   * Line ending style for formatted output.
+   *
+   * - `"lf"`: Unix-style line endings (`\n`)
+   * - `"crlf"`: Windows-style line endings (`\r\n`)
+   *
+   * @default "lf"
+   * @since 2.1.0
+   */
+  readonly lineEnding?: "lf" | "crlf";
+}
+/**
+ * Get a [logfmt] formatter with the specified options.  The log records
+ * will be rendered as space-delimited key-value pairs, one record per line.
+ * It looks like this:
+ *
+ * ```text
+ * time=2023-11-14T22:13:20.000Z level=info logger=my.logger msg="Hello, world!" key=value
+ * ```
+ *
+ * [logfmt]: https://brandur.org/logfmt
+ * @param options The options for the logfmt formatter.
+ * @returns The logfmt formatter.
+ * @since 2.1.0
+ */
+declare function getLogfmtFormatter(options?: LogfmtFormatterOptions): TextFormatter;
+/**
+ * The default [logfmt] formatter.  This formatter formats log records as
+ * space-delimited key-value pairs, one record per line.
+ *
+ * [logfmt]: https://brandur.org/logfmt
+ * @since 2.1.0
+ */
+declare const logfmtFormatter: TextFormatter;
 /**
  * A console formatter is a function that accepts a log record and returns
  * an array of arguments to pass to {@link console.log}.
@@ -391,5 +469,5 @@ type ConsoleFormatter = (record: LogRecord) => readonly unknown[];
 declare function defaultConsoleFormatter(record: LogRecord): readonly unknown[];
 //# sourceMappingURL=formatter.d.ts.map
 //#endregion
-export { AnsiColor, AnsiColorFormatterOptions, AnsiStyle, ConsoleFormatter, FormattedValues, JsonLinesFormatterOptions, TextFormatter, TextFormatterOptions, ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, getAnsiColorFormatter, getJsonLinesFormatter, getTextFormatter, jsonLinesFormatter };
+export { AnsiColor, AnsiColorFormatterOptions, AnsiStyle, ConsoleFormatter, FormattedValues, JsonLinesFormatterOptions, LogfmtFormatterOptions, TextFormatter, TextFormatterOptions, ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, getAnsiColorFormatter, getJsonLinesFormatter, getLogfmtFormatter, getTextFormatter, jsonLinesFormatter, logfmtFormatter };
 //# sourceMappingURL=formatter.d.ts.map

package/dist/formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatter.d.ts","names":[],"sources":["../src/formatter.ts"],"sourcesContent":[],"mappings":";;;;;;;AAWA;AA+DA;AA+BA;;;AA6IoB,KA3OR,aAAA,GA2OQ,CAAA,MAAA,EA3OiB,SA2OjB,EAAA,GAAA,MAAA;AAAe;AA+TnC;;;AAEG,UA7ec,eAAA,CA6ed;EAAa;AAiHhB;AAQA;EAyBY,SAAA,EAAA,MAAS,GAAA,IAAA;EA4BJ;;;EA0CW,KAKT,EAAA,MAAA;EAAS;;;EAiBc,QAA1B,EAAA,MAAA;EAAM;;;EAhEiD,OAAA,EAAA,MAAA;EAqFvD;;;EACyB,MACtC,EA1tBO,SA0tBP;AAAa;AAgEhB;AAMA;AAiEA;;AACW,UA31BM,oBAAA,CA21BN;EAA8B;AACzB;AA8JhB;AAUA;AAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mEA/8Be;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAmEK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+TJ,gBAAA,WACL,uBACR;;;;;;;;;;;cAiHU,sBAAsB;;;;;KAQvB,SAAA;;;;;KAyBA,SAAA;;;;;UA4BK,yBAAA,SAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA0ChC;;;;mBAKA;;;;eAKJ;;;;;;;;;;;gBAYC,OAAO,UAAU;;;;kBAKf;;;;kBAKA;;;;;;;;;;iBAWF,qBAAA,WACL,4BACR;;;;;;;;;;cAgEU,oBAAoB;;;;;UAMhB,yBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiED,qBAAA,WACL,4BACR;;;;;;;;;;;;;;;;;cA8JU,oBAAoB;;;;;;;;;KAUrB,gBAAA,YAA4B;;;;;;;;iBAqBxB,uBAAA,SAAgC"}
+{"version":3,"file":"formatter.d.ts","names":[],"sources":["../src/formatter.ts"],"sourcesContent":[],"mappings":";;;;;;;AAWA;AAsGA;AA+BA;;;AA6IoB,KAlRR,aAAA,GAkRQ,CAAA,MAAA,EAlRiB,SAkRjB,EAAA,GAAA,MAAA;AAAe;AA+TnC;;;AAEG,UA7ec,eAAA,CA6ed;EAAa;AA0FhB;AAQA;EAyBY,SAAA,EAAA,MAAS,GAAA,IAAA;EA4BJ;;;EA0CW,KAKT,EAAA,MAAA;EAAS;;;EAiBc,QAA1B,EAAA,MAAA;EAAM;;;EAhEiD,OAAA,EAAA,MAAA;EAqFvD;;;EACyB,MACtC,EAnsBO,SAmsBP;AAAa;AAgEhB;AAMA;AAiEA;;AACW,UAp0BM,oBAAA,CAo0BN;EAA8B;AACzB;AA8JhB;AAMA;AAoNA;;;;AAEgB;AA6EhB;AAUA;AAqBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mEAjuCe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAmEK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+TJ,gBAAA,WACL,uBACR;;;;;;;;;;;cA0FU,sBAAsB;;;;;KAQvB,SAAA;;;;;KAyBA,SAAA;;;;;UA4BK,yBAAA,SAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA0ChC;;;;mBAKA;;;;eAKJ;;;;;;;;;;;gBAYC,OAAO,UAAU;;;;kBAKf;;;;kBAKA;;;;;;;;;;iBAWF,qBAAA,WACL,4BACR;;;;;;;;;;cAgEU,oBAAoB;;;;;UAMhB,yBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiED,qBAAA,WACL,4BACR;;;;;;;;;;;;;;;;;cA8JU,oBAAoB;;;;;UAMhB,sBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoND,kBAAA,WACL,yBACR;;;;;;;;cA6EU,iBAAiB;;;;;;;;;KAUlB,gBAAA,YAA4B;;;;;;;;iBAqBxB,uBAAA,SAAgC"}

package/dist/formatter.js

@@ -22,7 +22,7 @@ const levelAbbreviations = {
 *                If `colors` is `true`, the output will be ANSI-colored.
 * @returns The string representation of the value.
 */
-const inspect = typeof document !== "undefined" || typeof navigator !== "undefined" && navigator.product === "ReactNative" ? (v) => JSON.stringify(v) : "Deno" in globalThis && "inspect" in globalThis.Deno && typeof globalThis.Deno.inspect === "function" ? (v, opts) => globalThis.Deno.inspect(v, {
+const platformInspect = typeof document !== "undefined" || typeof navigator !== "undefined" && navigator.product === "ReactNative" ? (v) => JSON.stringify(v) : "Deno" in globalThis && "inspect" in globalThis.Deno && typeof globalThis.Deno.inspect === "function" ? (v, opts) => globalThis.Deno.inspect(v, {
 	strAbbreviateSize: Infinity,
 	iterableLimit: Infinity,
 	...opts
@@ -31,6 +31,20 @@ const inspect = typeof document !== "undefined" || typeof navigator !== "undefin
 	maxStringLength: Infinity,
 	...opts
 }) : (v) => JSON.stringify(v);
+const inspect = (value, options) => String(platformInspect(value, options));
+const utf8Encoder = new TextEncoder();
+function renderMessageParts(msgParts, valueRenderer) {
+	const msgLen = msgParts.length;
+	if (msgLen === 1) return msgParts[0];
+	if (msgLen <= 6) {
+		let message = "";
+		for (let i = 0; i < msgLen; i++) message += i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
+		return message;
+	}
+	const parts = new Array(msgLen);
+	for (let i = 0; i < msgLen; i++) parts[i] = i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
+	return parts.join("");
+}
 function padZero(num) {
 	return num < 10 ? `0${num}` : `${num}`;
 }
@@ -271,18 +285,7 @@ function getTextFormatter(options = {}) {
 	const lineEnding = getLineEndingValue(options.lineEnding);
 	const formatter = options.format ?? (({ timestamp, level, category, message }) => `${timestamp ? `${timestamp} ` : ""}[${level}] ${category}: ${message}`);
 	return (record) => {
-		const msgParts = record.message;
-		const msgLen = msgParts.length;
-		let message;
-		if (msgLen === 1) message = msgParts[0];
-		else if (msgLen <= 6) {
-			message = "";
-			for (let i = 0; i < msgLen; i++) message += i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
-		} else {
-			const parts = new Array(msgLen);
-			for (let i = 0; i < msgLen; i++) parts[i] = i % 2 === 0 ? msgParts[i] : valueRenderer(msgParts[i]);
-			message = parts.join("");
-		}
+		const message = renderMessageParts(record.message, valueRenderer);
 		const timestamp = timestampRenderer(record.timestamp);
 		const level = levelRenderer(record.level);
 		const category = typeof categorySeparator === "function" ? categorySeparator(record.category) : record.category.join(categorySeparator);
@@ -491,6 +494,146 @@ function getJsonLinesFormatter(options = {}) {
 * @since 0.11.0
 */
 const jsonLinesFormatter = getJsonLinesFormatter();
+function renderStructuredMessage(record, template) {
+	if (template) {
+		if (typeof record.rawMessage === "string") return record.rawMessage;
+		return record.rawMessage.join("{}");
+	}
+	return renderMessageParts(record.message, stringifyLogfmtValue);
+}
+function filterLogfmtKey(key) {
+	if (key === "") return null;
+	let needsEscape = false;
+	for (const char of key) {
+		const code = char.codePointAt(0);
+		if (shouldEscapeLogfmtKeyChar(char, code)) {
+			needsEscape = true;
+			break;
+		}
+	}
+	if (!needsEscape) return key;
+	let result = "";
+	for (const char of key) {
+		const code = char.codePointAt(0);
+		if (shouldEscapeLogfmtKeyChar(char, code)) result += encodeLogfmtKeyChar(char);
+		else result += char;
+	}
+	return result;
+}
+function shouldEscapeLogfmtKeyChar(char, code) {
+	return code <= 32 || code === 127 || code === 65533 || char === "=" || char === "\"" || char === "%";
+}
+function encodeLogfmtKeyChar(char) {
+	let result = "";
+	for (const byte of utf8Encoder.encode(char)) result += `%${byte.toString(16).toUpperCase().padStart(2, "0")}`;
+	return result;
+}
+function stringifyLogfmtValue(value) {
+	if (typeof value === "string") return value;
+	if (value === null) return "null";
+	if (typeof value === "number" || typeof value === "boolean" || typeof value === "bigint" || typeof value === "undefined" || typeof value === "symbol" || typeof value === "function") return String(value);
+	try {
+		const json = JSON.stringify(value, jsonReplacer);
+		if (typeof json === "string") return unwrapJsonStringLiteral(json);
+	} catch {}
+	return inspect(value, { colors: false });
+}
+function unwrapJsonStringLiteral(json) {
+	if (json.startsWith("\"") && json.endsWith("\"")) return JSON.parse(json);
+	return json;
+}
+function quoteLogfmtValue(value, isString) {
+	let needsQuote = value === "" || isString && shouldQuoteStringLiteral(value);
+	for (const char of value) {
+		const code = char.codePointAt(0);
+		if (shouldQuoteLogfmtValueChar(char, code)) {
+			needsQuote = true;
+			break;
+		}
+	}
+	if (!needsQuote) return value;
+	let quoted = "";
+	for (const char of value) {
+		const code = char.codePointAt(0);
+		quoted += escapeLogfmtValueChar(char, code);
+	}
+	return `"${quoted}"`;
+}
+function shouldQuoteStringLiteral(value) {
+	return value === "null" || value === "undefined" || value === "true" || value === "false";
+}
+function shouldQuoteLogfmtValueChar(char, code) {
+	return code <= 32 || code === 127 || code === 65533 || char === "=" || char === "\"" || char === "\\";
+}
+function escapeLogfmtValueChar(char, code) {
+	switch (char) {
+		case "	": return "\\t";
+		case "\n": return "\\n";
+		case "\r": return "\\r";
+		case "\"": return "\\\"";
+		case "\\": return "\\\\";
+		default: return code <= 31 || code === 127 ? `\\u${code.toString(16).padStart(4, "0")}` : char;
+	}
+}
+function formatLogfmtValue(value) {
+	const stringified = stringifyLogfmtValue(value);
+	return quoteLogfmtValue(stringified, typeof value === "string");
+}
+function pushLogfmtPair(pairs, key, value) {
+	const filteredKey = filterLogfmtKey(key);
+	if (filteredKey == null) return;
+	pairs.push(`${filteredKey}=${formatLogfmtValue(value)}`);
+}
+/**
+* Get a [logfmt] formatter with the specified options.  The log records
+* will be rendered as space-delimited key-value pairs, one record per line.
+* It looks like this:
+*
+* ```text
+* time=2023-11-14T22:13:20.000Z level=info logger=my.logger msg="Hello, world!" key=value
+* ```
+*
+* [logfmt]: https://brandur.org/logfmt
+* @param options The options for the logfmt formatter.
+* @returns The logfmt formatter.
+* @since 2.1.0
+*/
+function getLogfmtFormatter(options = {}) {
+	const prependPrefix = "prepend:";
+	const lineEnding = getLineEndingValue(options.lineEnding);
+	const timestampRenderer = createTimestampFormatter("rfc3339", resolveTimeZone(options.timeZone));
+	const isTemplateMessage = options.message === "template";
+	const propertiesOption = options.properties ?? "flatten";
+	let joinCategory;
+	if (typeof options.categorySeparator === "function") joinCategory = options.categorySeparator;
+	else {
+		const separator = options.categorySeparator ?? ".";
+		joinCategory = (category) => category.join(separator);
+	}
+	let propertyPrefix = "";
+	if (propertiesOption === "flatten") propertyPrefix = "";
+	else if (propertiesOption.startsWith(prependPrefix)) {
+		propertyPrefix = propertiesOption.substring(prependPrefix.length);
+		if (propertyPrefix === "") throw new TypeError("Invalid properties option: " + JSON.stringify(propertiesOption) + ". It must be of the form \"prepend:<prefix>\" where <prefix> is a non-empty string.");
+	} else throw new TypeError(`Invalid properties option: ${JSON.stringify(propertiesOption)}. It must be "flatten" or "prepend:<prefix>".`);
+	return (record) => {
+		const pairs = [];
+		pushLogfmtPair(pairs, "time", timestampRenderer(record.timestamp));
+		pushLogfmtPair(pairs, "level", record.level);
+		pushLogfmtPair(pairs, "logger", joinCategory(record.category));
+		pushLogfmtPair(pairs, "msg", renderStructuredMessage(record, isTemplateMessage));
+		for (const key in record.properties) if (Object.prototype.hasOwnProperty.call(record.properties, key)) pushLogfmtPair(pairs, `${propertyPrefix}${key}`, record.properties[key]);
+		return `${pairs.join(" ")}${lineEnding}`;
+	};
+}
+/**
+* The default [logfmt] formatter.  This formatter formats log records as
+* space-delimited key-value pairs, one record per line.
+*
+* [logfmt]: https://brandur.org/logfmt
+* @since 2.1.0
+*/
+const logfmtFormatter = getLogfmtFormatter();
 /**
 * The styles for the log level in the console.
 */
@@ -531,5 +674,5 @@ function defaultConsoleFormatter(record) {
 }
 
 //#endregion
-export { ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, getAnsiColorFormatter, getJsonLinesFormatter, getTextFormatter, jsonLinesFormatter };
+export { ansiColorFormatter, defaultConsoleFormatter, defaultTextFormatter, getAnsiColorFormatter, getJsonLinesFormatter, getLogfmtFormatter, getTextFormatter, jsonLinesFormatter, logfmtFormatter };
 //# sourceMappingURL=formatter.js.map