vedatrace 0.1.0 → 0.1.5

package/README.md

@@ -223,6 +223,22 @@ app.post('/webhook', async (req, res) => {
 })
 ```
 
+### Graceful Shutdown
+
+The SDK uses background batching that doesn't block your app. For short-lived scripts or when you need explicit cleanup:
+
+```typescript
+const logger = vedatrace({ apiKey: '...' })
+
+logger.info('Processing...')
+
+// For short-lived scripts
+await logger.flush()
+logger.stop()  // Stop background timer
+```
+
+The SDK timer uses `unref()` so the process will exit automatically when there's nothing else to do. Call `stop()` if you need explicit cleanup.
+
 ### Error Handling
 
 ```typescript
@@ -288,6 +304,10 @@ Create a child logger with default metadata.
 
 Manually flush pending logs. Returns a Promise.
 
+### `logger.stop()`
+
+Stop the background flush timer. Call this for explicit cleanup in long-running processes or before shutdown.
+
 ## License
 
 MIT

package/dist/index.cjs

@@ -5,11 +5,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var transports_index = require('./transports/index.cjs');
 
 class VedaTraceBatcher {
-  constructor(transports, config, onError, onSuccess) {
+  constructor(transports, config, onError, onSuccess, immediateFlush = false) {
     this.transports = transports;
     this.config = config;
     this.onError = onError;
     this.onSuccess = onSuccess;
+    this.immediateFlush = immediateFlush;
     this.startFlushTimer();
   }
   queue = [];
@@ -19,7 +20,7 @@ class VedaTraceBatcher {
   /** Add log to queue */
   add(log) {
     this.queue.push(log);
-    if (this.queue.length >= this.config.batchSize) {
+    if (this.immediateFlush || this.queue.length >= this.config.batchSize) {
       this.flush();
     }
   }
@@ -73,6 +74,9 @@ class VedaTraceBatcher {
         this.flush();
       }
     }, this.config.flushInterval);
+    if (this.config.unrefTimer !== false) {
+      this.flushTimer.unref();
+    }
   }
   /** Stop the flush timer */
   stop() {
@@ -109,7 +113,8 @@ class VedaTraceLogger {
       retryDelay: config.retryDelay ?? 1e3,
       onError: config.onError,
       onSuccess: config.onSuccess,
-      debug: config.debug ?? false
+      debug: config.debug ?? false,
+      immediateFlush: config.immediateFlush ?? false
     };
     if (!config.disabled) {
       this.initializeBatcher(config);
@@ -129,7 +134,8 @@ class VedaTraceLogger {
           retryDelay: this.config.retryDelay
         },
         this.config.onError,
-        this.config.onSuccess
+        this.config.onSuccess,
+        this.config.immediateFlush
       );
     }
   }
@@ -209,6 +215,12 @@ class VedaTraceLogger {
       await this.batcher.flush();
     }
   }
+  /** Stop the batcher and flush timer */
+  stop() {
+    if (this.batcher) {
+      this.batcher.stop();
+    }
+  }
   /** Detect runtime environment */
   detectEnvironment() {
     if (typeof globalThis !== "undefined" && "navigator" in globalThis) {
@@ -305,7 +317,7 @@ function vedatrace(config = {}) {
       [httpTransport],
       {
         batchSize: config.batchSize ?? 100,
-        flushInterval: config.flushInterval ?? 5e3,
+        flushInterval: config.flushInterval ?? 1e3,
         maxRetries: config.maxRetries ?? 3,
         retryDelay: config.retryDelay ?? 1e3
       },
@@ -313,12 +325,21 @@ function vedatrace(config = {}) {
       config.onSuccess
     );
     logger.setBatcher(batcher);
+    if (typeof process !== "undefined") {
+      const flushLogs = async () => {
+        await batcher.flush();
+      };
+      process.on("beforeExit", flushLogs);
+      process.on("SIGTERM", flushLogs);
+      process.on("SIGINT", flushLogs);
+    }
   }
   return logger;
 }
 function devVedatrace(config = {}) {
   return vedatrace({
     ...config,
+    immediateFlush: true,
     transports: [
       new transports_index.VedaTraceConsoleTransport({
         format: "pretty",

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { b as VedaTraceTransport, B as BatcherConfig, I as InternalLogEntry, V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata, R as RedactionConfig } from './types-wnAhugbp.cjs';
-export { c as VedaTraceLevel, d as VedaTraceLog } from './types-wnAhugbp.cjs';
+import { b as VedaTraceTransport, B as BatcherConfig, I as InternalLogEntry, V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata, R as RedactionConfig } from './types-CGtcllp9.cjs';
+export { c as VedaTraceLevel, d as VedaTraceLog } from './types-CGtcllp9.cjs';
 export { ConsoleFormat, ConsoleTransportConfig, HttpTransportConfig, VedaTraceConsoleTransport, VedaTraceHttpTransport } from './transports/index.cjs';
 
 /**
@@ -12,11 +12,12 @@ declare class VedaTraceBatcher {
     private config;
     private onError?;
     private onSuccess?;
+    private immediateFlush;
     private queue;
     private flushTimer;
     private isFlushing;
     private pendingFlush;
-    constructor(transports: VedaTraceTransport[], config: BatcherConfig, onError?: ((error: Error) => void) | undefined, onSuccess?: (() => void) | undefined);
+    constructor(transports: VedaTraceTransport[], config: BatcherConfig, onError?: ((error: Error) => void) | undefined, onSuccess?: (() => void) | undefined, immediateFlush?: boolean);
     /** Add log to queue */
     add(log: InternalLogEntry): void;
     /** Flush logs to all transports */
@@ -62,6 +63,8 @@ declare class VedaTraceLogger implements VedaTraceLoggerInterface {
     child(defaults: LogMetadata): VedaTraceLoggerInterface;
     /** Flush pending logs */
     flush(): Promise<void>;
+    /** Stop the batcher and flush timer */
+    stop(): void;
     /** Detect runtime environment */
     private detectEnvironment;
 }

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { b as VedaTraceTransport, B as BatcherConfig, I as InternalLogEntry, V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata, R as RedactionConfig } from './types-wnAhugbp.mjs';
-export { c as VedaTraceLevel, d as VedaTraceLog } from './types-wnAhugbp.mjs';
+import { b as VedaTraceTransport, B as BatcherConfig, I as InternalLogEntry, V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata, R as RedactionConfig } from './types-CGtcllp9.mjs';
+export { c as VedaTraceLevel, d as VedaTraceLog } from './types-CGtcllp9.mjs';
 export { ConsoleFormat, ConsoleTransportConfig, HttpTransportConfig, VedaTraceConsoleTransport, VedaTraceHttpTransport } from './transports/index.mjs';
 
 /**
@@ -12,11 +12,12 @@ declare class VedaTraceBatcher {
     private config;
     private onError?;
     private onSuccess?;
+    private immediateFlush;
     private queue;
     private flushTimer;
     private isFlushing;
     private pendingFlush;
-    constructor(transports: VedaTraceTransport[], config: BatcherConfig, onError?: ((error: Error) => void) | undefined, onSuccess?: (() => void) | undefined);
+    constructor(transports: VedaTraceTransport[], config: BatcherConfig, onError?: ((error: Error) => void) | undefined, onSuccess?: (() => void) | undefined, immediateFlush?: boolean);
     /** Add log to queue */
     add(log: InternalLogEntry): void;
     /** Flush logs to all transports */
@@ -62,6 +63,8 @@ declare class VedaTraceLogger implements VedaTraceLoggerInterface {
     child(defaults: LogMetadata): VedaTraceLoggerInterface;
     /** Flush pending logs */
     flush(): Promise<void>;
+    /** Stop the batcher and flush timer */
+    stop(): void;
     /** Detect runtime environment */
     private detectEnvironment;
 }

package/dist/index.mjs

@@ -1,11 +1,12 @@
 import { VedaTraceHttpTransport, VedaTraceConsoleTransport } from './transports/index.mjs';
 
 class VedaTraceBatcher {
-  constructor(transports, config, onError, onSuccess) {
+  constructor(transports, config, onError, onSuccess, immediateFlush = false) {
     this.transports = transports;
     this.config = config;
     this.onError = onError;
     this.onSuccess = onSuccess;
+    this.immediateFlush = immediateFlush;
     this.startFlushTimer();
   }
   queue = [];
@@ -15,7 +16,7 @@ class VedaTraceBatcher {
   /** Add log to queue */
   add(log) {
     this.queue.push(log);
-    if (this.queue.length >= this.config.batchSize) {
+    if (this.immediateFlush || this.queue.length >= this.config.batchSize) {
       this.flush();
     }
   }
@@ -69,6 +70,9 @@ class VedaTraceBatcher {
         this.flush();
       }
     }, this.config.flushInterval);
+    if (this.config.unrefTimer !== false) {
+      this.flushTimer.unref();
+    }
   }
   /** Stop the flush timer */
   stop() {
@@ -105,7 +109,8 @@ class VedaTraceLogger {
       retryDelay: config.retryDelay ?? 1e3,
       onError: config.onError,
       onSuccess: config.onSuccess,
-      debug: config.debug ?? false
+      debug: config.debug ?? false,
+      immediateFlush: config.immediateFlush ?? false
     };
     if (!config.disabled) {
       this.initializeBatcher(config);
@@ -125,7 +130,8 @@ class VedaTraceLogger {
           retryDelay: this.config.retryDelay
         },
         this.config.onError,
-        this.config.onSuccess
+        this.config.onSuccess,
+        this.config.immediateFlush
       );
     }
   }
@@ -205,6 +211,12 @@ class VedaTraceLogger {
       await this.batcher.flush();
     }
   }
+  /** Stop the batcher and flush timer */
+  stop() {
+    if (this.batcher) {
+      this.batcher.stop();
+    }
+  }
   /** Detect runtime environment */
   detectEnvironment() {
     if (typeof globalThis !== "undefined" && "navigator" in globalThis) {
@@ -301,7 +313,7 @@ function vedatrace(config = {}) {
       [httpTransport],
       {
         batchSize: config.batchSize ?? 100,
-        flushInterval: config.flushInterval ?? 5e3,
+        flushInterval: config.flushInterval ?? 1e3,
         maxRetries: config.maxRetries ?? 3,
         retryDelay: config.retryDelay ?? 1e3
       },
@@ -309,12 +321,21 @@ function vedatrace(config = {}) {
       config.onSuccess
     );
     logger.setBatcher(batcher);
+    if (typeof process !== "undefined") {
+      const flushLogs = async () => {
+        await batcher.flush();
+      };
+      process.on("beforeExit", flushLogs);
+      process.on("SIGTERM", flushLogs);
+      process.on("SIGINT", flushLogs);
+    }
   }
   return logger;
 }
 function devVedatrace(config = {}) {
   return vedatrace({
     ...config,
+    immediateFlush: true,
     transports: [
       new VedaTraceConsoleTransport({
         format: "pretty",

package/dist/integrations/express.d.cts

@@ -1,5 +1,5 @@
 import { Request, Response, NextFunction } from 'express';
-import { V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata } from '../types-wnAhugbp.cjs';
+import { V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata } from '../types-CGtcllp9.cjs';
 
 /**
  * Express.js middleware integration for VedaTrace

package/dist/integrations/express.d.mts

@@ -1,5 +1,5 @@
 import { Request, Response, NextFunction } from 'express';
-import { V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata } from '../types-wnAhugbp.mjs';
+import { V as VedaTraceLoggerInterface, a as VedaTraceConfig, L as LogMetadata } from '../types-CGtcllp9.mjs';
 
 /**
  * Express.js middleware integration for VedaTrace

package/dist/integrations/nextjs.d.cts

@@ -1,4 +1,4 @@
-import { a as VedaTraceConfig, L as LogMetadata, V as VedaTraceLoggerInterface } from '../types-wnAhugbp.cjs';
+import { a as VedaTraceConfig, L as LogMetadata, V as VedaTraceLoggerInterface } from '../types-CGtcllp9.cjs';
 
 /**
  * Next.js integration for VedaTrace

package/dist/integrations/nextjs.d.mts

@@ -1,4 +1,4 @@
-import { a as VedaTraceConfig, L as LogMetadata, V as VedaTraceLoggerInterface } from '../types-wnAhugbp.mjs';
+import { a as VedaTraceConfig, L as LogMetadata, V as VedaTraceLoggerInterface } from '../types-CGtcllp9.mjs';
 
 /**
  * Next.js integration for VedaTrace

package/dist/integrations/react.d.cts

@@ -1,5 +1,5 @@
 import { ReactNode, ReactElement } from 'react';
-import { a as VedaTraceConfig, V as VedaTraceLoggerInterface, L as LogMetadata } from '../types-wnAhugbp.cjs';
+import { a as VedaTraceConfig, V as VedaTraceLoggerInterface, L as LogMetadata } from '../types-CGtcllp9.cjs';
 
 /**
  * React integration for VedaTrace

package/dist/integrations/react.d.mts

@@ -1,5 +1,5 @@
 import { ReactNode, ReactElement } from 'react';
-import { a as VedaTraceConfig, V as VedaTraceLoggerInterface, L as LogMetadata } from '../types-wnAhugbp.mjs';
+import { a as VedaTraceConfig, V as VedaTraceLoggerInterface, L as LogMetadata } from '../types-CGtcllp9.mjs';
 
 /**
  * React integration for VedaTrace

package/dist/transports/index.cjs

@@ -92,6 +92,13 @@ class VedaTraceHttpTransport {
   async send(logs) {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    const payload = logs.map((log) => ({
+      level: log.level,
+      message: log.message,
+      service: log.service,
+      timestamp: log.timestamp ? new Date(log.timestamp).toISOString() : void 0,
+      metadata: log.metadata
+    }));
     try {
       const response = await fetch(this.endpoint, {
         method: "POST",
@@ -100,7 +107,7 @@ class VedaTraceHttpTransport {
           "X-API-Key": this.apiKey,
           ...this.headers
         },
-        body: JSON.stringify(logs),
+        body: JSON.stringify(payload),
         signal: controller.signal
       });
       clearTimeout(timeoutId);

package/dist/transports/index.d.cts

@@ -1,4 +1,4 @@
-import { c as VedaTraceLevel, b as VedaTraceTransport, d as VedaTraceLog } from '../types-wnAhugbp.cjs';
+import { c as VedaTraceLevel, b as VedaTraceTransport, I as InternalLogEntry } from '../types-CGtcllp9.cjs';
 
 /**
  * Console transport for development/debugging
@@ -20,7 +20,7 @@ declare class VedaTraceConsoleTransport implements VedaTraceTransport {
     private minLevel;
     constructor(config?: ConsoleTransportConfig);
     /** Send logs to console */
-    send(logs: VedaTraceLog[]): void;
+    send(logs: InternalLogEntry[]): void;
     /** Format as JSON */
     private logJson;
     /** Format as simple text */
@@ -51,7 +51,7 @@ declare class VedaTraceHttpTransport implements VedaTraceTransport {
     private headers;
     constructor(config: HttpTransportConfig);
     /** Send logs via HTTP POST */
-    send(logs: VedaTraceLog[]): Promise<void>;
+    send(logs: InternalLogEntry[]): Promise<void>;
 }
 
 export { VedaTraceConsoleTransport, VedaTraceHttpTransport };

package/dist/transports/index.d.mts

@@ -1,4 +1,4 @@
-import { c as VedaTraceLevel, b as VedaTraceTransport, d as VedaTraceLog } from '../types-wnAhugbp.mjs';
+import { c as VedaTraceLevel, b as VedaTraceTransport, I as InternalLogEntry } from '../types-CGtcllp9.mjs';
 
 /**
  * Console transport for development/debugging
@@ -20,7 +20,7 @@ declare class VedaTraceConsoleTransport implements VedaTraceTransport {
     private minLevel;
     constructor(config?: ConsoleTransportConfig);
     /** Send logs to console */
-    send(logs: VedaTraceLog[]): void;
+    send(logs: InternalLogEntry[]): void;
     /** Format as JSON */
     private logJson;
     /** Format as simple text */
@@ -51,7 +51,7 @@ declare class VedaTraceHttpTransport implements VedaTraceTransport {
     private headers;
     constructor(config: HttpTransportConfig);
     /** Send logs via HTTP POST */
-    send(logs: VedaTraceLog[]): Promise<void>;
+    send(logs: InternalLogEntry[]): Promise<void>;
 }
 
 export { VedaTraceConsoleTransport, VedaTraceHttpTransport };

package/dist/transports/index.mjs

@@ -90,6 +90,13 @@ class VedaTraceHttpTransport {
   async send(logs) {
     const controller = new AbortController();
     const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    const payload = logs.map((log) => ({
+      level: log.level,
+      message: log.message,
+      service: log.service,
+      timestamp: log.timestamp ? new Date(log.timestamp).toISOString() : void 0,
+      metadata: log.metadata
+    }));
     try {
       const response = await fetch(this.endpoint, {
         method: "POST",
@@ -98,7 +105,7 @@ class VedaTraceHttpTransport {
           "X-API-Key": this.apiKey,
           ...this.headers
         },
-        body: JSON.stringify(logs),
+        body: JSON.stringify(payload),
         signal: controller.signal
       });
       clearTimeout(timeoutId);

package/dist/{types-wnAhugbp.d.cts → types-CGtcllp9.d.cts}

@@ -47,6 +47,8 @@ interface VedaTraceConfig {
     disabled?: boolean;
     /** Enable debug mode (verbose console output) */
     debug?: boolean;
+    /** Flush immediately after each log (for console/dev mode) */
+    immediateFlush?: boolean;
 }
 /** Redaction configuration */
 interface RedactionConfig {
@@ -62,7 +64,7 @@ interface VedaTraceTransport {
     /** Transport name */
     name: string;
     /** Send logs to destination */
-    send(logs: VedaTraceLog[]): Promise<void> | void;
+    send(logs: InternalLogEntry[]): Promise<void> | void;
     /** Flush any pending logs */
     flush?(): Promise<void>;
 }
@@ -96,6 +98,7 @@ interface BatcherConfig {
     flushInterval: number;
     maxRetries: number;
     retryDelay: number;
+    unrefTimer?: boolean;
 }
 /** Logger interface */
 interface VedaTraceLoggerInterface {
@@ -106,6 +109,7 @@ interface VedaTraceLoggerInterface {
     fatal(message: string | Error, metadata?: LogMetadata): void;
     child(defaults: LogMetadata): VedaTraceLoggerInterface;
     flush(): Promise<void>;
+    stop(): void;
 }
 
 export type { BatcherConfig as B, InternalLogEntry as I, LogMetadata as L, RedactionConfig as R, VedaTraceLoggerInterface as V, VedaTraceConfig as a, VedaTraceTransport as b, VedaTraceLevel as c, VedaTraceLog as d };

package/dist/{types-wnAhugbp.d.mts → types-CGtcllp9.d.mts}

@@ -47,6 +47,8 @@ interface VedaTraceConfig {
     disabled?: boolean;
     /** Enable debug mode (verbose console output) */
     debug?: boolean;
+    /** Flush immediately after each log (for console/dev mode) */
+    immediateFlush?: boolean;
 }
 /** Redaction configuration */
 interface RedactionConfig {
@@ -62,7 +64,7 @@ interface VedaTraceTransport {
     /** Transport name */
     name: string;
     /** Send logs to destination */
-    send(logs: VedaTraceLog[]): Promise<void> | void;
+    send(logs: InternalLogEntry[]): Promise<void> | void;
     /** Flush any pending logs */
     flush?(): Promise<void>;
 }
@@ -96,6 +98,7 @@ interface BatcherConfig {
     flushInterval: number;
     maxRetries: number;
     retryDelay: number;
+    unrefTimer?: boolean;
 }
 /** Logger interface */
 interface VedaTraceLoggerInterface {
@@ -106,6 +109,7 @@ interface VedaTraceLoggerInterface {
     fatal(message: string | Error, metadata?: LogMetadata): void;
     child(defaults: LogMetadata): VedaTraceLoggerInterface;
     flush(): Promise<void>;
+    stop(): void;
 }
 
 export type { BatcherConfig as B, InternalLogEntry as I, LogMetadata as L, RedactionConfig as R, VedaTraceLoggerInterface as V, VedaTraceConfig as a, VedaTraceTransport as b, VedaTraceLevel as c, VedaTraceLog as d };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vedatrace",
 	"description": "Universal JavaScript logging SDK for VedaTrace - type-safe, lightweight, and developer-friendly",
-	"version": "0.1.0",
+	"version": "0.1.5",
 	"scripts": {
 		"setup": "rm -rf node_modules && npm i && git init && husky",
 		"prepublishOnly": "npm run build",
@@ -12,7 +12,11 @@
 		"version": "changeset version",
 		"release": "bun run build && changeset publish",
 		"ci:version": "changeset version",
-		"ci:publish": "bun run build && changeset publish"
+		"ci:publish": "bun run build && changeset publish --provenance"
+	},
+	"publishConfig": {
+		"provenance": true,
+		"access": "public"
 	},
 	"files": [
 		"dist"
@@ -125,11 +129,15 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/yourusername/vedatrace-sdk.git"
+		"url": "git+https://github.com/kurtiz/vedatrace-npm.git"
 	},
 	"bugs": {
-		"url": "https://github.com/yourusername/vedatrace-sdk/issues"
+		"url": "https://github.com/kurtiz/vedatrace-npm/issues"
+	},
+	"author": {
+		"name": "Aaron Will Djaba",
+		"email": "aaronwilldjaba@outlook.com",
+		"url": "https://iamaaronwilldjaba.me"
 	},
-	"author": "VedaTrace",
 	"license": "MIT"
 }