@zthun/lumberjacky-sentry 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Anthony Bonta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+# Lumberjacky Log
+
+This is the root log framework that includes the interfaces and cross framework loggers that can be used without the
+need of any framework.
+
+## Usage
+
+```sh
+npm install @zthun/lumberjacky-log
+yarn add @zthun/lumberjacky-log
+```
+
+There are 3 loggers that are added in this package that are given to you by default.
+
+| Logger    | Description                                                                                                                        |
+| --------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| Console   | Basic console logger that uses the lumberjacky interface                                                                           |
+| Composite | Composite logger that logs to multiple sources                                                                                     |
+| Silent    | Silent logger used for unit tests                                                                                                  |
+| Context   | Special logger that includes context information for logging. This is framework dependant. Basic console logging doesn't use this. |

package/dist/index.cjs

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const lumberjackyLog = require("@zthun/lumberjacky-log");
+const _ZLoggerSentry = class _ZLoggerSentry {
+  /**
+   * Initializes a new instance of this object.
+   *
+   * @param _client -
+   *        The sentry client to log to.
+   */
+  constructor(_client) {
+    this._client = _client;
+  }
+  log(entry) {
+    this._client.captureEvent({
+      message: entry.message,
+      level: _ZLoggerSentry.SeverityMap[entry.level],
+      extra: {
+        context: entry.context
+      }
+    });
+  }
+};
+_ZLoggerSentry.SeverityMap = Object.freeze({
+  [lumberjackyLog.ZLogLevel.CATASTROPHE]: "fatal",
+  [lumberjackyLog.ZLogLevel.ERROR]: "error",
+  [lumberjackyLog.ZLogLevel.WARNING]: "warning",
+  [lumberjackyLog.ZLogLevel.INFO]: "info"
+});
+let ZLoggerSentry = _ZLoggerSentry;
+exports.ZLoggerSentry = ZLoggerSentry;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/logger/logger-sentry.mts"],"sourcesContent":["import { Client, SeverityLevel } from '@sentry/types';\nimport { IZLogEntry, IZLogger, ZLogLevel } from '@zthun/lumberjacky-log';\n\n/**\n * A logger that logs to sentry (https://sentry.io)\n */\nexport class ZLoggerSentry implements IZLogger {\n  private static readonly SeverityMap: Record<ZLogLevel, SeverityLevel> = Object.freeze({\n    [ZLogLevel.CATASTROPHE]: 'fatal',\n    [ZLogLevel.ERROR]: 'error',\n    [ZLogLevel.WARNING]: 'warning',\n    [ZLogLevel.INFO]: 'info'\n  });\n\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _client -\n   *        The sentry client to log to.\n   */\n  public constructor(private _client: Client) {}\n\n  public log(entry: IZLogEntry): void {\n    this._client.captureEvent({\n      message: entry.message,\n      level: ZLoggerSentry.SeverityMap[entry.level],\n      extra: {\n        context: entry.context\n      }\n    });\n  }\n}\n"],"names":["ZLogLevel"],"mappings":";;;AAMO,MAAM,iBAAN,MAAM,eAAkC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EActC,YAAoB,SAAiB;AAAjB,SAAA,UAAA;AAAA,EAAkB;AAAA,EAEtC,IAAI,OAAyB;AAClC,SAAK,QAAQ,aAAa;AAAA,MACxB,SAAS,MAAM;AAAA,MACf,OAAO,eAAc,YAAY,MAAM,KAAK;AAAA,MAC5C,OAAO;AAAA,QACL,SAAS,MAAM;AAAA,MACjB;AAAA,IAAA,CACD;AAAA,EACH;AACF;AAxB0B,eAAA,cAAgD,OAAO,OAAO;AAAA,EACpF,CAACA,eAAAA,UAAU,WAAW,GAAG;AAAA,EACzB,CAACA,eAAAA,UAAU,KAAK,GAAG;AAAA,EACnB,CAACA,eAAAA,UAAU,OAAO,GAAG;AAAA,EACrB,CAACA,eAAAA,UAAU,IAAI,GAAG;AAAA,CACnB;AANI,IAAM,gBAAN;;"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './logger/logger-sentry.mjs';

package/dist/index.js

@@ -0,0 +1,32 @@
+import { ZLogLevel } from "@zthun/lumberjacky-log";
+const _ZLoggerSentry = class _ZLoggerSentry {
+  /**
+   * Initializes a new instance of this object.
+   *
+   * @param _client -
+   *        The sentry client to log to.
+   */
+  constructor(_client) {
+    this._client = _client;
+  }
+  log(entry) {
+    this._client.captureEvent({
+      message: entry.message,
+      level: _ZLoggerSentry.SeverityMap[entry.level],
+      extra: {
+        context: entry.context
+      }
+    });
+  }
+};
+_ZLoggerSentry.SeverityMap = Object.freeze({
+  [ZLogLevel.CATASTROPHE]: "fatal",
+  [ZLogLevel.ERROR]: "error",
+  [ZLogLevel.WARNING]: "warning",
+  [ZLogLevel.INFO]: "info"
+});
+let ZLoggerSentry = _ZLoggerSentry;
+export {
+  ZLoggerSentry
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/logger/logger-sentry.mts"],"sourcesContent":["import { Client, SeverityLevel } from '@sentry/types';\nimport { IZLogEntry, IZLogger, ZLogLevel } from '@zthun/lumberjacky-log';\n\n/**\n * A logger that logs to sentry (https://sentry.io)\n */\nexport class ZLoggerSentry implements IZLogger {\n  private static readonly SeverityMap: Record<ZLogLevel, SeverityLevel> = Object.freeze({\n    [ZLogLevel.CATASTROPHE]: 'fatal',\n    [ZLogLevel.ERROR]: 'error',\n    [ZLogLevel.WARNING]: 'warning',\n    [ZLogLevel.INFO]: 'info'\n  });\n\n  /**\n   * Initializes a new instance of this object.\n   *\n   * @param _client -\n   *        The sentry client to log to.\n   */\n  public constructor(private _client: Client) {}\n\n  public log(entry: IZLogEntry): void {\n    this._client.captureEvent({\n      message: entry.message,\n      level: ZLoggerSentry.SeverityMap[entry.level],\n      extra: {\n        context: entry.context\n      }\n    });\n  }\n}\n"],"names":[],"mappings":";AAMO,MAAM,iBAAN,MAAM,eAAkC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EActC,YAAoB,SAAiB;AAAjB,SAAA,UAAA;AAAA,EAAkB;AAAA,EAEtC,IAAI,OAAyB;AAClC,SAAK,QAAQ,aAAa;AAAA,MACxB,SAAS,MAAM;AAAA,MACf,OAAO,eAAc,YAAY,MAAM,KAAK;AAAA,MAC5C,OAAO;AAAA,QACL,SAAS,MAAM;AAAA,MACjB;AAAA,IAAA,CACD;AAAA,EACH;AACF;AAxB0B,eAAA,cAAgD,OAAO,OAAO;AAAA,EACpF,CAAC,UAAU,WAAW,GAAG;AAAA,EACzB,CAAC,UAAU,KAAK,GAAG;AAAA,EACnB,CAAC,UAAU,OAAO,GAAG;AAAA,EACrB,CAAC,UAAU,IAAI,GAAG;AAAA,CACnB;AANI,IAAM,gBAAN;"}

package/dist/logger/logger-sentry.d.mts

@@ -0,0 +1,18 @@
+import { Client } from '@sentry/types';
+import { IZLogEntry, IZLogger } from '@zthun/lumberjacky-log';
+
+/**
+ * A logger that logs to sentry (https://sentry.io)
+ */
+export declare class ZLoggerSentry implements IZLogger {
+    private _client;
+    private static readonly SeverityMap;
+    /**
+     * Initializes a new instance of this object.
+     *
+     * @param _client -
+     *        The sentry client to log to.
+     */
+    constructor(_client: Client);
+    log(entry: IZLogEntry): void;
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@zthun/lumberjacky-sentry",
+  "version": "2.1.0",
+  "description": "A standard lumberjacky log interface to interact with sentry.",
+  "author": "Anthony Bonta",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zthun/lumberjacky",
+    "directory": "packages/lumberjacky-sentry"
+  },
+  "keywords": [
+    "lumberjacky",
+    "logging",
+    "log",
+    "console"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    "require": "./dist/index.cjs",
+    "import": "./dist/index.js",
+    "types": "./dist/index.d.ts"
+  },
+  "scripts": {
+    "build": "vite build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@sentry/types": "^8.19.0",
+    "@zthun/lumberjacky-log": "^2.1.0",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.3",
+    "vite": "^5.3.4",
+    "vitest": "^2.0.4",
+    "vitest-mock-extended": "^1.3.2"
+  },
+  "peerDependencies": {
+    "@sentry/browser": "^8.19.0",
+    "@sentry/node": "^8.19.0",
+    "@sentry/react": "^8.19.0",
+    "@sentry/types": "^8.19.0"
+  },
+  "peerDependenciesMeta": {
+    "@sentry/browser": {
+      "optional": true
+    },
+    "@sentry/node": {
+      "optional": true
+    },
+    "@sentry/react": {
+      "optional": true
+    },
+    "@sentry/types": {
+      "optional": true
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "gitHead": "6d434273c74adc43996a1409e00ffd54debc84f4"
+}