@revenium/openai 1.0.13 → 1.0.14

package/src/core/config/azure-config.ts

@@ -1,72 +0,0 @@
-/**
- * Azure Configuration Module
- *
- * Handles Azure-specific configuration logic.
- * Extracted from provider.ts for better separation of concerns.
- */
-
-import { AzureConfig } from '../../types/index.js';
-import { OpenAIClientInstance } from '../../types/function-parameters.js';
-import { getLogger } from './manager.js';
-
-// Global logger
-const logger = getLogger();
-
-/**
- * Gather Azure configuration from client and environment
- *
- * @param client - OpenAI/AzureOpenAI client instance
- * @returns AzureConfig object
- */
-export function gatherAzureConfig(client: OpenAIClientInstance): AzureConfig {
-  const config: AzureConfig = {};
-  try {
-    // Extract from client baseURL if available
-    if (client?.baseURL) {
-      const baseUrl =
-        typeof client.baseURL === 'string' ? client.baseURL : client.baseURL?.toString();
-      config.endpoint = baseUrl;
-    }
-
-    // Extract from environment variables
-    if (process.env.AZURE_OPENAI_ENDPOINT) {
-      config.endpoint = process.env.AZURE_OPENAI_ENDPOINT;
-    }
-
-    if (process.env.AZURE_OPENAI_DEPLOYMENT) {
-      config.deployment = process.env.AZURE_OPENAI_DEPLOYMENT;
-    }
-
-    if (process.env.AZURE_OPENAI_API_VERSION) {
-      config.apiVersion = process.env.AZURE_OPENAI_API_VERSION;
-    } else {
-      // Default to preferred API version from Python learnings
-      config.apiVersion = '2024-12-01-preview';
-    }
-
-    if (process.env.AZURE_OPENAI_API_KEY) {
-      config.apiKey = process.env.AZURE_OPENAI_API_KEY;
-    }
-
-    if (process.env.AZURE_OPENAI_TENANT_ID) {
-      config.tenantId = process.env.AZURE_OPENAI_TENANT_ID;
-    }
-
-    if (process.env.AZURE_OPENAI_RESOURCE_GROUP) {
-      config.resourceGroup = process.env.AZURE_OPENAI_RESOURCE_GROUP;
-    }
-
-    logger.debug('Azure configuration gathered', {
-      hasEndpoint: !!config.endpoint,
-      hasDeployment: !!config.deployment,
-      hasApiKey: !!config.apiKey,
-      apiVersion: config.apiVersion,
-    });
-  } catch (error) {
-    logger.warn('Error gathering Azure configuration', {
-      error: error instanceof Error ? error.message : String(error),
-    });
-  }
-
-  return config;
-}

package/src/core/config/index.ts

@@ -1,23 +0,0 @@
-/**
- * Configuration module - Main exports
- *
- * This module provides a clean interface for configuration management,
- * separating concerns into focused sub-modules.
- */
-
-// Re-export all configuration functionality
-export { loadConfigFromEnv, loadAzureConfigFromEnv, hasAzureConfigInEnv } from './loader.js';
-
-export { validateConfig, validateAzureConfig } from './validator.js';
-
-export {
-  getConfig,
-  setConfig,
-  getLogger,
-  setLogger,
-  initializeConfig,
-  defaultLogger,
-} from './manager.js';
-
-// Export Azure-specific configuration
-export * from './azure-config.js';

package/src/core/config/loader.ts

@@ -1,66 +0,0 @@
-/**
- * Configuration Loader Module
- *
- * Handles loading configuration from environment variables.
- * Separated from validation and management for single responsibility.
- */
-
-import { ReveniumConfig, AzureConfig } from '../../types/index.js';
-
-/**
- * Default Revenium base URL for consistency with other middleware
- */
-const DEFAULT_REVENIUM_BASE_URL = 'https://api.revenium.ai';
-
-/**
- * Load configuration from environment variables
- */
-export function loadConfigFromEnv(): ReveniumConfig | null {
-  const reveniumApiKey = process.env.REVENIUM_METERING_API_KEY || process.env.REVENIUM_API_KEY;
-  const reveniumBaseUrl =
-    process.env.REVENIUM_METERING_BASE_URL ||
-    process.env.REVENIUM_BASE_URL ||
-    DEFAULT_REVENIUM_BASE_URL;
-  const openaiApiKey = process.env.OPENAI_API_KEY;
-
-  if (!reveniumApiKey) return null;
-  return {
-    reveniumApiKey,
-    reveniumBaseUrl,
-    openaiApiKey,
-  };
-}
-
-/**
- * Load Azure configuration from environment variables
- */
-export function loadAzureConfigFromEnv(): AzureConfig | null {
-  const endpoint = process.env.AZURE_OPENAI_ENDPOINT;
-  const deployment = process.env.AZURE_OPENAI_DEPLOYMENT;
-  const apiVersion = process.env.AZURE_OPENAI_API_VERSION;
-  const apiKey = process.env.AZURE_OPENAI_API_KEY;
-  const tenantId = process.env.AZURE_OPENAI_TENANT_ID;
-  const resourceGroup = process.env.AZURE_OPENAI_RESOURCE_GROUP;
-
-  // Return null if no Azure config is present
-  if (!endpoint && !deployment && !apiKey) return null;
-  return {
-    endpoint,
-    deployment,
-    apiVersion: apiVersion || '2024-12-01-preview', // Default from Python learnings
-    apiKey,
-    tenantId,
-    resourceGroup,
-  };
-}
-
-/**
- * Check if Azure configuration is available in environment
- */
-export function hasAzureConfigInEnv(): boolean {
-  return !!(
-    process.env.AZURE_OPENAI_ENDPOINT ||
-    process.env.AZURE_OPENAI_DEPLOYMENT ||
-    process.env.AZURE_OPENAI_API_KEY
-  );
-}

package/src/core/config/manager.ts

@@ -1,95 +0,0 @@
-/**
- * Configuration Manager Module
- *
- * Handles global configuration state management and logging.
- * Separated from loading and validation for single responsibility.
- */
-
-import { ReveniumConfig, Logger } from '../../types/index.js';
-import { loadConfigFromEnv, hasAzureConfigInEnv } from './loader.js';
-import { validateConfig } from './validator.js';
-
-/**
- * Default console logger implementation
- */
-export const defaultLogger: Logger = {
-  debug: (message: string, ...args: unknown[]) => {
-    // Check both config.debug and environment variable
-    if (globalConfig?.debug || process.env.REVENIUM_DEBUG === 'true') {
-      console.debug(`[Revenium Debug] ${message}`, ...args);
-    }
-  },
-  info: (message: string, ...args: unknown[]) => {
-    console.info(`[Revenium] ${message}`, ...args);
-  },
-  warn: (message: string, ...args: unknown[]) => {
-    console.warn(`[Revenium Warning] ${message}`, ...args);
-  },
-  error: (message: string, ...args: unknown[]) => {
-    console.error(`[Revenium Error] ${message}`, ...args);
-  },
-};
-
-/**
- * Global configuration instance
- */
-let globalConfig: ReveniumConfig | null = null;
-let globalLogger: Logger = defaultLogger;
-
-/**
- * Get the current global configuration
- */
-export function getConfig(): ReveniumConfig | null {
-  return globalConfig;
-}
-
-/**
- * Set the global configuration
- */
-export function setConfig(config: ReveniumConfig): void {
-  validateConfig(config);
-  globalConfig = config;
-  globalLogger.debug('Revenium configuration updated', {
-    baseUrl: config.reveniumBaseUrl,
-    hasApiKey: !!config.reveniumApiKey,
-    hasOpenAIKey: !!config.openaiApiKey,
-  });
-}
-
-/**
- * Get the current logger
- */
-export function getLogger(): Logger {
-  return globalLogger;
-}
-
-/**
- * Set a custom logger
- */
-export function setLogger(logger: Logger): void {
-  globalLogger = logger;
-}
-
-/**
- * Initialize configuration from environment variables
- */
-export function initializeConfig(): boolean {
-  const envConfig = loadConfigFromEnv();
-  if (envConfig) {
-    try {
-      setConfig(envConfig);
-      globalLogger.debug('Revenium middleware initialized from environment variables');
-
-      // Log Azure config availability for debugging
-      if (hasAzureConfigInEnv()) {
-        globalLogger.debug('Azure OpenAI configuration detected in environment');
-      }
-
-      return true;
-    } catch (error) {
-      globalLogger.error('Failed to initialize Revenium configuration:', error);
-      return false;
-    }
-  }
-  return false;
-}

package/src/core/config/validator.ts

@@ -1,89 +0,0 @@
-/**
- * Configuration Validator Module
- *
- * Handles validation of configuration objects.
- * Separated from loading and management for single responsibility.
- */
-
-import { ReveniumConfig, AzureConfig } from '../../types/index.js';
-
-/**
- * Validate Revenium configuration
- */
-export function validateConfig(config: ReveniumConfig): void {
-  if (!config.reveniumApiKey) {
-    throw new Error(
-      'Revenium API key is required. Set REVENIUM_METERING_API_KEY environment variable or provide reveniumApiKey in config.'
-    );
-  }
-
-  if (!config.reveniumApiKey.startsWith('hak_')) {
-    throw new Error('Invalid Revenium API key format. Revenium API keys should start with "hak_"');
-  }
-
-  if (!config.reveniumBaseUrl) {
-    throw new Error(
-      'Revenium base URL is missing. This should not happen as a default URL should be provided.'
-    );
-  }
-
-  // Validate URL format
-  try {
-    new URL(config.reveniumBaseUrl);
-  } catch (error) {
-    throw new Error(`Invalid Revenium base URL format: ${config.reveniumBaseUrl}`);
-  }
-}
-
-/**
- * Validate Azure configuration completeness
- *
- * @param config - Azure configuration to validate
- * @returns validation result with missing fields
- */
-export function validateAzureConfig(config: AzureConfig): {
-  isValid: boolean;
-  missingFields: string[];
-  warnings: string[];
-} {
-  const missingFields: string[] = [];
-  const warnings: string[] = [];
-
-  // Required fields for basic Azure OpenAI operation
-  if (!config.endpoint) {
-    missingFields.push('endpoint');
-  }
-
-  if (!config.apiKey) {
-    missingFields.push('apiKey');
-  }
-
-  // Optional but recommended fields
-  if (!config.deployment) {
-    warnings.push('deployment name not specified - may need to be included in model parameter');
-  }
-
-  if (!config.apiVersion) {
-    warnings.push('API version not specified - using default 2024-12-01-preview');
-  }
-
-  // Validate endpoint format
-  if (config.endpoint) {
-    try {
-      new URL(config.endpoint);
-      if (!config.endpoint.toLowerCase().includes('azure')) {
-        warnings.push(
-          'endpoint does not contain "azure" - please verify this is an Azure OpenAI endpoint'
-        );
-      }
-    } catch (error) {
-      missingFields.push('valid endpoint URL');
-    }
-  }
-
-  return {
-    isValid: missingFields.length === 0,
-    missingFields,
-    warnings,
-  };
-}

package/src/core/providers/detector.ts

@@ -1,159 +0,0 @@
-/**
- * Provider Detection Module
- *
- * Handles detection of AI providers (OpenAI vs Azure OpenAI).
- * Extracted from provider.ts for better organization.
- */
-
-import { Provider, ProviderInfo, AzureConfig } from '../../types/index.js';
-import { OpenAIClientInstance } from '../../types/function-parameters.js';
-import { isOpenAIClientInstance } from '../../utils/type-guards.js';
-import { createProviderInfo, validateProviderInfo } from '../../utils/provider-detection.js';
-import { getLogger } from '../config/index.js';
-
-// Global logger
-const logger = getLogger();
-
-/**
- * Detect Azure OpenAI provider from client instance
- *
- * @param client - OpenAI or AzureOpenAI client instance
- * @returns ProviderInfo with detection results
- */
-export function detectProvider(client: OpenAIClientInstance): ProviderInfo {
-  // Validate client instance
-  if (!isOpenAIClientInstance(client)) {
-    logger.warn('Invalid OpenAI client instance provided to detectProvider');
-    return {
-      provider: Provider.OPENAI,
-      isAzure: false,
-      azureConfig: undefined,
-    };
-  }
-
-  try {
-    // Use strategy pattern for clean provider detection
-    const providerInfo = createProviderInfo(client, logger);
-
-    // Validate the result
-    const validation = validateProviderInfo(providerInfo);
-    if (validation.warnings.length > 0) {
-      logger.warn('Provider detection completed with warnings', {
-        warnings: validation.warnings,
-      });
-    }
-
-    // Log final result
-    if (providerInfo.isAzure) {
-      logger.info('Azure OpenAI provider detected', {
-        provider: providerInfo.provider,
-        hasAzureConfig: !!providerInfo.azureConfig,
-        endpoint: providerInfo.azureConfig?.endpoint ? '[REDACTED]' : undefined,
-      });
-    } else {
-      logger.debug('Standard OpenAI provider detected');
-    }
-
-    return providerInfo;
-  } catch (error) {
-    logger.warn('Error during provider detection, defaulting to OpenAI', {
-      error: error instanceof Error ? error.message : String(error),
-    });
-
-    // Default to OpenAI on any error
-    return {
-      provider: Provider.OPENAI,
-      isAzure: false,
-      azureConfig: undefined,
-    };
-  }
-}
-
-/**
- * Check if the current environment has Azure configuration
- * This is a lightweight check for lazy loading decisions
- *
- * @returns boolean indicating if Azure config is present
- */
-export function hasAzureConfig(): boolean {
-  return !!(
-    process.env.AZURE_OPENAI_ENDPOINT ||
-    process.env.AZURE_OPENAI_DEPLOYMENT ||
-    process.env.AZURE_OPENAI_API_KEY
-  );
-}
-
-/**
- * Validate Azure configuration completeness
- *
- * @param config - Azure configuration to validate
- * @returns validation result with missing fields
- */
-export function validateAzureConfig(config: AzureConfig): {
-  isValid: boolean;
-  missingFields: string[];
-  warnings: string[];
-} {
-  const missingFields: string[] = [];
-  const warnings: string[] = [];
-
-  // Required fields for basic Azure OpenAI operation
-  if (!config.endpoint) {
-    missingFields.push('endpoint');
-  }
-
-  if (!config.apiKey) {
-    missingFields.push('apiKey');
-  }
-
-  // Optional but recommended fields
-  if (!config.deployment) {
-    warnings.push('deployment name not specified - may need to be included in model parameter');
-  }
-
-  if (!config.apiVersion) {
-    warnings.push('API version not specified - using default 2024-12-01-preview');
-  }
-
-  // Validate endpoint format
-  if (config.endpoint) {
-    try {
-      new URL(config.endpoint);
-      if (!config.endpoint.toLowerCase().includes('azure')) {
-        warnings.push(
-          'endpoint does not contain "azure" - please verify this is an Azure OpenAI endpoint'
-        );
-      }
-    } catch (error) {
-      missingFields.push('valid endpoint URL');
-    }
-  }
-
-  return {
-    isValid: missingFields.length === 0,
-    missingFields,
-    warnings,
-  };
-}
-
-/**
- * Get provider metadata for Revenium payload
- *
- * @param providerInfo - Provider detection result
- * @returns metadata object for Revenium
- */
-export function getProviderMetadata(providerInfo: ProviderInfo): {
-  provider: string;
-  modelSource: string;
-} {
-  if (providerInfo.isAzure) {
-    return {
-      provider: 'Azure',
-      modelSource: 'AZURE_OPENAI',
-    };
-  }
-  return {
-    provider: 'OpenAI',
-    modelSource: 'OPENAI',  // Provider name when calling directly per spec
-  };
-}

package/src/core/providers/index.ts

@@ -1,16 +0,0 @@
-/**
- * Providers module - Main exports
- *
- * This module provides a clean interface for provider detection and management,
- * separating concerns into focused sub-modules.
- */
-
-// Re-export all provider functionality
-export {
-  detectProvider,
-  hasAzureConfig,
-  validateAzureConfig,
-  getProviderMetadata,
-} from './detector.js';
-
-export { gatherAzureConfig } from '../config/azure-config.js';

package/src/core/tracking/api-client.ts

@@ -1,78 +0,0 @@
-/**
- * Revenium API Client Module
- *
- * Handles HTTP communication with the Revenium API.
- * Extracted from tracking.ts for single responsibility.
- */
-
-import { ReveniumPayload } from '../../types/index.js';
-import { getConfig, getLogger } from '../config/index.js';
-import { buildReveniumUrl } from '../../utils/url-builder.js';
-
-// Global logger
-const logger = getLogger();
-
-/**
- * Send payload to Revenium API
- *
- * This is the shared HTTP function that eliminates all duplication
- * between chat completions and embeddings tracking.
- *
- * @param payload - The payload to send to Revenium
- */
-export async function sendToRevenium(payload: ReveniumPayload): Promise<void> {
-  const config = getConfig();
-  if (!config) return logger.warn('Revenium configuration not found, skipping tracking');
-
-  // Use the new URL builder utility instead of nested conditionals
-  const url = buildReveniumUrl(
-    config.reveniumBaseUrl || 'https://api.revenium.ai',
-    '/ai/completions'
-  );
-
-  logger.debug('Sending Revenium API request', {
-    url,
-    operationType: payload.operationType,
-    transactionId: payload.transactionId,
-    model: payload.model,
-    totalTokens: payload.totalTokenCount,
-  });
-
-  const response = await fetch(url, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-      Accept: 'application/json',
-      'x-api-key': config.reveniumApiKey,
-    },
-    body: JSON.stringify(payload),
-  });
-
-  logger.debug('Revenium API response', {
-    status: response.status,
-    statusText: response.statusText,
-    transactionId: payload.transactionId,
-    operationType: payload.operationType,
-  });
-
-  if (!response.ok) {
-    const responseText = await response.text();
-    logger.error('Revenium API error response', {
-      status: response.status,
-      statusText: response.statusText,
-      body: responseText,
-      transactionId: payload.transactionId,
-      operationType: payload.operationType,
-    });
-    throw new Error(
-      `Revenium API error: ${response.status} ${response.statusText} - ${responseText}`
-    );
-  }
-
-  const responseBody = await response.text();
-  logger.debug('Revenium tracking successful', {
-    transactionId: payload.transactionId,
-    operationType: payload.operationType,
-    response: responseBody,
-  });
-}

package/src/core/tracking/index.ts

@@ -1,21 +0,0 @@
-/**
- * Tracking module - Main exports
- *
- * This module provides a clean interface for usage tracking,
- * separating concerns into focused sub-modules.
- */
-
-// Re-export all tracking functionality
-export { sendToRevenium } from './api-client.js';
-
-export { buildPayload } from './payload-builder.js';
-
-export {
-  sendReveniumMetrics,
-  sendReveniumEmbeddingsMetrics,
-  trackUsageAsync,
-  trackEmbeddingsUsageAsync,
-} from './usage-tracker.js';
-
-// Export utility functions
-export { mapStopReason } from '../../utils/stop-reason-mapper.js';