unnbound-logger-sdk 3.0.0 → 3.0.1

package/dist/utils/logger-utils.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTimestamp = generateTimestamp;
+exports.getTraceId = getTraceId;
+exports.clearTraceId = clearTraceId;
+exports.filterHeaders = filterHeaders;
+exports.safeJsonParse = safeJsonParse;
+exports.normalizeIp = normalizeIp;
+/**
+ * Utility functions for logging
+ */
+const uuid_1 = require("uuid");
+/**
+ * Generates the current timestamp in ISO format
+ * @returns ISO timestamp string
+ */
+function generateTimestamp() {
+    return new Date().toISOString();
+}
+/**
+ * Stores trace IDs by workflow ID for consistent tracking
+ */
+const traceIdMap = new Map();
+/**
+ * Gets or creates a trace ID for a workflow
+ * @param workflowId - The workflow ID to get a trace ID for
+ * @returns A trace ID associated with the workflow
+ */
+function getTraceId(workflowId) {
+    if (!traceIdMap.has(workflowId)) {
+        traceIdMap.set(workflowId, (0, uuid_1.v4)());
+    }
+    return traceIdMap.get(workflowId);
+}
+/**
+ * Clears a trace ID from the map
+ * @param workflowId - The workflow ID to clear
+ */
+function clearTraceId(workflowId) {
+    traceIdMap.delete(workflowId);
+}
+// --- Header Allow-Listing ---
+const ALLOWED_HEADERS = new Set([
+    'content-type',
+    'accept',
+    'user-agent',
+    'host',
+    'x-forwarded-for',
+    'x-request-id',
+    'content-length',
+    'cache-control',
+]);
+/**
+ * Filters an object of headers, returning a new object with only the allowed headers.
+ * @param headers The original headers object.
+ * @returns A new object containing only the headers from the allow-list.
+ */
+function filterHeaders(headers) {
+    const filtered = {};
+    for (const key in headers) {
+        if (ALLOWED_HEADERS.has(key.toLowerCase())) {
+            filtered[key] = String(headers[key]);
+        }
+    }
+    return filtered;
+}
+/**
+ * Safely parses JSON strings, returning the original data if parsing fails or if it's not a string.
+ * @param data The data to potentially parse as JSON.
+ * @returns Parsed JSON object or the original data.
+ */
+function safeJsonParse(data) {
+    if (typeof data === 'string') {
+        try {
+            return JSON.parse(data);
+        }
+        catch {
+            return data;
+        }
+    }
+    return data;
+}
+/**
+ * Normalizes IP addresses by removing IPv6 mapping prefix for IPv4 addresses.
+ * @param ip The IP address to normalize.
+ * @returns Normalized IP address string.
+ */
+function normalizeIp(ip) {
+    if (!ip)
+        return ip;
+    // Remove IPv4-mapped IPv6 prefix (::ffff:) to get clean IPv4 address
+    if (ip.startsWith('::ffff:')) {
+        return ip.substring(7);
+    }
+    return ip;
+}

package/dist/utils/trace-context.d.ts

@@ -0,0 +1,10 @@
+declare class TraceContextManager {
+    private static instance;
+    private storage;
+    private constructor();
+    static getInstance(): TraceContextManager;
+    run<T>(traceId: string, callback: () => T): T;
+    getTraceId(): string | undefined;
+}
+export declare const traceContext: TraceContextManager;
+export {};

package/dist/utils/trace-context.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.traceContext = void 0;
+const async_hooks_1 = require("async_hooks");
+class TraceContextManager {
+    constructor() {
+        this.storage = new async_hooks_1.AsyncLocalStorage();
+    }
+    static getInstance() {
+        if (!TraceContextManager.instance) {
+            TraceContextManager.instance = new TraceContextManager();
+        }
+        return TraceContextManager.instance;
+    }
+    run(traceId, callback) {
+        return this.storage.run({ traceId }, callback);
+    }
+    getTraceId() {
+        const context = this.storage.getStore();
+        return context?.traceId;
+    }
+}
+exports.traceContext = TraceContextManager.getInstance();

package/dist/utils/with-trace.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Higher-order function that wraps a function with trace context
+ * @param fn - Function to wrap with trace context
+ * @param traceId - Optional trace ID to use (will generate new one if not provided)
+ * @returns Wrapped function that maintains trace context
+ */
+export declare function withTrace<T extends (...args: any[]) => any>(fn: T, traceId?: string): T;

package/dist/utils/with-trace.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withTrace = withTrace;
+/**
+ * Utility function to wrap a function with trace context
+ */
+const uuid_1 = require("uuid");
+const trace_context_1 = require("./trace-context");
+/**
+ * Higher-order function that wraps a function with trace context
+ * @param fn - Function to wrap with trace context
+ * @param traceId - Optional trace ID to use (will generate new one if not provided)
+ * @returns Wrapped function that maintains trace context
+ */
+function withTrace(fn, traceId) {
+    const id = traceId || (0, uuid_1.v4)();
+    return ((...args) => {
+        return trace_context_1.traceContext.run(id, () => fn(...args));
+    });
+}

package/dist/utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Checks if a path matches any of the ignore patterns
+ * @param path - The path to check
+ * @param patterns - Array of glob patterns to match against
+ * @returns boolean indicating if the path should be ignored
+ */
+export declare const shouldIgnorePath: (path: string, patterns: string[]) => boolean;
+/**
+ * Safely parses JSON strings, returning the original data if parsing fails or if it's not a string.
+ * @param data The data to potentially parse as JSON.
+ * @returns Parsed JSON object or the original data.
+ */
+export declare function safeJsonParse(data: any): any;
+/**
+ * Normalizes IP addresses by removing IPv6 mapping prefix for IPv4 addresses.
+ * @param ip The IP address to normalize.
+ * @returns Normalized IP address string.
+ */
+export declare function normalizeIp(ip: string | undefined): string | undefined;

package/dist/utils.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldIgnorePath = void 0;
+exports.safeJsonParse = safeJsonParse;
+exports.normalizeIp = normalizeIp;
+/**
+ * Checks if a path matches any of the ignore patterns
+ * @param path - The path to check
+ * @param patterns - Array of glob patterns to match against
+ * @returns boolean indicating if the path should be ignored
+ */
+const shouldIgnorePath = (path, patterns) => {
+    return patterns.some((pattern) => {
+        // Convert glob pattern to regex
+        const regexPattern = pattern
+            .replace(/\./g, '\\.') // Escape dots
+            .replace(/\*/g, '.*') // Convert * to .*
+            .replace(/\?/g, '.'); // Convert ? to .
+        const regex = new RegExp(`^${regexPattern}$`);
+        return regex.test(path);
+    });
+};
+exports.shouldIgnorePath = shouldIgnorePath;
+/**
+ * Safely parses JSON strings, returning the original data if parsing fails or if it's not a string.
+ * @param data The data to potentially parse as JSON.
+ * @returns Parsed JSON object or the original data.
+ */
+function safeJsonParse(data) {
+    if (typeof data === 'string') {
+        try {
+            return JSON.parse(data);
+        }
+        catch {
+            return data;
+        }
+    }
+    return data;
+}
+/**
+ * Normalizes IP addresses by removing IPv6 mapping prefix for IPv4 addresses.
+ * @param ip The IP address to normalize.
+ * @returns Normalized IP address string.
+ */
+function normalizeIp(ip) {
+    if (!ip)
+        return ip;
+    // Remove IPv4-mapped IPv6 prefix (::ffff:) to get clean IPv4 address
+    if (ip.startsWith('::ffff:')) {
+        return ip.substring(7);
+    }
+    return ip;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "unnbound-logger-sdk",
   "description": "A structured logging library with TypeScript support using Pino. Provides consistent, well-typed logging with automatic logId, workflowId, traceId, and deploymentId tracking across operational contexts.",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "keywords": [
@@ -50,7 +50,7 @@
     }
   },
   "files": [
-    "dist/src/**/*",
+    "dist/**/*",
     "README.md",
     "LICENSE"
   ],
@@ -63,6 +63,7 @@
     "test": "jest",
     "test:coverage": "jest --coverage",
     "test:watch": "jest --watch",
+    "typecheck": "tsc -noEmit",
     "lint": "eslint --cache --cache-location ./node_modules/.cache/eslint .",
     "lint:fix": "pnpm lint --fix",
     "format": "prettier --write .",