@revenium/perplexity 2.0.4 → 2.0.5

package/dist/esm/index.js

@@ -1,47 +1,54 @@
 /**
- * Revenium Middleware for Perplexity
+ * Revenium Perplexity Middleware for TypeScript
  *
- * A lightweight middleware that adds Revenium metering to Perplexity API calls.
+ * This middleware tracks Perplexity AI usage and sends metrics to Revenium.
+ * Uses Go-aligned API pattern with Initialize/GetClient.
  *
- * @example
- * ```typescript
- * import {
- *   initializeReveniumFromEnv,
- *   initializePerplexityFromEnv,
- *   createChatCompletion,
- * } from '@revenium/perplexity';
+ * Environment Variables:
+ * REVENIUM_METERING_API_KEY=hak_your_api_key
+ * REVENIUM_METERING_BASE_URL=https://api.revenium.ai (optional)
+ * PERPLEXITY_API_KEY=pplx_your_perplexity_key
  *
- * // Initialize configurations
- * initializeReveniumFromEnv();
- * initializePerplexityFromEnv();
+ * Usage:
+ * import { Initialize, GetClient } from "@revenium/perplexity";
  *
- * // Create a chat completion
- * const result = await createChatCompletion({
- *   messages: [{ role: 'user', content: 'Hello!' }],
- *   model: 'sonar-pro',
- * });
+ * // Initialize from environment
+ * Initialize();
+ *
+ * // Get client
+ * const client = GetClient();
  *
- * console.log(result.content);
- * ```
+ * // Use client
+ * const response = await client.chat().completions().create({
+ *   model: "sonar",
+ *   messages: [{ role: "user", content: "Hello!" }]
+ * }, {
+ *   organizationId: "my-org",
+ *   productId: "my-app",
+ *   subscriber: {
+ *     id: "user-123",
+ *     email: "user@my-org.com"
+ *   }
+ * });
+ */
+/**
+ * Main API - Go-aligned pattern
+ */
+export { Initialize, GetClient, IsInitialized, Reset, Configure, } from "./core/client/index.js";
+/**
+ * Middleware classes
+ */
+export { ReveniumPerplexity, ChatInterface, CompletionsInterface, StreamingWrapper, } from "./core/middleware/index.js";
+/**
+ * Tracking functions (for advanced use cases)
+ */
+export { trackUsageAsync } from "./core/tracking/index.js";
+/**
+ * Provider detection functions
+ */
+export { detectProvider, getProviderMetadata } from "./core/providers/index.js";
+/**
+ * Model constants
  */
-import { config } from "dotenv";
-config();
-// ============================================================================
-// Configuration
-// ============================================================================
-export { initializeReveniumFromEnv, initializeRevenium, getReveniumConfig, isReveniumEnabled, disableRevenium, enableRevenium, } from "./core/config/revenium-config";
-export { initializePerplexityFromEnv, initializePerplexity, getPerplexityConfig, } from "./core/config/perplexity-config";
-// ============================================================================
-// Core API
-// ============================================================================
-export { createChatCompletion, createStreamingChatCompletion, } from "./core/wrapper/perplexity-client";
-export { generateTransactionId, buildMeteringData, sendMeteringData, } from "./core/tracking/metering";
-// ============================================================================
-// Constants
-// ============================================================================
-export { PERPLEXITY_PATTERNS, DEFAULT_CONFIG, API_ENDPOINTS, MIDDLEWARE_INFO, } from "./constants";
-// ============================================================================
-// Utilities
-// ============================================================================
-export { logger } from "./utils/logger";
+export { PERPLEXITY_MODELS } from "./constants/models.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,MAAM,EAAE,CAAC;AAET,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAE/E,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,cAAc,GAEf,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,mBAAmB,GAEpB,MAAM,iCAAiC,CAAC;AAEzC,+EAA+E;AAC/E,WAAW;AACX,+EAA+E;AAE/E,OAAO,EACL,oBAAoB,EACpB,6BAA6B,GAC9B,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAmBlC,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,OAAO,EACL,mBAAmB,EACnB,cAAc,EACd,aAAa,EACb,eAAe,GAChB,MAAM,aAAa,CAAC;AAErB,+EAA+E;AAC/E,YAAY;AACZ,+EAA+E;AAE/E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AA8BH;;GAEG;AACH,OAAO,EACL,UAAU,EACV,SAAS,EACT,aAAa,EACb,KAAK,EACL,SAAS,GACV,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,4BAA4B,CAAC;AAEpC;;GAEG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D;;GAEG;AACH,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhF;;GAEG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/esm/types/function-parameters.js

@@ -0,0 +1,13 @@
+/**
+ * Function Parameter Types
+ *
+ * Comprehensive type definitions for function parameters throughout the middleware.
+ * These interfaces provide type safety by replacing 'any' types with proper,
+ * well-documented interfaces that match Perplexity API structures and internal requirements.
+ *
+ * @fileoverview Type-safe function parameter definitions
+ * @author Revenium
+ * @since 2.0.0
+ */
+export {};
+//# sourceMappingURL=function-parameters.js.map

package/dist/esm/types/function-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-parameters.js","sourceRoot":"","sources":["../../../src/types/function-parameters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG"}

package/dist/esm/types/index.js

@@ -1,5 +1,9 @@
 /**
- * TypeScript Type Definitions for Perplexity Middleware
+ * Core Types Module
+ *
+ * Central type definitions for the Revenium Perplexity middleware.
+ * This module exports all core types used throughout the application.
  */
-export {};
+// Re-export function parameter types
+export * from "./function-parameters.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,qCAAqC;AACrC,cAAc,0BAA0B,CAAC"}

package/dist/esm/utils/constants.js

@@ -0,0 +1,17 @@
+/**
+ * Error message patterns for network-related errors
+ */
+export const MESSAGE_PATTERNS_TYPE_NETWORK = [
+    "network",
+    "timeout",
+    "ECONNRESET",
+];
+/**
+ * Error message patterns for configuration-related errors
+ */
+export const ERROR_MESSAGE_PATTERNS_TYPE_CONFIG = [
+    "config",
+    "key",
+    "unauthorized",
+];
+//# sourceMappingURL=constants.js.map

package/dist/esm/utils/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/utils/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG;IAC3C,SAAS;IACT,SAAS;IACT,YAAY;CACb,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG;IAChD,QAAQ;IACR,KAAK;IACL,cAAc;CACf,CAAC"}

package/dist/esm/utils/error-handler.js

@@ -0,0 +1,182 @@
+/**
+ * Error Handler Utilities
+ *
+ * Centralized error handling patterns to eliminate repetitive try/catch blocks
+ * and provide consistent error logging and recovery strategies.
+ */
+import { ERROR_MESSAGE_PATTERNS_TYPE_CONFIG, MESSAGE_PATTERNS_TYPE_NETWORK } from './constants.js';
+/**
+ * Default error handling strategy
+ */
+const DEFAULT_STRATEGY = {
+    logError: true,
+    rethrow: true,
+    messagePrefix: '',
+    fallbackValue: undefined,
+    transformError: (error) => (error instanceof Error ? error : new Error(String(error))),
+};
+/**
+ * Safe async operation wrapper with comprehensive error handling
+ *
+ * @param operation - The async operation to execute
+ * @param context - Context information for logging
+ * @param strategy - Error handling strategy
+ * @param logger - Logger instance
+ * @returns Promise with result or fallback value
+ */
+export async function safeAsyncOperation(operation, context, strategy = {}, logger) {
+    const config = { ...DEFAULT_STRATEGY, ...strategy };
+    try {
+        return await operation();
+    }
+    catch (error) {
+        const transformedError = config.transformError(error);
+        if (config.logError && logger) {
+            logger.error(`${config.messagePrefix}${context}`, {
+                error: transformedError.message,
+                stack: transformedError.stack,
+            });
+        }
+        if (config.rethrow)
+            throw transformedError;
+        return config.fallbackValue;
+    }
+}
+/**
+ * Safe sync operation wrapper
+ *
+ * @param operation - The sync operation to execute
+ * @param context - Context information for logging
+ * @param strategy - Error handling strategy
+ * @param logger - Logger instance
+ * @returns Result or fallback value
+ */
+export function safeSyncOperation(operation, context, strategy = {}, logger) {
+    const config = { ...DEFAULT_STRATEGY, ...strategy };
+    try {
+        return operation();
+    }
+    catch (error) {
+        const transformedError = config.transformError(error);
+        if (config.logError && logger) {
+            logger.error(`${config.messagePrefix}${context}`, {
+                error: transformedError.message,
+                stack: transformedError.stack,
+            });
+        }
+        if (config.rethrow)
+            throw transformedError;
+        return config.fallbackValue;
+    }
+}
+/**
+ * Validation wrapper that provides clear error messages
+ *
+ * @param value - Value to validate
+ * @param validator - Validation function
+ * @param errorMessage - Error message if validation fails
+ * @returns Validated value
+ */
+export function validateOrThrow(value, validator, errorMessage) {
+    if (!validator(value))
+        throw new Error(errorMessage);
+    return value;
+}
+/**
+ * Validation wrapper that returns undefined on failure
+ *
+ * @param value - Value to validate
+ * @param validator - Validation function
+ * @param logger - Optional logger for warnings
+ * @param context - Context for logging
+ * @returns Validated value or undefined
+ */
+export function validateOrUndefined(value, validator, logger, context) {
+    if (!validator(value)) {
+        if (logger && context) {
+            logger.warn(`Validation failed: ${context}`, { value });
+        }
+        return;
+    }
+    return value;
+}
+/**
+ * Create a retry wrapper for operations that might fail temporarily
+ *
+ * @param operation - Operation to retry
+ * @param maxRetries - Maximum number of retries
+ * @param delayMs - Delay between retries in milliseconds
+ * @param logger - Logger for retry attempts
+ * @returns Promise with operation result
+ */
+export async function withRetry(operation, maxRetries = 3, delayMs = 1000, logger) {
+    let lastError;
+    for (let attempt = 1; attempt <= maxRetries; attempt++) {
+        try {
+            return await operation();
+        }
+        catch (error) {
+            lastError = error instanceof Error ? error : new Error(String(error));
+            if (attempt === maxRetries) {
+                break;
+            }
+            if (logger) {
+                logger.warn(`Operation failed, retrying (${attempt}/${maxRetries})`, {
+                    error: lastError.message,
+                    nextRetryIn: delayMs,
+                });
+            }
+            await new Promise(resolve => setTimeout(resolve, delayMs));
+        }
+    }
+    // eslint-disable-next-line no-throw-literal
+    throw lastError;
+}
+/**
+ * Common error types for better error handling
+ */
+export class ValidationError extends Error {
+    constructor(message, context) {
+        super(message);
+        this.context = context;
+        this.name = 'ValidationError';
+    }
+}
+export class ConfigurationError extends Error {
+    constructor(message, context) {
+        super(message);
+        this.context = context;
+        this.name = 'ConfigurationError';
+    }
+}
+export class NetworkError extends Error {
+    constructor(message, context) {
+        super(message);
+        this.context = context;
+        this.name = 'NetworkError';
+    }
+}
+/**
+ * Error classification utility
+ */
+export function classifyError(error) {
+    if (error instanceof ValidationError) {
+        return { type: 'validation', message: error.message, isRetryable: false };
+    }
+    if (error instanceof ConfigurationError) {
+        return { type: 'configuration', message: error.message, isRetryable: false };
+    }
+    if (error instanceof NetworkError) {
+        return { type: 'network', message: error.message, isRetryable: true };
+    }
+    const message = error instanceof Error ? error.message : String(error);
+    // Classify based on message patterns
+    if (MESSAGE_PATTERNS_TYPE_NETWORK.some(pattern => message.includes(pattern))) {
+        return { type: 'network', message, isRetryable: true };
+    }
+    if (ERROR_MESSAGE_PATTERNS_TYPE_CONFIG.some(pattern => message.includes(pattern))) {
+        return { type: 'configuration', message, isRetryable: false };
+    }
+    return { type: 'unknown', message, isRetryable: false };
+}
+//# sourceMappingURL=error-handler.js.map

package/dist/esm/utils/error-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../../../src/utils/error-handler.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,kCAAkC,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAkBnG;;GAEG;AACH,MAAM,gBAAgB,GAAoC;IACxD,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,IAAI;IACb,aAAa,EAAE,EAAE;IACjB,aAAa,EAAE,SAAS;IACxB,cAAc,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;CAChG,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,SAA2B,EAC3B,OAAe,EACf,WAAkC,EAAE,EACpC,MAAe;IAEf,MAAM,MAAM,GAAG,EAAE,GAAG,gBAAgB,EAAE,GAAG,QAAQ,EAAE,CAAC;IAEpD,IAAI,CAAC;QACH,OAAO,MAAM,SAAS,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,gBAAgB,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAEtD,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC;YAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,aAAa,GAAG,OAAO,EAAE,EAAE;gBAChD,KAAK,EAAE,gBAAgB,CAAC,OAAO;gBAC/B,KAAK,EAAE,gBAAgB,CAAC,KAAK;aAC9B,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,OAAO;YAAE,MAAM,gBAAgB,CAAC;QAC3C,OAAO,MAAM,CAAC,aAA8B,CAAC;IAC/C,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAC/B,SAAkB,EAClB,OAAe,EACf,WAAkC,EAAE,EACpC,MAAe;IAEf,MAAM,MAAM,GAAG,EAAE,GAAG,gBAAgB,EAAE,GAAG,QAAQ,EAAE,CAAC;IAEpD,IAAI,CAAC;QACH,OAAO,SAAS,EAAE,CAAC;IACrB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,gBAAgB,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAEtD,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,EAAE,CAAC;YAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,aAAa,GAAG,OAAO,EAAE,EAAE;gBAChD,KAAK,EAAE,gBAAgB,CAAC,OAAO;gBAC/B,KAAK,EAAE,gBAAgB,CAAC,KAAK;aAC9B,CAAC,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,OAAO;YAAE,MAAM,gBAAgB,CAAC;QAC3C,OAAO,MAAM,CAAC,aAA8B,CAAC;IAC/C,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAc,EACd,SAAyC,EACzC,YAAoB;IAEpB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IACrD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAc,EACd,SAAyC,EACzC,MAAe,EACf,OAAgB;IAEhB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,IAAI,MAAM,IAAI,OAAO,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,sBAAsB,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO;IACT,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,SAA2B,EAC3B,aAAqB,CAAC,EACtB,UAAkB,IAAI,EACtB,MAAe;IAEf,IAAI,SAAgB,CAAC;IACrB,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,CAAC;YACH,OAAO,MAAM,SAAS,EAAE,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAEtE,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;gBAC3B,MAAM;YACR,CAAC;YAED,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,IAAI,CAAC,+BAA+B,OAAO,IAAI,UAAU,GAAG,EAAE;oBACnE,KAAK,EAAE,SAAS,CAAC,OAAO;oBACxB,WAAW,EAAE,OAAO;iBACrB,CAAC,CAAC;YACL,CAAC;YACD,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED,4CAA4C;IAC5C,MAAM,SAAU,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YACE,OAAe,EACC,OAAiC;QAEjD,KAAK,CAAC,OAAO,CAAC,CAAC;QAFC,YAAO,GAAP,OAAO,CAA0B;QAGjD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YACE,OAAe,EACC,OAAiC;QAEjD,KAAK,CAAC,OAAO,CAAC,CAAC;QAFC,YAAO,GAAP,OAAO,CAA0B;QAGjD,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YACE,OAAe,EACC,OAAiC;QAEjD,KAAK,CAAC,OAAO,CAAC,CAAC;QAFC,YAAO,GAAP,OAAO,CAA0B;QAGjD,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;IAC7B,CAAC;CACF;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAK1C,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;QACrC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;IAC5E,CAAC;IAED,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;QACxC,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;IAC/E,CAAC;IAED,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;QAClC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IACxE,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEvE,qCAAqC;IACrC,IAAI,6BAA6B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC7E,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IACzD,CAAC;IAED,IAAI,kCAAkC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAClF,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;IAChE,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;AAC1D,CAAC"}

package/dist/esm/utils/metadata-builder.js

@@ -0,0 +1,183 @@
+/**
+ * Metadata Builder Utilities
+ *
+ * Centralized metadata handling to eliminate repetitive spreading
+ * and provide consistent metadata processing across the codebase.
+ */
+/**
+ * Metadata mapping configuration
+ * Maps UsageMetadata fields to payload fields with optional transformations
+ * Subscriber object is passed through directly without transformation
+ */
+const METADATA_FIELD_MAP = [
+    { source: 'traceId' },
+    { source: 'taskType' },
+    { source: 'agent' },
+    { source: 'organizationId' },
+    { source: 'productId' },
+    { source: 'subscriber' }, // Pass through nested subscriber object directly
+    { source: 'subscriptionId' },
+    {
+        source: 'responseQualityScore',
+        transform: (value) => {
+            // Ensure quality score is between 0.0 and 1.0 (API spec requirement)
+            if (typeof value === 'number')
+                return Math.max(0, Math.min(1, value));
+            return value;
+        },
+    },
+];
+/**
+ * Build metadata object for payload inclusion
+ *
+ * This function eliminates the repetitive spreading pattern and provides
+ * a clean, testable way to handle metadata transformation.
+ * Subscriber object is passed through directly without transformation.
+ *
+ * @param usageMetadata - Source metadata from request
+ * @returns Clean metadata object for payload
+ */
+export function buildMetadataFields(usageMetadata) {
+    if (!usageMetadata)
+        return {};
+    const result = {};
+    // Process all metadata fields including nested subscriber object
+    for (const config of METADATA_FIELD_MAP) {
+        const value = usageMetadata[config.source];
+        // Skip undefined values (but allow null, empty strings, objects, etc.)
+        if (value === undefined)
+            continue;
+        // Apply transformation if configured
+        const transformedValue = config.transform ? config.transform(value) : value;
+        // Use target field name or default to source
+        const targetField = config.target || config.source;
+        result[targetField] = transformedValue;
+    }
+    return result;
+}
+/**
+ * Validate metadata completeness for specific use cases
+ *
+ * @param usageMetadata - Metadata to validate
+ * @param requiredFields - List of required field names
+ * @returns Validation result
+ */
+export function validateMetadata(usageMetadata, requiredFields = []) {
+    const missingFields = [];
+    const warnings = [];
+    if (!usageMetadata && requiredFields.length > 0) {
+        return {
+            isValid: false,
+            missingFields: requiredFields,
+            warnings: ['No metadata provided'],
+        };
+    }
+    if (usageMetadata) {
+        // Check required fields
+        for (const field of requiredFields) {
+            if (!usageMetadata[field])
+                missingFields.push(String(field));
+        }
+        // Check for common issues
+        if (usageMetadata.responseQualityScore) {
+            const score = usageMetadata.responseQualityScore;
+            // API Spec: https://revenium.readme.io/reference/meter_ai_completion (responseQualityScore)
+            // "typically on a 0.0-1.0 scale"
+            if (typeof score !== 'number' || score < 0 || score > 1) {
+                warnings.push('responseQualityScore should be a number between 0.0 and 1.0');
+            }
+        }
+        if (usageMetadata.subscriber?.email && !usageMetadata.subscriber.email.includes('@')) {
+            warnings.push('subscriber.email does not appear to be a valid email address');
+        }
+    }
+    return {
+        isValid: missingFields.length === 0,
+        missingFields,
+        warnings,
+    };
+}
+/**
+ * Merge multiple metadata sources with priority
+ *
+ * @param sources - Metadata sources in priority order (first wins)
+ * @returns Merged metadata object
+ */
+export function mergeMetadata(...sources) {
+    const result = {};
+    // Process sources in reverse order so first source wins
+    for (const source of sources.reverse()) {
+        if (source)
+            Object.assign(result, source);
+    }
+    return result;
+}
+/**
+ * Extract metadata from request parameters safely
+ *
+ * @param params - Request parameters that might contain usageMetadata
+ * @returns Extracted metadata and cleaned parameters
+ */
+export function extractMetadata(params) {
+    const { usageMetadata, ...cleanParams } = params;
+    return {
+        metadata: usageMetadata,
+        cleanParams: cleanParams,
+    };
+}
+/**
+ * Create a metadata context for consistent logging
+ * Uses sanitization to protect PII (emails are masked)
+ *
+ * @param usageMetadata - Source metadata
+ * @returns Logging context object with sanitized PII
+ */
+export function createLoggingContext(usageMetadata) {
+    if (!usageMetadata)
+        return {};
+    // Use sanitizer to protect PII in logs
+    const sanitized = sanitizeMetadataForLogging(usageMetadata);
+    const sanitizedSubscriber = sanitized.subscriber;
+    return {
+        traceId: usageMetadata.traceId,
+        taskType: usageMetadata.taskType,
+        subscriberId: usageMetadata.subscriber?.id,
+        subscriberEmail: sanitizedSubscriber?.email, // ← Now masked: us***@example.com
+        organizationId: usageMetadata.organizationId,
+        productId: usageMetadata.productId,
+        agent: usageMetadata.agent,
+    };
+}
+/**
+ * Sanitize metadata for logging (remove sensitive fields)
+ *
+ * @param usageMetadata - Source metadata
+ * @returns Sanitized metadata safe for logging
+ */
+export function sanitizeMetadataForLogging(usageMetadata) {
+    if (!usageMetadata)
+        return {};
+    // Create a copy and handle nested subscriber object
+    const { subscriber, ...safeMetadata } = usageMetadata;
+    const result = { ...safeMetadata };
+    // Sanitize subscriber object if present
+    if (subscriber) {
+        const sanitizedSubscriber = {};
+        if (subscriber.id) {
+            sanitizedSubscriber.id = subscriber.id;
+        }
+        if (subscriber.email) {
+            // Mask email: handles single-char emails (a@x.com → a***@x.com)
+            sanitizedSubscriber.email = subscriber.email.replace(/(.{1,2}).*(@.*)/, '$1***$2');
+        }
+        if (subscriber.credential) {
+            sanitizedSubscriber.credential = {
+                name: subscriber.credential.name,
+                value: '[REDACTED]',
+            };
+        }
+        result.subscriber = sanitizedSubscriber;
+    }
+    return result;
+}
+//# sourceMappingURL=metadata-builder.js.map

package/dist/esm/utils/metadata-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-builder.js","sourceRoot":"","sources":["../../../src/utils/metadata-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAkBH;;;;GAIG;AACH,MAAM,kBAAkB,GAA0B;IAChD,EAAE,MAAM,EAAE,SAAS,EAAE;IACrB,EAAE,MAAM,EAAE,UAAU,EAAE;IACtB,EAAE,MAAM,EAAE,OAAO,EAAE;IACnB,EAAE,MAAM,EAAE,gBAAgB,EAAE;IAC5B,EAAE,MAAM,EAAE,WAAW,EAAE;IACvB,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,iDAAiD;IAC3E,EAAE,MAAM,EAAE,gBAAgB,EAAE;IAC5B;QACE,MAAM,EAAE,sBAAsB;QAC9B,SAAS,EAAE,CAAC,KAAc,EAAE,EAAE;YAC5B,qEAAqE;YACrE,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC;KACF;CACF,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,mBAAmB,CAAC,aAA6B;IAC/D,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAC9B,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,iEAAiE;IACjE,KAAK,MAAM,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE3C,uEAAuE;QACvE,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAElC,qCAAqC;QACrC,MAAM,gBAAgB,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAE5E,6CAA6C;QAC7C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC;QAEnD,MAAM,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC;IACzC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,aAA6B,EAC7B,iBAA0C,EAAE;IAM5C,MAAM,aAAa,GAAa,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,IAAI,CAAC,aAAa,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,cAA0B;YACzC,QAAQ,EAAE,CAAC,sBAAsB,CAAC;SACnC,CAAC;IACJ,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,wBAAwB;QACxB,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;gBAAE,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/D,CAAC;QAED,0BAA0B;QAC1B,IAAI,aAAa,CAAC,oBAAoB,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,aAAa,CAAC,oBAAoB,CAAC;YACjD,4FAA4F;YAC5F,iCAAiC;YACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACxD,QAAQ,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;QAED,IAAI,aAAa,CAAC,UAAU,EAAE,KAAK,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACrF,QAAQ,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IACD,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,MAAM,KAAK,CAAC;QACnC,aAAa;QACb,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,GAAG,OAAsC;IACrE,MAAM,MAAM,GAAkB,EAAE,CAAC;IAEjC,wDAAwD;IACxD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACvC,IAAI,MAAM;YAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA6C;IAK7C,MAAM,EAAE,aAAa,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,CAAC;IACjD,OAAO;QACL,QAAQ,EAAE,aAAa;QACvB,WAAW,EAAE,WAAuC;KACrD,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAC,aAA6B;IAChE,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAE9B,uCAAuC;IACvC,MAAM,SAAS,GAAG,0BAA0B,CAAC,aAAa,CAAC,CAAC;IAC5D,MAAM,mBAAmB,GAAG,SAAS,CAAC,UAAmE,CAAC;IAE1G,OAAO;QACL,OAAO,EAAE,aAAa,CAAC,OAAO;QAC9B,QAAQ,EAAE,aAAa,CAAC,QAAQ;QAChC,YAAY,EAAE,aAAa,CAAC,UAAU,EAAE,EAAE;QAC1C,eAAe,EAAE,mBAAmB,EAAE,KAAK,EAAG,kCAAkC;QAChF,cAAc,EAAE,aAAa,CAAC,cAAc;QAC5C,SAAS,EAAE,aAAa,CAAC,SAAS;QAClC,KAAK,EAAE,aAAa,CAAC,KAAK;KAC3B,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,aAA6B;IACtE,IAAI,CAAC,aAAa;QAAE,OAAO,EAAE,CAAC;IAE9B,oDAAoD;IACpD,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,EAAE,GAAG,aAAa,CAAC;IAEtD,MAAM,MAAM,GAA4B,EAAE,GAAG,YAAY,EAAE,CAAC;IAE5D,wCAAwC;IACxC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,mBAAmB,GAA4B,EAAE,CAAC;QAExD,IAAI,UAAU,CAAC,EAAE,EAAE,CAAC;YAClB,mBAAmB,CAAC,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;QACzC,CAAC;QAED,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,gEAAgE;YAChE,mBAAmB,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;QACrF,CAAC;QAED,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;YAC1B,mBAAmB,CAAC,UAAU,GAAG;gBAC/B,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI;gBAChC,KAAK,EAAE,YAAY;aACpB,CAAC;QACJ,CAAC;QACD,MAAM,CAAC,UAAU,GAAG,mBAAmB,CAAC;IAC1C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/esm/utils/stop-reason-mapper.js

@@ -0,0 +1,69 @@
+/**
+ * Stop Reason Mapper Utilities
+ *
+ * Centralized stop reason mapping logic using lookup tables
+ * instead of nested conditionals. Based on the good example
+ * from the anthropic-node middleware.
+ */
+/**
+ * Stop reason mapping configuration
+ * Maps provider-specific stop reasons to Revenium's standardized set
+ */
+const STOP_REASON_MAP = {
+    // OpenAI/Azure OpenAI stop reasons
+    stop: 'END',
+    function_call: 'END_SEQUENCE',
+    tool_calls: 'END_SEQUENCE',
+    timeout: 'TIMEOUT',
+    length: 'TOKEN_LIMIT',
+    max_tokens: 'TOKEN_LIMIT',
+    cost_limit: 'COST_LIMIT',
+    completion_limit: 'COMPLETION_LIMIT',
+    content_filter: 'ERROR',
+    error: 'ERROR',
+    cancelled: 'CANCELLED',
+    canceled: 'CANCELLED', // Handle both spellings
+    // Anthropic stop reasons (for consistency across middleware)
+    end_turn: 'END',
+    stop_sequence: 'END_SEQUENCE',
+    tool_use: 'END_SEQUENCE',
+};
+/**
+ * Default stop reason when mapping fails
+ */
+const DEFAULT_STOP_REASON = 'END';
+/**
+ * Map provider stop reasons to Revenium stop reasons
+ *
+ * This replaces the nested if/switch logic with a clean lookup table approach.
+ * Based on the good example from the anthropic-node middleware.
+ *
+ * @param providerStopReason - Stop reason from the AI provider
+ * @param logger - Optional logger for warnings about unknown reasons
+ * @returns Standardized Revenium stop reason
+ */
+export function mapStopReason(providerStopReason, logger) {
+    if (!providerStopReason)
+        return DEFAULT_STOP_REASON;
+    const normalizedReason = providerStopReason.toLowerCase();
+    const mappedReason = STOP_REASON_MAP[normalizedReason];
+    if (!mappedReason) {
+        // Log warning for unknown stop reasons to help with future mapping
+        logger?.warn(`Unknown stop reason: ${providerStopReason}, mapping to ${DEFAULT_STOP_REASON}`);
+        return DEFAULT_STOP_REASON;
+    }
+    return mappedReason;
+}
+/**
+ * Get all supported stop reasons for documentation/testing
+ */
+export function getSupportedStopReasons() {
+    return Object.keys(STOP_REASON_MAP);
+}
+/**
+ * Check if a stop reason is supported
+ */
+export function isStopReasonSupported(reason) {
+    return reason.toLowerCase() in STOP_REASON_MAP;
+}
+//# sourceMappingURL=stop-reason-mapper.js.map

package/dist/esm/utils/stop-reason-mapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stop-reason-mapper.js","sourceRoot":"","sources":["../../../src/utils/stop-reason-mapper.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;GAGG;AACH,MAAM,eAAe,GAA2B;IAC9C,mCAAmC;IACnC,IAAI,EAAE,KAAK;IACX,aAAa,EAAE,cAAc;IAC7B,UAAU,EAAE,cAAc;IAC1B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,aAAa;IACrB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,kBAAkB;IACpC,cAAc,EAAE,OAAO;IACvB,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,WAAW,EAAG,wBAAwB;IAEhD,6DAA6D;IAC7D,QAAQ,EAAE,KAAK;IACf,aAAa,EAAE,cAAc;IAC7B,QAAQ,EAAE,cAAc;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,mBAAmB,GAAG,KAAK,CAAC;AAElC;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAC3B,kBAA6C,EAC7C,MAA4D;IAE5D,IAAI,CAAC,kBAAkB;QAAE,OAAO,mBAAmB,CAAC;IACpD,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,WAAW,EAAE,CAAC;IAC1D,MAAM,YAAY,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAEvD,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,mEAAmE;QACnE,MAAM,EAAE,IAAI,CAAC,wBAAwB,kBAAkB,gBAAgB,mBAAmB,EAAE,CAAC,CAAC;QAC9F,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAc;IAClD,OAAO,MAAM,CAAC,WAAW,EAAE,IAAI,eAAe,CAAC;AACjD,CAAC"}

package/dist/esm/utils/transaction-id.js

@@ -0,0 +1,16 @@
+/**
+ * Transaction ID Generator
+ *
+ * Generates unique transaction IDs for tracking requests.
+ * Format: txn_{timestamp}_{random}
+ */
+/**
+ * Generate a unique transaction ID
+ *
+ * @returns A unique transaction ID in format: txn_{timestamp}_{random}
+ *
+ */
+export function generateTransactionId() {
+    return `txn_${Date.now()}_${Math.random().toString(36).substring(2, 15)}`;
+}
+//# sourceMappingURL=transaction-id.js.map

package/dist/esm/utils/transaction-id.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-id.js","sourceRoot":"","sources":["../../../src/utils/transaction-id.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB;IACnC,OAAO,OAAO,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;AAC5E,CAAC"}