@loglayer/transport-roarr 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Theo Gravity
+
+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,46 @@
+# Roarr Transport for LogLayer
+
+[![NPM version](https://img.shields.io/npm/v/@loglayer/transport-roarr.svg?style=flat-square)](https://www.npmjs.com/package/@loglayer/transport-roarr)
+![NPM Downloads](https://img.shields.io/npm/dm/@loglayer/transport-roarr)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+
+[Roarr](https://github.com/gajus/roarr) is a JSON logger for Node.js and browser environments.
+
+## Installation
+
+```bash
+npm install loglayer @loglayer/transport-roarr roarr serialize-error
+```
+
+## Usage
+
+### Node.js Environment Setup
+```bash
+ROARR_LOG=true node your-app.js
+```
+
+### Browser Environment Setup
+```typescript
+window.ROARR = {
+  enabled: true
+}
+```
+
+### Implementation
+```typescript
+import { Roarr as r } from 'roarr'
+import { LogLayer } from 'loglayer'
+import { RoarrTransport } from "@loglayer/transport-roarr"
+import { serializeError } from 'serialize-error'
+
+const log = new LogLayer({
+  transport: new RoarrTransport({
+    logger: r
+  }),
+  errorSerializer: serializeError  // Roarr requires error serialization
+})
+```
+
+## Documentation
+
+For more details, visit [https://loglayer.dev/transports/roarr](https://loglayer.dev/transports/roarr)

package/dist/index.cjs

@@ -0,0 +1,37 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/RoarrTransport.ts
+var _transport = require('@loglayer/transport');
+var RoarrTransport = class extends _transport.BaseTransport {
+  shipToLogger({ logLevel, messages, data, hasData }) {
+    if (messages.length === 0) {
+      messages = [""];
+    }
+    if (data && hasData) {
+      messages.unshift(data);
+    }
+    switch (logLevel) {
+      case _transport.LogLevel.info:
+        this.logger.info(...messages);
+        break;
+      case _transport.LogLevel.warn:
+        this.logger.warn(...messages);
+        break;
+      case _transport.LogLevel.error:
+        this.logger.error(...messages);
+        break;
+      case _transport.LogLevel.trace:
+        this.logger.trace(...messages);
+        break;
+      case _transport.LogLevel.debug:
+        this.logger.debug(...messages);
+        break;
+      case _transport.LogLevel.fatal:
+        this.logger.fatal(...messages);
+        break;
+    }
+    return messages;
+  }
+};
+
+
+exports.RoarrTransport = RoarrTransport;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/loglayer/loglayer/packages/transports/roarr/dist/index.cjs","../src/RoarrTransport.ts"],"names":[],"mappings":"AAAA;ACAA,gDAAsE;AAG/D,IAAM,eAAA,EAAN,MAAA,QAA6B,yBAAsB;AAAA,EACxD,YAAA,CAAa,EAAE,QAAA,EAAU,QAAA,EAAU,IAAA,EAAM,QAAQ,CAAA,EAA4B;AAC3E,IAAA,GAAA,CAAI,QAAA,CAAS,OAAA,IAAW,CAAA,EAAG;AAEzB,MAAA,SAAA,EAAW,CAAC,EAAE,CAAA;AAAA,IAChB;AAEA,IAAA,GAAA,CAAI,KAAA,GAAQ,OAAA,EAAS;AAEnB,MAAA,QAAA,CAAS,OAAA,CAAQ,IAAI,CAAA;AAAA,IACvB;AAEA,IAAA,OAAA,CAAQ,QAAA,EAAU;AAAA,MAChB,KAAK,mBAAA,CAAS,IAAA;AAEZ,QAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,GAAG,QAAQ,CAAA;AAC5B,QAAA,KAAA;AAAA,MACF,KAAK,mBAAA,CAAS,IAAA;AAEZ,QAAA,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,GAAG,QAAQ,CAAA;AAC5B,QAAA,KAAA;AAAA,MACF,KAAK,mBAAA,CAAS,KAAA;AAEZ,QAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM,GAAG,QAAQ,CAAA;AAC7B,QAAA,KAAA;AAAA,MACF,KAAK,mBAAA,CAAS,KAAA;AAEZ,QAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM,GAAG,QAAQ,CAAA;AAC7B,QAAA,KAAA;AAAA,MACF,KAAK,mBAAA,CAAS,KAAA;AAEZ,QAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM,GAAG,QAAQ,CAAA;AAC7B,QAAA,KAAA;AAAA,MACF,KAAK,mBAAA,CAAS,KAAA;AAEZ,QAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAM,GAAG,QAAQ,CAAA;AAC7B,QAAA,KAAA;AAAA,IACJ;AAEA,IAAA,OAAO,QAAA;AAAA,EACT;AACF,CAAA;ADXA;AACE;AACF,wCAAC","file":"/home/runner/work/loglayer/loglayer/packages/transports/roarr/dist/index.cjs","sourcesContent":[null,"import { BaseTransport, type LogLayerTransportParams, LogLevel } from \"@loglayer/transport\";\nimport type { Logger } from \"roarr\";\n\nexport class RoarrTransport extends BaseTransport<Logger> {\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams) {\n    if (messages.length === 0) {\n      // Roarr needs a message defined\n      messages = [\"\"];\n    }\n\n    if (data && hasData) {\n      // put object data as the first parameter\n      messages.unshift(data);\n    }\n\n    switch (logLevel) {\n      case LogLevel.info:\n        // @ts-ignore\n        this.logger.info(...messages);\n        break;\n      case LogLevel.warn:\n        // @ts-ignore\n        this.logger.warn(...messages);\n        break;\n      case LogLevel.error:\n        // @ts-ignore\n        this.logger.error(...messages);\n        break;\n      case LogLevel.trace:\n        // @ts-ignore\n        this.logger.trace(...messages);\n        break;\n      case LogLevel.debug:\n        // @ts-ignore\n        this.logger.debug(...messages);\n        break;\n      case LogLevel.fatal:\n        // @ts-ignore\n        this.logger.fatal(...messages);\n        break;\n    }\n\n    return messages;\n  }\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,8 @@
+import { BaseTransport, LogLayerTransportParams } from '@loglayer/transport';
+import { Logger } from 'roarr';
+
+declare class RoarrTransport extends BaseTransport<Logger> {
+    shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[];
+}
+
+export { RoarrTransport };

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { BaseTransport, LogLayerTransportParams } from '@loglayer/transport';
+import { Logger } from 'roarr';
+
+declare class RoarrTransport extends BaseTransport<Logger> {
+    shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams): any[];
+}
+
+export { RoarrTransport };

package/dist/index.js

@@ -0,0 +1,37 @@
+// src/RoarrTransport.ts
+import { BaseTransport, LogLevel } from "@loglayer/transport";
+var RoarrTransport = class extends BaseTransport {
+  shipToLogger({ logLevel, messages, data, hasData }) {
+    if (messages.length === 0) {
+      messages = [""];
+    }
+    if (data && hasData) {
+      messages.unshift(data);
+    }
+    switch (logLevel) {
+      case LogLevel.info:
+        this.logger.info(...messages);
+        break;
+      case LogLevel.warn:
+        this.logger.warn(...messages);
+        break;
+      case LogLevel.error:
+        this.logger.error(...messages);
+        break;
+      case LogLevel.trace:
+        this.logger.trace(...messages);
+        break;
+      case LogLevel.debug:
+        this.logger.debug(...messages);
+        break;
+      case LogLevel.fatal:
+        this.logger.fatal(...messages);
+        break;
+    }
+    return messages;
+  }
+};
+export {
+  RoarrTransport
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/RoarrTransport.ts"],"sourcesContent":["import { BaseTransport, type LogLayerTransportParams, LogLevel } from \"@loglayer/transport\";\nimport type { Logger } from \"roarr\";\n\nexport class RoarrTransport extends BaseTransport<Logger> {\n  shipToLogger({ logLevel, messages, data, hasData }: LogLayerTransportParams) {\n    if (messages.length === 0) {\n      // Roarr needs a message defined\n      messages = [\"\"];\n    }\n\n    if (data && hasData) {\n      // put object data as the first parameter\n      messages.unshift(data);\n    }\n\n    switch (logLevel) {\n      case LogLevel.info:\n        // @ts-ignore\n        this.logger.info(...messages);\n        break;\n      case LogLevel.warn:\n        // @ts-ignore\n        this.logger.warn(...messages);\n        break;\n      case LogLevel.error:\n        // @ts-ignore\n        this.logger.error(...messages);\n        break;\n      case LogLevel.trace:\n        // @ts-ignore\n        this.logger.trace(...messages);\n        break;\n      case LogLevel.debug:\n        // @ts-ignore\n        this.logger.debug(...messages);\n        break;\n      case LogLevel.fatal:\n        // @ts-ignore\n        this.logger.fatal(...messages);\n        break;\n    }\n\n    return messages;\n  }\n}\n"],"mappings":";AAAA,SAAS,eAA6C,gBAAgB;AAG/D,IAAM,iBAAN,cAA6B,cAAsB;AAAA,EACxD,aAAa,EAAE,UAAU,UAAU,MAAM,QAAQ,GAA4B;AAC3E,QAAI,SAAS,WAAW,GAAG;AAEzB,iBAAW,CAAC,EAAE;AAAA,IAChB;AAEA,QAAI,QAAQ,SAAS;AAEnB,eAAS,QAAQ,IAAI;AAAA,IACvB;AAEA,YAAQ,UAAU;AAAA,MAChB,KAAK,SAAS;AAEZ,aAAK,OAAO,KAAK,GAAG,QAAQ;AAC5B;AAAA,MACF,KAAK,SAAS;AAEZ,aAAK,OAAO,KAAK,GAAG,QAAQ;AAC5B;AAAA,MACF,KAAK,SAAS;AAEZ,aAAK,OAAO,MAAM,GAAG,QAAQ;AAC7B;AAAA,MACF,KAAK,SAAS;AAEZ,aAAK,OAAO,MAAM,GAAG,QAAQ;AAC7B;AAAA,MACF,KAAK,SAAS;AAEZ,aAAK,OAAO,MAAM,GAAG,QAAQ;AAC7B;AAAA,MACF,KAAK,SAAS;AAEZ,aAAK,OAAO,MAAM,GAAG,QAAQ;AAC7B;AAAA,IACJ;AAEA,WAAO;AAAA,EACT;AACF;","names":[]}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@loglayer/transport-roarr",
+  "description": "roarr transport for loglayer.",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    "import": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "require": {
+      "types": "./dist/index.d.cts",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "repository": "loglayer/loglayer.git",
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "roarr",
+    "transport"
+  ],
+  "dependencies": {
+    "@loglayer/transport": "1.0.0"
+  },
+  "devDependencies": {
+    "hash-runner": "2.0.1",
+    "@types/node": "22.10.3",
+    "serialize-error": "11.0.3",
+    "tsup": "8.3.5",
+    "typescript": "5.7.2",
+    "vitest": "2.1.8",
+    "loglayer": "5.0.0",
+    "@internal/tsconfig": "1.0.0"
+  },
+  "peerDependencies": {
+    "roarr": "*"
+  },
+  "bugs": "https://github.com/loglayer/loglayer/issues",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://loglayer.dev",
+  "scripts": {
+    "build": "tsup src/index.ts",
+    "test": "vitest --run",
+    "build:dev": "hash-runner",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --write --unsafe src && biome format src --write && biome lint src --fix",
+    "verify-types": "tsc --noEmit"
+  }
+}