@logtape/file 0.10.0-dev.148 → 0.10.0-dev.155

package/esm/file/filesink.base.js

@@ -1,4 +1,4 @@
-import { defaultTextFormatter, } from "../logtape/mod.js";
+import { defaultTextFormatter, } from "@logtape/logtape";
 /**
  * Get a platform-independent file sink.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/file",
-  "version": "0.10.0-dev.148+496b13e3",
+  "version": "0.10.0-dev.155+5ee37546",
   "description": "File sink and rotating file sink for LogTape",
   "keywords": [
     "logging",
@@ -46,6 +46,9 @@
   "funding": [
     "https://github.com/sponsors/dahlia"
   ],
+  "dependencies": {
+    "@logtape/logtape": "^0.10.0-dev.149"
+  },
   "devDependencies": {
     "@types/node": "^20.9.0",
     "picocolors": "^1.0.0",

package/script/file/filesink.base.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBaseFileSink = getBaseFileSink;
 exports.getBaseRotatingFileSink = getBaseRotatingFileSink;
-const mod_js_1 = require("../logtape/mod.js");
+const logtape_1 = require("@logtape/logtape");
 /**
  * Get a platform-independent file sink.
  *
@@ -13,7 +13,7 @@ const mod_js_1 = require("../logtape/mod.js");
  *          object that closes the file when disposed.
  */
 function getBaseFileSink(path, options) {
-    const formatter = options.formatter ?? mod_js_1.defaultTextFormatter;
+    const formatter = options.formatter ?? logtape_1.defaultTextFormatter;
     const encoder = options.encoder ?? new TextEncoder();
     let fd = options.lazy ? null : options.openSync(path);
     const sink = (record) => {
@@ -44,7 +44,7 @@ function getBaseFileSink(path, options) {
  *          object that closes the file when disposed.
  */
 function getBaseRotatingFileSink(path, options) {
-    const formatter = options.formatter ?? mod_js_1.defaultTextFormatter;
+    const formatter = options.formatter ?? logtape_1.defaultTextFormatter;
     const encoder = options.encoder ?? new TextEncoder();
     const maxSize = options.maxSize ?? 1024 * 1024;
     const maxFiles = options.maxFiles ?? 5;

package/types/file/filesink.base.d.ts

@@ -1,4 +1,4 @@
-import { type Sink, type StreamSinkOptions } from "../logtape/mod.js";
+import { type Sink, type StreamSinkOptions } from "@logtape/logtape";
 /**
  * Options for the {@link getBaseFileSink} function.
  */

package/types/file/filesink.base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filesink.base.d.ts","sourceRoot":"","sources":["../../src/file/filesink.base.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,IAAI,EACT,KAAK,iBAAiB,EACvB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAAG;IAChD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK;IACnC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;CAC5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,KAAK,EACnC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,GAC/C,IAAI,GAAG,UAAU,CAiBnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC;IAC5E;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,KAAK,CAAE,SAAQ,cAAc,CAAC,KAAK,CAAC;IAC1E;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAEzC;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAC3C,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,uBAAuB,GAAG,sBAAsB,CAAC,KAAK,CAAC,GAC/D,IAAI,GAAG,UAAU,CAwCnB"}
+{"version":3,"file":"filesink.base.d.ts","sourceRoot":"","sources":["../../src/file/filesink.base.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,IAAI,EACT,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,GAAG;IAChD;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK;IACnC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;CAC5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,KAAK,EACnC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,GAC/C,IAAI,GAAG,UAAU,CAiBnB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC;IAC5E;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,KAAK,CAAE,SAAQ,cAAc,CAAC,KAAK,CAAC;IAC1E;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAEzC;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAC3C,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,uBAAuB,GAAG,sBAAsB,CAAC,KAAK,CAAC,GAC/D,IAAI,GAAG,UAAU,CAwCnB"}

package/types/file/filesink.node.d.ts

@@ -1,4 +1,4 @@
-import type { Sink } from "../logtape/mod.js";
+import type { Sink } from "@logtape/logtape";
 import { type FileSinkOptions, type RotatingFileSinkDriver, type RotatingFileSinkOptions } from "./filesink.base.js";
 /**
  * A Node.js-specific file sink driver.

package/types/file/filesink.node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filesink.node.d.ts","sourceRoot":"","sources":["../../src/file/filesink.node.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EACL,KAAK,eAAe,EAGpB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC7B,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAS5D,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,eAAoB,GAC5B,IAAI,GAAG,UAAU,CAEnB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,uBAA4B,GACpC,IAAI,GAAG,UAAU,CAEnB"}
+{"version":3,"file":"filesink.node.d.ts","sourceRoot":"","sources":["../../src/file/filesink.node.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,EACL,KAAK,eAAe,EAGpB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC7B,MAAM,oBAAoB,CAAC;AAE5B;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,sBAAsB,CAAC,MAAM,GAAG,IAAI,CAS5D,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,eAAoB,GAC5B,IAAI,GAAG,UAAU,CAEnB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,uBAA4B,GACpC,IAAI,GAAG,UAAU,CAEnB"}

package/esm/_dnt.shims.js

@@ -1,57 +0,0 @@
-const dntGlobals = {};
-export const dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
-function createMergeProxy(baseObj, extObj) {
-    return new Proxy(baseObj, {
-        get(_target, prop, _receiver) {
-            if (prop in extObj) {
-                return extObj[prop];
-            }
-            else {
-                return baseObj[prop];
-            }
-        },
-        set(_target, prop, value) {
-            if (prop in extObj) {
-                delete extObj[prop];
-            }
-            baseObj[prop] = value;
-            return true;
-        },
-        deleteProperty(_target, prop) {
-            let success = false;
-            if (prop in extObj) {
-                delete extObj[prop];
-                success = true;
-            }
-            if (prop in baseObj) {
-                delete baseObj[prop];
-                success = true;
-            }
-            return success;
-        },
-        ownKeys(_target) {
-            const baseKeys = Reflect.ownKeys(baseObj);
-            const extKeys = Reflect.ownKeys(extObj);
-            const extKeysSet = new Set(extKeys);
-            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
-        },
-        defineProperty(_target, prop, desc) {
-            if (prop in extObj) {
-                delete extObj[prop];
-            }
-            Reflect.defineProperty(baseObj, prop, desc);
-            return true;
-        },
-        getOwnPropertyDescriptor(_target, prop) {
-            if (prop in extObj) {
-                return Reflect.getOwnPropertyDescriptor(extObj, prop);
-            }
-            else {
-                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
-            }
-        },
-        has(_target, prop) {
-            return prop in extObj || prop in baseObj;
-        },
-    });
-}

package/esm/logtape/config.js

@@ -1,287 +0,0 @@
-import * as dntShim from "../_dnt.shims.js";
-import { toFilter } from "./filter.js";
-import { LoggerImpl } from "./logger.js";
-import { getConsoleSink } from "./sink.js";
-/**
- * The current configuration, if any.  Otherwise, `null`.
- */
-let currentConfig = null;
-/**
- * Strong references to the loggers.
- * This is to prevent the loggers from being garbage collected so that their
- * sinks and filters are not removed.
- */
-const strongRefs = new Set();
-/**
- * Disposables to dispose when resetting the configuration.
- */
-const disposables = new Set();
-/**
- * Async disposables to dispose when resetting the configuration.
- */
-const asyncDisposables = new Set();
-/**
- * Check if a config is for the meta logger.
- */
-function isLoggerConfigMeta(cfg) {
-    return cfg.category.length === 0 ||
-        (cfg.category.length === 1 && cfg.category[0] === "logtape") ||
-        (cfg.category.length === 2 &&
-            cfg.category[0] === "logtape" &&
-            cfg.category[1] === "meta");
-}
-/**
- * Configure the loggers with the specified configuration.
- *
- * Note that if the given sinks or filters are disposable, they will be
- * disposed when the configuration is reset, or when the process exits.
- *
- * @example
- * ```typescript
- * await configure({
- *   sinks: {
- *     console: getConsoleSink(),
- *   },
- *   filters: {
- *     slow: (log) =>
- *       "duration" in log.properties &&
- *       log.properties.duration as number > 1000,
- *   },
- *   loggers: [
- *     {
- *       category: "my-app",
- *       sinks: ["console"],
- *       level: "info",
- *     },
- *     {
- *       category: ["my-app", "sql"],
- *       filters: ["slow"],
- *       level: "debug",
- *     },
- *     {
- *       category: "logtape",
- *       sinks: ["console"],
- *       level: "error",
- *     },
- *   ],
- * });
- * ```
- *
- * @param config The configuration.
- */
-export async function configure(config) {
-    if (currentConfig != null && !config.reset) {
-        throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
-    }
-    await reset();
-    try {
-        configureInternal(config, true);
-    }
-    catch (e) {
-        if (e instanceof ConfigError)
-            await reset();
-        throw e;
-    }
-}
-/**
- * Configure sync loggers with the specified configuration.
- *
- * Note that if the given sinks or filters are disposable, they will be
- * disposed when the configuration is reset, or when the process exits.
- *
- * Also note that passing async sinks or filters will throw. If
- * necessary use {@link resetSync} or {@link disposeSync}.
- *
- * @example
- * ```typescript
- * configureSync({
- *   sinks: {
- *     console: getConsoleSink(),
- *   },
- *   loggers: [
- *     {
- *       category: "my-app",
- *       sinks: ["console"],
- *       level: "info",
- *     },
- *     {
- *       category: "logtape",
- *       sinks: ["console"],
- *       level: "error",
- *     },
- *   ],
- * });
- * ```
- *
- * @param config The configuration.
- * @since 0.9.0
- */
-export function configureSync(config) {
-    if (currentConfig != null && !config.reset) {
-        throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
-    }
-    if (asyncDisposables.size > 0) {
-        throw new ConfigError("Previously configured async disposables are still active. " +
-            "Use configure() instead or explicitly dispose them using dispose().");
-    }
-    resetSync();
-    try {
-        configureInternal(config, false);
-    }
-    catch (e) {
-        if (e instanceof ConfigError)
-            resetSync();
-        throw e;
-    }
-}
-function configureInternal(config, allowAsync) {
-    currentConfig = config;
-    let metaConfigured = false;
-    let levelUsed = false;
-    for (const cfg of config.loggers) {
-        if (isLoggerConfigMeta(cfg)) {
-            metaConfigured = true;
-        }
-        const logger = LoggerImpl.getLogger(cfg.category);
-        for (const sinkId of cfg.sinks ?? []) {
-            const sink = config.sinks[sinkId];
-            if (!sink) {
-                throw new ConfigError(`Sink not found: ${sinkId}.`);
-            }
-            logger.sinks.push(sink);
-        }
-        logger.parentSinks = cfg.parentSinks ?? "inherit";
-        if (cfg.lowestLevel !== undefined) {
-            logger.lowestLevel = cfg.lowestLevel;
-        }
-        if (cfg.level !== undefined) {
-            levelUsed = true;
-            logger.filters.push(toFilter(cfg.level));
-        }
-        for (const filterId of cfg.filters ?? []) {
-            const filter = config.filters?.[filterId];
-            if (filter === undefined) {
-                throw new ConfigError(`Filter not found: ${filterId}.`);
-            }
-            logger.filters.push(toFilter(filter));
-        }
-        strongRefs.add(logger);
-    }
-    LoggerImpl.getLogger().contextLocalStorage = config.contextLocalStorage;
-    for (const sink of Object.values(config.sinks)) {
-        if (Symbol.asyncDispose in sink) {
-            if (allowAsync)
-                asyncDisposables.add(sink);
-            else {
-                throw new ConfigError("Async disposables cannot be used with configureSync().");
-            }
-        }
-        if (Symbol.dispose in sink)
-            disposables.add(sink);
-    }
-    for (const filter of Object.values(config.filters ?? {})) {
-        if (filter == null || typeof filter === "string")
-            continue;
-        if (Symbol.asyncDispose in filter) {
-            if (allowAsync)
-                asyncDisposables.add(filter);
-            else {
-                throw new ConfigError("Async disposables cannot be used with configureSync().");
-            }
-        }
-        if (Symbol.dispose in filter)
-            disposables.add(filter);
-    }
-    if ("process" in dntShim.dntGlobalThis && !("Deno" in dntShim.dntGlobalThis)) {
-        // @ts-ignore: It's fine to use process in Node
-        // deno-lint-ignore no-process-global
-        process.on("exit", allowAsync ? dispose : disposeSync);
-    }
-    else {
-        // @ts-ignore: It's fine to addEventListener() on the browser/Deno
-        addEventListener("unload", allowAsync ? dispose : disposeSync);
-    }
-    const meta = LoggerImpl.getLogger(["logtape", "meta"]);
-    if (!metaConfigured) {
-        meta.sinks.push(getConsoleSink());
-    }
-    meta.info("LogTape loggers are configured.  Note that LogTape itself uses the meta " +
-        "logger, which has category {metaLoggerCategory}.  The meta logger " +
-        "purposes to log internal errors such as sink exceptions.  If you " +
-        "are seeing this message, the meta logger is automatically configured.  " +
-        "It's recommended to configure the meta logger with a separate sink " +
-        "so that you can easily notice if logging itself fails or is " +
-        "misconfigured.  To turn off this message, configure the meta logger " +
-        "with higher log levels than {dismissLevel}.  See also " +
-        "<https://logtape.org/manual/categories#meta-logger>.", { metaLoggerCategory: ["logtape", "meta"], dismissLevel: "info" });
-    if (levelUsed) {
-        meta.warn("The level option is deprecated in favor of lowestLevel option.  " +
-            "Please update your configuration.  See also " +
-            "<https://logtape.org/manual/levels#configuring-severity-levels>.");
-    }
-}
-/**
- * Get the current configuration, if any.  Otherwise, `null`.
- * @returns The current configuration, if any.  Otherwise, `null`.
- */
-export function getConfig() {
-    return currentConfig;
-}
-/**
- * Reset the configuration.  Mostly for testing purposes.
- */
-export async function reset() {
-    await dispose();
-    resetInternal();
-}
-/**
- * Reset the configuration.  Mostly for testing purposes. Will not clear async
- * sinks, only use with sync sinks. Use {@link reset} if you have async sinks.
- * @since 0.9.0
- */
-export function resetSync() {
-    disposeSync();
-    resetInternal();
-}
-function resetInternal() {
-    const rootLogger = LoggerImpl.getLogger([]);
-    rootLogger.resetDescendants();
-    delete rootLogger.contextLocalStorage;
-    strongRefs.clear();
-    currentConfig = null;
-}
-/**
- * Dispose of the disposables.
- */
-export async function dispose() {
-    disposeSync();
-    const promises = [];
-    for (const disposable of asyncDisposables) {
-        promises.push(disposable[Symbol.asyncDispose]());
-        asyncDisposables.delete(disposable);
-    }
-    await Promise.all(promises);
-}
-/**
- * Dispose of the sync disposables. Async disposables will be untouched,
- * use {@link dispose} if you have async sinks.
- * @since 0.9.0
- */
-export function disposeSync() {
-    for (const disposable of disposables)
-        disposable[Symbol.dispose]();
-    disposables.clear();
-}
-/**
- * A configuration error.
- */
-export class ConfigError extends Error {
-    /**
-     * Constructs a new configuration error.
-     * @param message The error message.
-     */
-    constructor(message) {
-        super(message);
-        this.name = "ConfigureError";
-    }
-}

package/esm/logtape/context.js

@@ -1,23 +0,0 @@
-import { LoggerImpl } from "./logger.js";
-/**
- * Runs a callback with the given implicit context.  Every single log record
- * in the callback will have the given context.
- *
- * If no `contextLocalStorage` is configured, this function does nothing and
- * just returns the return value of the callback.  It also logs a warning to
- * the `["logtape", "meta"]` logger in this case.
- * @param context The context to inject.
- * @param callback The callback to run.
- * @returns The return value of the callback.
- * @since 0.7.0
- */
-export function withContext(context, callback) {
-    const rootLogger = LoggerImpl.getLogger();
-    if (rootLogger.contextLocalStorage == null) {
-        LoggerImpl.getLogger(["logtape", "meta"]).warn("Context-local storage is not configured.  " +
-            "Specify contextLocalStorage option in the configure() function.");
-        return callback();
-    }
-    const parentContext = rootLogger.contextLocalStorage.getStore() ?? {};
-    return rootLogger.contextLocalStorage.run({ ...parentContext, ...context }, callback);
-}

package/esm/logtape/filter.js

@@ -1,42 +0,0 @@
-/**
- * Converts a {@link FilterLike} value to an actual {@link Filter}.
- *
- * @param filter The filter-like value to convert.
- * @returns The actual filter.
- */
-export function toFilter(filter) {
-    if (typeof filter === "function")
-        return filter;
-    return getLevelFilter(filter);
-}
-/**
- * Returns a filter that accepts log records with the specified level.
- *
- * @param level The level to filter by.  If `null`, the filter will reject all
- *              records.
- * @returns The filter.
- */
-export function getLevelFilter(level) {
-    if (level == null)
-        return () => false;
-    if (level === "fatal") {
-        return (record) => record.level === "fatal";
-    }
-    else if (level === "error") {
-        return (record) => record.level === "fatal" || record.level === "error";
-    }
-    else if (level === "warning") {
-        return (record) => record.level === "fatal" ||
-            record.level === "error" ||
-            record.level === "warning";
-    }
-    else if (level === "info") {
-        return (record) => record.level === "fatal" ||
-            record.level === "error" ||
-            record.level === "warning" ||
-            record.level === "info";
-    }
-    else if (level === "debug")
-        return () => true;
-    throw new TypeError(`Invalid log level: ${level}.`);
-}