azify-logger 1.0.8 → 1.0.10

package/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * AzifyLogger class for structured logging with OpenTelemetry integration
+ */
+export class AzifyLogger {
+  /**
+   * Creates an instance of AzifyLogger
+   * @param options - Configuration options
+   */
+  constructor(options?: {
+    serviceName?: string;
+    loggerUrl?: string;
+    environment?: string;
+  });
+
+  /**
+   * Sends a log entry to the azify-logger service
+   * @param level - Log level (info, error, warn, debug)
+   * @param message - Log message
+   * @param meta - Additional metadata to include in the log
+   */
+  log(level: string, message: string, meta?: Record<string, any>): Promise<void>;
+
+  /**
+   * Logs an info level message
+   * @param message - Log message
+   * @param meta - Additional metadata
+   */
+  info(message: string, meta?: Record<string, any>): Promise<void>;
+
+  /**
+   * Logs an error level message with optional error object
+   * @param message - Log message
+   * @param error - Error object to include in metadata
+   * @param meta - Additional metadata
+   */
+  error(message: string, error?: Error | null, meta?: Record<string, any>): Promise<void>;
+
+  /**
+   * Logs a warning level message
+   * @param message - Log message
+   * @param meta - Additional metadata
+   */
+  warn(message: string, meta?: Record<string, any>): Promise<void>;
+
+  /**
+   * Logs a debug level message
+   * @param message - Log message
+   * @param meta - Additional metadata
+   */
+  debug(message: string, meta?: Record<string, any>): Promise<void>;
+}
+
+/**
+ * Creates a new AzifyLogger instance with custom options
+ * @param options - Configuration options
+ * @returns New AzifyLogger instance
+ */
+export function createAzifyLogger(options?: {
+  serviceName?: string;
+  loggerUrl?: string;
+  environment?: string;
+}): AzifyLogger;
+
+/**
+ * Creates a new AzifyLogger instance using environment variables
+ * @returns New AzifyLogger instance configured from environment
+ */
+export function createAzifyLoggerFromEnv(): AzifyLogger;
+
+/**
+ * Streams for different logging libraries
+ */
+export const streams: {
+  createBunyanStream: any;
+  createPinoStream: any;
+};
+
+/**
+ * Express middleware function type
+ */
+export type ExpressMiddleware = (req: any, res: any, next: () => void) => void;
+
+/**
+ * Middleware for different frameworks
+ */
+export const middleware: {
+  restify: any;
+  express: () => ExpressMiddleware;
+};
+
+export default AzifyLogger;

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "azify-logger",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "Azify Logger Client - Centralized logging for OpenSearch",
   "main": "index.js",
+  "types": "index.d.ts",
   "type": "commonjs",
   "scripts": {
     "test": "echo \"No tests specified\" && exit 0",
@@ -47,6 +48,7 @@
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "store.js",
     "register-otel.js",
     "register-restify.js",