@loglayer/transport-logflare 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 LogLayer
+
+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,49 @@
+# Logflare Transport for LogLayer
+
+[![NPM Version](https://img.shields.io/npm/v/%40loglayer%2Ftransport-logflare)](https://www.npmjs.com/package/@loglayer/transport-logflare)
+[![NPM Downloads](https://img.shields.io/npm/dm/%40loglayer%2Ftransport-logflare)](https://www.npmjs.com/package/@loglayer/transport-logflare)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+
+A Logflare transport for the [LogLayer](https://loglayer.dev) logging library.
+
+Ships logs to [Logflare](https://logflare.app) using the HTTP transport with Logflare-specific configuration. Features include:
+- Automatic Logflare JSON format
+- Built on top of the robust HTTP transport
+- Retry logic with exponential backoff
+- Rate limiting support
+- Batch sending with configurable size and timeout
+- Error and debug callbacks
+- Support for self-hosted Logflare instances
+
+## Installation
+
+```bash
+npm install loglayer @loglayer/transport-logflare serialize-error
+```
+
+## Usage
+
+```typescript
+import { LogLayer } from 'loglayer'
+import { LogflareTransport } from "@loglayer/transport-logflare"
+import { serializeError } from "serialize-error";
+
+const log = new LogLayer({
+  errorSerializer: serializeError,
+  contextFieldName: null, // recommended based on testing
+  metadataFieldName: null, // recommended based on testing
+  transport: new LogflareTransport({
+    sourceId: "YOUR-SOURCE-ID",
+    apiKey: "YOUR-API-KEY",
+
+  })
+})
+
+// Use the logger
+log.info("This is a test message");
+log.withMetadata({ userId: "123" }).error("User not found");
+```
+
+## Documentation
+
+For more details, visit [https://loglayer.dev/transports/logflare](https://loglayer.dev/transports/logflare)

package/dist/index.cjs

@@ -0,0 +1,67 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  LogflareTransport: () => LogflareTransport
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/LogflareTransport.ts
+var import_transport_http = require("@loglayer/transport-http");
+var LogflareTransport = class extends import_transport_http.HttpTransport {
+  constructor(config) {
+    const apiEndpoint = config.url ?? "https://api.logflare.app";
+    const fullUrl = `${apiEndpoint}/logs/json?source=${config.sourceId}`;
+    const payloadTemplate = config.payloadTemplate ?? (({ logLevel, message, data }) => {
+      const logEntry = {
+        message
+      };
+      if (data) {
+        logEntry.metadata = data;
+      }
+      return JSON.stringify(logEntry);
+    });
+    const httpConfig = { ...config };
+    delete httpConfig.sourceId;
+    delete httpConfig.apiKey;
+    delete httpConfig.url;
+    delete httpConfig.payloadTemplate;
+    super({
+      url: fullUrl,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json; charset=utf-8",
+        "X-API-KEY": config.apiKey
+      },
+      payloadTemplate,
+      batchMode: "field",
+      // Use Logflare's batch format
+      batchFieldName: "batch",
+      // Use Logflare's batch field name
+      ...httpConfig
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  LogflareTransport
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/LogflareTransport.ts"],"sourcesContent":["export { LogflareTransport, type LogflareTransportConfig } from \"./LogflareTransport.js\";\n","import type { HttpTransportConfig } from \"@loglayer/transport-http\";\nimport { HttpTransport } from \"@loglayer/transport-http\";\n\n/**\n * Configuration options for the Logflare transport.\n * This is essentially a wrapper around HttpTransport with Logflare specific defaults.\n */\nexport interface LogflareTransportConfig extends Omit<HttpTransportConfig, \"url\" | \"headers\" | \"payloadTemplate\"> {\n  /**\n   * Your Logflare source ID\n   */\n  sourceId: string;\n  /**\n   * Your Logflare API key\n   */\n  apiKey: string;\n  /**\n   * Custom Logflare API endpoint (for self-hosted instances)\n   * @default \"https://api.logflare.app\"\n   */\n  url?: string;\n  /**\n   * Function to transform log data into the payload format (optional, defaults to Logflare format)\n   */\n  payloadTemplate?: (data: { logLevel: string; message: string; data?: Record<string, any> }) => string;\n}\n\n/**\n * LogflareTransport is responsible for sending logs to Logflare.\n * It extends HttpTransport with Logflare-specific configuration.\n *\n * Features:\n * - Automatic Logflare JSON format\n * - Retry logic with exponential backoff (via HttpTransport)\n * - Rate limiting support (via HttpTransport)\n * - Batch sending with configurable size and timeout (via HttpTransport)\n * - Error and debug callbacks\n * - Support for self-hosted Logflare instances\n */\nexport class LogflareTransport extends HttpTransport {\n  constructor(config: LogflareTransportConfig) {\n    const apiEndpoint = config.url ?? \"https://api.logflare.app\";\n    const fullUrl = `${apiEndpoint}/logs/json?source=${config.sourceId}`;\n\n    const payloadTemplate = config.payloadTemplate ?? (({ logLevel, message, data }) => {\n      const logEntry: Record<string, any> = {\n        message,\n      };\n\n      // Only add metadata if data is provided\n      if (data) {\n        logEntry.metadata = data;\n      }\n\n      return JSON.stringify(logEntry);\n    });\n\n    // Create HTTP transport config, excluding Logflare-specific properties\n    const httpConfig = { ...config };\n    delete httpConfig.sourceId;\n    delete httpConfig.apiKey;\n    delete httpConfig.url;\n    delete httpConfig.payloadTemplate;\n\n    super({\n      url: fullUrl,\n      method: \"POST\",\n      headers: {\n        \"Content-Type\": \"application/json; charset=utf-8\",\n        \"X-API-KEY\": config.apiKey,\n      },\n      payloadTemplate,\n      batchMode: \"field\", // Use Logflare's batch format\n      batchFieldName: \"batch\", // Use Logflare's batch field name\n      ...httpConfig,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,4BAA8B;AAsCvB,IAAM,oBAAN,cAAgC,oCAAc;AAAA,EACnD,YAAY,QAAiC;AAC3C,UAAM,cAAc,OAAO,OAAO;AAClC,UAAM,UAAU,GAAG,WAAW,qBAAqB,OAAO,QAAQ;AAElE,UAAM,kBAAkB,OAAO,oBAAoB,CAAC,EAAE,UAAU,SAAS,KAAK,MAAM;AAClF,YAAM,WAAgC;AAAA,QACpC;AAAA,MACF;AAGA,UAAI,MAAM;AACR,iBAAS,WAAW;AAAA,MACtB;AAEA,aAAO,KAAK,UAAU,QAAQ;AAAA,IAChC;AAGA,UAAM,aAAa,EAAE,GAAG,OAAO;AAC/B,WAAO,WAAW;AAClB,WAAO,WAAW;AAClB,WAAO,WAAW;AAClB,WAAO,WAAW;AAElB,UAAM;AAAA,MACJ,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,aAAa,OAAO;AAAA,MACtB;AAAA,MACA;AAAA,MACA,WAAW;AAAA;AAAA,MACX,gBAAgB;AAAA;AAAA,MAChB,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,46 @@
+import { HttpTransport, HttpTransportConfig } from '@loglayer/transport-http';
+
+/**
+ * Configuration options for the Logflare transport.
+ * This is essentially a wrapper around HttpTransport with Logflare specific defaults.
+ */
+interface LogflareTransportConfig extends Omit<HttpTransportConfig, "url" | "headers" | "payloadTemplate"> {
+    /**
+     * Your Logflare source ID
+     */
+    sourceId: string;
+    /**
+     * Your Logflare API key
+     */
+    apiKey: string;
+    /**
+     * Custom Logflare API endpoint (for self-hosted instances)
+     * @default "https://api.logflare.app"
+     */
+    url?: string;
+    /**
+     * Function to transform log data into the payload format (optional, defaults to Logflare format)
+     */
+    payloadTemplate?: (data: {
+        logLevel: string;
+        message: string;
+        data?: Record<string, any>;
+    }) => string;
+}
+/**
+ * LogflareTransport is responsible for sending logs to Logflare.
+ * It extends HttpTransport with Logflare-specific configuration.
+ *
+ * Features:
+ * - Automatic Logflare JSON format
+ * - Retry logic with exponential backoff (via HttpTransport)
+ * - Rate limiting support (via HttpTransport)
+ * - Batch sending with configurable size and timeout (via HttpTransport)
+ * - Error and debug callbacks
+ * - Support for self-hosted Logflare instances
+ */
+declare class LogflareTransport extends HttpTransport {
+    constructor(config: LogflareTransportConfig);
+}
+
+export { LogflareTransport, type LogflareTransportConfig };

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { HttpTransport, HttpTransportConfig } from '@loglayer/transport-http';
+
+/**
+ * Configuration options for the Logflare transport.
+ * This is essentially a wrapper around HttpTransport with Logflare specific defaults.
+ */
+interface LogflareTransportConfig extends Omit<HttpTransportConfig, "url" | "headers" | "payloadTemplate"> {
+    /**
+     * Your Logflare source ID
+     */
+    sourceId: string;
+    /**
+     * Your Logflare API key
+     */
+    apiKey: string;
+    /**
+     * Custom Logflare API endpoint (for self-hosted instances)
+     * @default "https://api.logflare.app"
+     */
+    url?: string;
+    /**
+     * Function to transform log data into the payload format (optional, defaults to Logflare format)
+     */
+    payloadTemplate?: (data: {
+        logLevel: string;
+        message: string;
+        data?: Record<string, any>;
+    }) => string;
+}
+/**
+ * LogflareTransport is responsible for sending logs to Logflare.
+ * It extends HttpTransport with Logflare-specific configuration.
+ *
+ * Features:
+ * - Automatic Logflare JSON format
+ * - Retry logic with exponential backoff (via HttpTransport)
+ * - Rate limiting support (via HttpTransport)
+ * - Batch sending with configurable size and timeout (via HttpTransport)
+ * - Error and debug callbacks
+ * - Support for self-hosted Logflare instances
+ */
+declare class LogflareTransport extends HttpTransport {
+    constructor(config: LogflareTransportConfig);
+}
+
+export { LogflareTransport, type LogflareTransportConfig };

package/dist/index.js

@@ -0,0 +1,40 @@
+// src/LogflareTransport.ts
+import { HttpTransport } from "@loglayer/transport-http";
+var LogflareTransport = class extends HttpTransport {
+  constructor(config) {
+    const apiEndpoint = config.url ?? "https://api.logflare.app";
+    const fullUrl = `${apiEndpoint}/logs/json?source=${config.sourceId}`;
+    const payloadTemplate = config.payloadTemplate ?? (({ logLevel, message, data }) => {
+      const logEntry = {
+        message
+      };
+      if (data) {
+        logEntry.metadata = data;
+      }
+      return JSON.stringify(logEntry);
+    });
+    const httpConfig = { ...config };
+    delete httpConfig.sourceId;
+    delete httpConfig.apiKey;
+    delete httpConfig.url;
+    delete httpConfig.payloadTemplate;
+    super({
+      url: fullUrl,
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json; charset=utf-8",
+        "X-API-KEY": config.apiKey
+      },
+      payloadTemplate,
+      batchMode: "field",
+      // Use Logflare's batch format
+      batchFieldName: "batch",
+      // Use Logflare's batch field name
+      ...httpConfig
+    });
+  }
+};
+export {
+  LogflareTransport
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/LogflareTransport.ts"],"sourcesContent":["import type { HttpTransportConfig } from \"@loglayer/transport-http\";\nimport { HttpTransport } from \"@loglayer/transport-http\";\n\n/**\n * Configuration options for the Logflare transport.\n * This is essentially a wrapper around HttpTransport with Logflare specific defaults.\n */\nexport interface LogflareTransportConfig extends Omit<HttpTransportConfig, \"url\" | \"headers\" | \"payloadTemplate\"> {\n  /**\n   * Your Logflare source ID\n   */\n  sourceId: string;\n  /**\n   * Your Logflare API key\n   */\n  apiKey: string;\n  /**\n   * Custom Logflare API endpoint (for self-hosted instances)\n   * @default \"https://api.logflare.app\"\n   */\n  url?: string;\n  /**\n   * Function to transform log data into the payload format (optional, defaults to Logflare format)\n   */\n  payloadTemplate?: (data: { logLevel: string; message: string; data?: Record<string, any> }) => string;\n}\n\n/**\n * LogflareTransport is responsible for sending logs to Logflare.\n * It extends HttpTransport with Logflare-specific configuration.\n *\n * Features:\n * - Automatic Logflare JSON format\n * - Retry logic with exponential backoff (via HttpTransport)\n * - Rate limiting support (via HttpTransport)\n * - Batch sending with configurable size and timeout (via HttpTransport)\n * - Error and debug callbacks\n * - Support for self-hosted Logflare instances\n */\nexport class LogflareTransport extends HttpTransport {\n  constructor(config: LogflareTransportConfig) {\n    const apiEndpoint = config.url ?? \"https://api.logflare.app\";\n    const fullUrl = `${apiEndpoint}/logs/json?source=${config.sourceId}`;\n\n    const payloadTemplate = config.payloadTemplate ?? (({ logLevel, message, data }) => {\n      const logEntry: Record<string, any> = {\n        message,\n      };\n\n      // Only add metadata if data is provided\n      if (data) {\n        logEntry.metadata = data;\n      }\n\n      return JSON.stringify(logEntry);\n    });\n\n    // Create HTTP transport config, excluding Logflare-specific properties\n    const httpConfig = { ...config };\n    delete httpConfig.sourceId;\n    delete httpConfig.apiKey;\n    delete httpConfig.url;\n    delete httpConfig.payloadTemplate;\n\n    super({\n      url: fullUrl,\n      method: \"POST\",\n      headers: {\n        \"Content-Type\": \"application/json; charset=utf-8\",\n        \"X-API-KEY\": config.apiKey,\n      },\n      payloadTemplate,\n      batchMode: \"field\", // Use Logflare's batch format\n      batchFieldName: \"batch\", // Use Logflare's batch field name\n      ...httpConfig,\n    });\n  }\n}\n"],"mappings":";AACA,SAAS,qBAAqB;AAsCvB,IAAM,oBAAN,cAAgC,cAAc;AAAA,EACnD,YAAY,QAAiC;AAC3C,UAAM,cAAc,OAAO,OAAO;AAClC,UAAM,UAAU,GAAG,WAAW,qBAAqB,OAAO,QAAQ;AAElE,UAAM,kBAAkB,OAAO,oBAAoB,CAAC,EAAE,UAAU,SAAS,KAAK,MAAM;AAClF,YAAM,WAAgC;AAAA,QACpC;AAAA,MACF;AAGA,UAAI,MAAM;AACR,iBAAS,WAAW;AAAA,MACtB;AAEA,aAAO,KAAK,UAAU,QAAQ;AAAA,IAChC;AAGA,UAAM,aAAa,EAAE,GAAG,OAAO;AAC/B,WAAO,WAAW;AAClB,WAAO,WAAW;AAClB,WAAO,WAAW;AAClB,WAAO,WAAW;AAElB,UAAM;AAAA,MACJ,KAAK;AAAA,MACL,QAAQ;AAAA,MACR,SAAS;AAAA,QACP,gBAAgB;AAAA,QAChB,aAAa,OAAO;AAAA,MACtB;AAAA,MACA;AAAA,MACA,WAAW;AAAA;AAAA,MACX,gBAAgB;AAAA;AAAA,MAChB,GAAG;AAAA,IACL,CAAC;AAAA,EACH;AACF;","names":[]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@loglayer/transport-logflare",
+  "description": "Logflare transport for the LogLayer logging library.",
+  "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": {
+    "type": "git",
+    "url": "https://github.com/loglayer/loglayer.git",
+    "directory": "packages/transports/logflare"
+  },
+  "author": "Theo Gravity <theo@suteki.nu>",
+  "keywords": [
+    "logging",
+    "log",
+    "loglayer",
+    "logflare",
+    "transport"
+  ],
+  "dependencies": {
+    "@loglayer/transport-http": "1.1.0"
+  },
+  "devDependencies": {
+    "dotenv": "17.2.3",
+    "@types/node": "24.6.1",
+    "serialize-error": "12.0.0",
+    "tsx": "4.20.6",
+    "tsup": "8.5.0",
+    "typescript": "5.9.3",
+    "vitest": "3.2.4",
+    "@loglayer/transport": "2.3.3",
+    "loglayer": "6.8.3",
+    "@internal/tsconfig": "2.1.0"
+  },
+  "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",
+    "clean": "rm -rf .turbo node_modules dist",
+    "lint": "biome check --no-errors-on-unmatched --write --unsafe src",
+    "lint:staged": "biome check --no-errors-on-unmatched --write --unsafe --staged src",
+    "verify-types": "tsc --noEmit",
+    "livetest": "tsx src/__tests__/livetest.ts"
+  }
+}