@swipe72/logger 0.1.0

package/README.md

@@ -0,0 +1,59 @@
+# `@swipe72/logger`
+
+A small logger built on top of @swipe72/event-bus.
+
+## Usage
+
+```ts
+import { createEventBus } from "@swipe72/event-bus";
+import { createLogger } from "@swipe72/logger";
+
+const events = createEventBus<{
+  "log.created": {
+    level: "info" | "warn" | "error";
+    scope: string;
+    message: string;
+    timestamp: number;
+  };
+}>();
+
+events.on("log.created", (log) => {
+  console.log(`[${log.level}] [${log.scope}] ${log.message}`);
+});
+
+const logger = createLogger({ events, scope: "app" });
+await logger.info("Application started");
+await logger.warn("Something looks suspicious");
+await logger.error("Something went wrong");
+```
+
+## Child loggers
+
+Child loggers let you create nested scopes while reusing the same event bus.
+
+```ts
+const logger = createLogger({
+  events,
+  scope: "app",
+});
+
+const authLogger = logger.child("auth");
+
+await authLogger.info("User signed in");
+```
+
+This emits a log event with the scope:
+
+`"app.auth"`
+
+## API
+
+`createLogger(options)`
+
+`logger.info(message)`
+
+`logger.warn(message)`
+
+`logger.error(message)`
+
+`logger.child(scope)`

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+type LogLevel = "info" | "warn" | "error";
+type LogPayload = {
+    level: LogLevel;
+    scope: string;
+    message: string;
+    timestamp: number;
+};
+type LoggerEvents = {
+    "log.created": LogPayload;
+};
+type LoggerEventTarget = {
+    emit(event: "log.created", payload: LogPayload): Promise<void>;
+};
+type CreateLoggerOptions<Scope extends string> = {
+    events: LoggerEventTarget;
+    scope: Scope;
+};
+type Logger<Scope extends string = string> = {
+    scope: Scope;
+    info(message: string): Promise<void>;
+    warn(message: string): Promise<void>;
+    error(message: string): Promise<void>;
+    child<const ChildScope extends string>(scope: ChildScope): Logger<`${Scope}.${ChildScope}`>;
+};
+
+declare function createLogger<const Scope extends string>({ events, scope, }: CreateLoggerOptions<Scope>): Logger<Scope>;
+
+export { type CreateLoggerOptions, type LogLevel, type LogPayload, type Logger, type LoggerEventTarget, type LoggerEvents, createLogger };

package/dist/index.js

@@ -0,0 +1,40 @@
+// src/create-logger.ts
+function createLogger({
+  events,
+  scope
+}) {
+  async function log(level, message) {
+    await events.emit("log.created", {
+      level,
+      scope,
+      message,
+      timestamp: Date.now()
+    });
+  }
+  function info(message) {
+    return log("info", message);
+  }
+  function warn(message) {
+    return log("warn", message);
+  }
+  function error(message) {
+    return log("error", message);
+  }
+  function child(childScope) {
+    return createLogger({
+      events,
+      scope: `${scope}.${childScope}`
+    });
+  }
+  return {
+    scope,
+    info,
+    warn,
+    error,
+    child
+  };
+}
+export {
+  createLogger
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/create-logger.ts"],"sourcesContent":["import type { Logger, LogLevel, CreateLoggerOptions } from \"./types\";\n\nexport function createLogger<const Scope extends string>({\n  events,\n  scope,\n}: CreateLoggerOptions<Scope>): Logger<Scope> {\n  /**\n   * Log an event\n   *\n   * @param level\n   * @param message\n   */\n  async function log(level: LogLevel, message: string) {\n    await events.emit(\"log.created\", {\n      level,\n      scope,\n      message,\n      timestamp: Date.now(),\n    });\n  }\n\n  /**\n   * Log an info event\n   *\n   * @param message\n   */\n  function info(message: string) {\n    return log(\"info\", message);\n  }\n\n  /**\n   * Log an warn event\n   *\n   * @param message\n   */\n  function warn(message: string) {\n    return log(\"warn\", message);\n  }\n\n  /**\n   * Log an error event\n   *\n   * @param message\n   * @returns\n   */\n  function error(message: string) {\n    return log(\"error\", message);\n  }\n\n  function child<const ChildScope extends string>(\n    childScope: ChildScope,\n  ): Logger<`${Scope}.${ChildScope}`> {\n    return createLogger({\n      events,\n      scope: `${scope}.${childScope}` as `${Scope}.${ChildScope}`,\n    });\n  }\n\n  return {\n    scope,\n    info,\n    warn,\n    error,\n    child,\n  };\n}\n"],"mappings":";AAEO,SAAS,aAAyC;AAAA,EACvD;AAAA,EACA;AACF,GAA8C;AAO5C,iBAAe,IAAI,OAAiB,SAAiB;AACnD,UAAM,OAAO,KAAK,eAAe;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,MACA,WAAW,KAAK,IAAI;AAAA,IACtB,CAAC;AAAA,EACH;AAOA,WAAS,KAAK,SAAiB;AAC7B,WAAO,IAAI,QAAQ,OAAO;AAAA,EAC5B;AAOA,WAAS,KAAK,SAAiB;AAC7B,WAAO,IAAI,QAAQ,OAAO;AAAA,EAC5B;AAQA,WAAS,MAAM,SAAiB;AAC9B,WAAO,IAAI,SAAS,OAAO;AAAA,EAC7B;AAEA,WAAS,MACP,YACkC;AAClC,WAAO,aAAa;AAAA,MAClB;AAAA,MACA,OAAO,GAAG,KAAK,IAAI,UAAU;AAAA,IAC/B,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@swipe72/logger",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "vitest": "^4.1.7"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/swipe72/npm-packages.git",
+    "directory": "packages/logger"
+  },
+  "homepage": "https://github.com/swipe72/npm-packages/tree/main/packages/logger",
+  "bugs": {
+    "url": "https://github.com/swipe72/npm-packages/issues"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier . --write --ignore-path ../../.prettierignore",
+    "format:check": "prettier . --check --ignore-path ../../.prettierignore"
+  }
+}