@pands/logger 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,40 @@
-# Temporary Holding Version
+# @pands/logger
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> High-performance Pino structured logger with automatic secret redaction for the **Pand Application Platform**.
+
+[![npm version](https://img.shields.io/npm/v/@pands/logger.svg)](https://www.npmjs.com/package/@pands/logger)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+`@pands/logger` standardizes JSON logging across microservices with automatic redaction of sensitive credentials, tokens, and authorization headers.
+
+---
+
+## Installation
+
+```bash
+pnpm add @pands/logger
+# or with npm:
+npm install @pands/logger
+```
+
+---
+
+## Usage
+
+```typescript
+import { createLogger } from "@pands/logger";
+
+const logger = createLogger({
+  service: "billing",
+  level: process.env.LOG_LEVEL || "info",
+});
+
+logger.info({ invoiceId: "inv_123", amount: 200 }, "Invoice processed successfully");
+logger.error(new Error("Failed to charge card"), "Payment processing failed");
+```
+
+---
+
+## License
+
+MIT © [Mehdi Nosrati](https://github.com/MehdiNosrati)

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { DestinationStream, Logger as Logger$1 } from 'pino';
+
+type Logger = Logger$1;
+interface CreateLoggerOptions {
+    service: string;
+    project?: string;
+    env?: string;
+    level?: string;
+    destination?: DestinationStream;
+}
+declare function createLogger(options: CreateLoggerOptions): Logger;
+
+export { type CreateLoggerOptions, type Logger, createLogger };

package/dist/index.js

@@ -0,0 +1,52 @@
+// src/index.ts
+import { trace } from "@opentelemetry/api";
+import pino from "pino";
+function createLogger(options) {
+  const level = options.level ?? process.env.LOG_LEVEL ?? "info";
+  const project = options.project ?? process.env.PAND_PROJECT ?? "pand";
+  const env = options.env ?? process.env.PAND_ENV ?? "dev";
+  const pinoOptions = {
+    level,
+    base: {
+      service: options.service,
+      project,
+      env
+    },
+    redact: {
+      paths: [
+        "req.headers.authorization",
+        "req.headers.cookie",
+        'req.headers["x-pand-internal-token"]',
+        "password",
+        "secret"
+      ],
+      censor: "[REDACTED]"
+    },
+    formatters: {
+      level(label) {
+        return { level: label };
+      }
+    },
+    mixin() {
+      const span = trace.getActiveSpan();
+      if (!span) {
+        return {};
+      }
+      const ctx = span.spanContext();
+      if (!ctx || !ctx.traceId || ctx.traceId === "00000000000000000000000000000000") {
+        return {};
+      }
+      return {
+        trace_id: ctx.traceId,
+        span_id: ctx.spanId
+      };
+    }
+  };
+  if (options.destination) {
+    return pino(pinoOptions, options.destination);
+  }
+  return pino(pinoOptions);
+}
+export {
+  createLogger
+};

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "@pands/logger",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@opentelemetry/api": "~1.9.0",
+    "pino": "^9.6.0",
+    "pino-pretty": "^13.0.0"
+  },
+  "description": "Structured JSON logging and telemetry redaction for Pand services",
+  "license": "MIT",
+  "author": "Mehdi Nosrati",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MehdiNosrati/pand.git"
+  },
+  "homepage": "https://github.com/MehdiNosrati/pand#readme",
+  "bugs": {
+    "url": "https://github.com/MehdiNosrati/pand/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
 }