@revenium/openai 1.0.8

package/dist/types/core/tracking/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/tracking/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EACL,mBAAmB,EACnB,6BAA6B,EAC7B,eAAe,EACf,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/types/core/tracking/payload-builder.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Payload Builder Module
+ *
+ * Handles construction of Revenium API payloads.
+ * Extracted from tracking.ts for single responsibility.
+ */
+import { ReveniumPayload, ProviderInfo } from '../../types/index.js';
+import { OpenAIChatResponse, OpenAIEmbeddingResponse, OpenAIChatRequest, OpenAIEmbeddingRequest } from '../../types/function-parameters.js';
+/**
+ * Build payload for Revenium API
+ *
+ * This shared payload builder eliminates payload duplication between
+ * chat completions and embeddings. Handles both CHAT and EMBED operation types.
+ *
+ * @param operationType - Type of operation (CHAT or EMBED)
+ * @param response - API response from OpenAI/Azure
+ * @param request - Original request parameters
+ * @param startTime - Request start timestamp
+ * @param duration - Request duration in milliseconds
+ * @param providerInfo - Provider information for Azure support
+ * @returns Constructed payload for Revenium API
+ */
+export declare function buildPayload(operationType: 'CHAT' | 'EMBED', response: OpenAIChatResponse | OpenAIEmbeddingResponse, request: OpenAIChatRequest | OpenAIEmbeddingRequest, startTime: number, duration: number, providerInfo?: ProviderInfo): ReveniumPayload;
+//# sourceMappingURL=payload-builder.d.ts.map

package/dist/types/core/tracking/payload-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload-builder.d.ts","sourceRoot":"","sources":["../../../../src/core/tracking/payload-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,oCAAoC,CAAC;AAU5C;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAC1B,aAAa,EAAE,MAAM,GAAG,OAAO,EAC/B,QAAQ,EAAE,kBAAkB,GAAG,uBAAuB,EACtD,OAAO,EAAE,iBAAiB,GAAG,sBAAsB,EACnD,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,eAAe,CAsFjB"}

package/dist/types/core/tracking/usage-tracker.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Usage Tracker Module
+ *
+ * High-level tracking functions that combine payload building and API communication.
+ * Extracted from tracking.ts for better organization.
+ */
+import { UsageMetadata, ProviderInfo } from '../../types/index.js';
+import { OpenAIChatResponse, OpenAIEmbeddingResponse, OpenAIChatRequest, OpenAIEmbeddingRequest } from '../../types/function-parameters.js';
+/**
+ * Chat completions tracking - now a thin wrapper with Azure support
+ */
+export declare function sendReveniumMetrics(response: OpenAIChatResponse, request: OpenAIChatRequest, startTime: number, duration: number, providerInfo?: ProviderInfo): Promise<void>;
+/**
+ * Embeddings tracking - now a thin wrapper with Azure support
+ */
+export declare function sendReveniumEmbeddingsMetrics(response: OpenAIEmbeddingResponse, request: OpenAIEmbeddingRequest, startTime: number, duration: number, providerInfo?: ProviderInfo): Promise<void>;
+/**
+ * Fire-and-forget wrapper for chat completions with Azure support
+ */
+export declare function trackUsageAsync(trackingData: {
+    requestId: string;
+    model: string;
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+    reasoningTokens?: number;
+    cachedTokens?: number;
+    duration: number;
+    finishReason: string | null;
+    usageMetadata?: UsageMetadata;
+    isStreamed?: boolean;
+    timeToFirstToken?: number;
+    providerInfo?: ProviderInfo;
+}): void;
+/**
+ * Fire-and-forget wrapper for embeddings with Azure support
+ */
+export declare function trackEmbeddingsUsageAsync(trackingData: {
+    transactionId: string;
+    model: string;
+    promptTokens: number;
+    totalTokens: number;
+    duration: number;
+    usageMetadata?: UsageMetadata;
+    requestStartTime: number;
+    providerInfo?: ProviderInfo;
+}): void;
+//# sourceMappingURL=usage-tracker.d.ts.map

package/dist/types/core/tracking/usage-tracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-tracker.d.ts","sourceRoot":"","sources":["../../../../src/core/tracking/usage-tracker.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACnE,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,oCAAoC,CAAC;AAS5C;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,iBAAiB,EAC1B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,CAAC,CAcf;AAED;;GAEG;AACH,wBAAsB,6BAA6B,CACjD,QAAQ,EAAE,uBAAuB,EACjC,OAAO,EAAE,sBAAsB,EAC/B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,IAAI,CAAC,CAcf;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,GAAG,IAAI,CAiDP;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,YAAY,EAAE;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B,GAAG,IAAI,CAmCP"}

package/dist/types/core/wrapper/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Wrapper module - Main exports
+ *
+ * This module provides a clean interface for OpenAI client wrapping,
+ * separating concerns into focused sub-modules.
+ */
+export { patchOpenAI, patchOpenAIInstance, getProviderInfo } from './instance-patcher.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/core/wrapper/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/wrapper/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/types/core/wrapper/instance-patcher.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Instance Patcher Module
+ *
+ * Handles patching of OpenAI client instances.
+ * Extracted from wrapper.ts for better organization.
+ */
+import OpenAI from 'openai';
+import { ProviderInfo } from '../../types/index.js';
+import { OpenAIClientInstance } from '../../types/function-parameters.js';
+import '../../types/openai-augmentation.js';
+/**
+ * WeakMap to store provider information for each client instance
+ */
+declare const instanceProviders: WeakMap<OpenAIClientInstance, ProviderInfo>;
+/**
+ * Get provider information for a client instance
+ */
+export declare function getProviderInfo(instance: OpenAIClientInstance): ProviderInfo | undefined;
+/**
+ * Simple approach: Only patch instances when users create them
+ * No global patching, no dummy keys - just clean instance patching
+ */
+export declare function patchOpenAI(): void;
+/**
+ * Manually patch an existing OpenAI instance
+ * This is the main function users should call
+ */
+export declare function patchOpenAIInstance(instance: OpenAI): OpenAI;
+/**
+ * Export instance providers for request handlers
+ */
+export { instanceProviders };
+//# sourceMappingURL=instance-patcher.d.ts.map

package/dist/types/core/wrapper/instance-patcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance-patcher.d.ts","sourceRoot":"","sources":["../../../../src/core/wrapper/instance-patcher.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,MAAM,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EACL,oBAAoB,EAKrB,MAAM,oCAAoC,CAAC;AAY5C,OAAO,oCAAoC,CAAC;AAc5C;;GAEG;AACH,QAAA,MAAM,iBAAiB,6CAAoD,CAAC;AAK5E;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,oBAAoB,GAAG,YAAY,GAAG,SAAS,CAExF;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAGlC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAyB5D;AA4LD;;GAEG;AACH,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/types/core/wrapper/request-handler.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Request Handler Module
+ *
+ * Handles different types of OpenAI requests (streaming, non-streaming, embeddings).
+ * Extracted from wrapper.ts for better organization.
+ */
+import { UsageMetadata, OpenAIResponsesRequest } from '../../types/index.js';
+import { OpenAIChatResponse, OpenAIEmbeddingResponse, OpenAIChatRequest, OpenAIEmbeddingRequest, OpenAIClientInstance, OpenAIRequestOptions, OpenAIOriginalFunction, OpenAIResponsesOriginalFunction } from '../../types/function-parameters.js';
+/**
+ * Handle non-streaming OpenAI requests
+ */
+export declare function handleNonStreamingRequest(originalCreate: OpenAIOriginalFunction, params: Omit<OpenAIChatRequest, 'usageMetadata'> | Omit<OpenAIEmbeddingRequest, 'usageMetadata'>, options: OpenAIRequestOptions | undefined, usageMetadata: UsageMetadata | undefined, requestStartTime: number, instance: OpenAIClientInstance): Promise<OpenAIChatResponse | OpenAIEmbeddingResponse>;
+/**
+ * Handle streaming OpenAI requests
+ */
+export declare function handleStreamingRequest(originalCreate: OpenAIOriginalFunction, params: Omit<OpenAIChatRequest, 'usageMetadata'>, options: OpenAIRequestOptions | undefined, usageMetadata: UsageMetadata | undefined, requestStartTime: number, instance: OpenAIClientInstance): Promise<AsyncIterable<unknown>>;
+/**
+ * Handle embeddings requests
+ */
+export declare function handleEmbeddingsRequest(originalCreate: OpenAIOriginalFunction, params: Omit<OpenAIEmbeddingRequest, 'usageMetadata'>, options: OpenAIRequestOptions | undefined, usageMetadata: UsageMetadata | undefined, requestStartTime: number, instance: OpenAIClientInstance): Promise<OpenAIEmbeddingResponse>;
+/**
+ * Handle non-streaming OpenAI Responses API requests
+ */
+export declare function handleResponsesNonStreamingRequest(originalCreate: OpenAIResponsesOriginalFunction, params: Omit<OpenAIResponsesRequest, 'usageMetadata'>, options: OpenAIRequestOptions | undefined, usageMetadata: UsageMetadata | undefined, requestStartTime: number, instance: OpenAIClientInstance): Promise<unknown>;
+/**
+ * Handle streaming OpenAI Responses API requests
+ */
+export declare function handleResponsesStreamingRequest(originalCreate: OpenAIResponsesOriginalFunction, params: Omit<OpenAIResponsesRequest, 'usageMetadata'>, options: OpenAIRequestOptions | undefined, usageMetadata: UsageMetadata | undefined, requestStartTime: number, instance: OpenAIClientInstance): Promise<AsyncIterable<unknown>>;
+//# sourceMappingURL=request-handler.d.ts.map

package/dist/types/core/wrapper/request-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-handler.d.ts","sourceRoot":"","sources":["../../../../src/core/wrapper/request-handler.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,+BAA+B,EAChC,MAAM,oCAAoC,CAAC;AAgB5C;;GAEG;AACH,wBAAsB,yBAAyB,CAC7C,cAAc,EAAE,sBAAsB,EACtC,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,eAAe,CAAC,GAAG,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAC,EAChG,OAAO,EAAE,oBAAoB,GAAG,SAAS,EACzC,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,oBAAoB,GAC7B,OAAO,CAAC,kBAAkB,GAAG,uBAAuB,CAAC,CAuEvD;AAED;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,cAAc,EAAE,sBAAsB,EACtC,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,eAAe,CAAC,EAChD,OAAO,EAAE,oBAAoB,GAAG,SAAS,EACzC,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,oBAAoB,GAC7B,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAwCjC;AAED;;GAEG;AACH,wBAAsB,uBAAuB,CAC3C,cAAc,EAAE,sBAAsB,EACtC,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAC,EACrD,OAAO,EAAE,oBAAoB,GAAG,SAAS,EACzC,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,oBAAoB,GAC7B,OAAO,CAAC,uBAAuB,CAAC,CA8ClC;AAED;;GAEG;AACH,wBAAsB,kCAAkC,CACtD,cAAc,EAAE,+BAA+B,EAC/C,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAC,EACrD,OAAO,EAAE,oBAAoB,GAAG,SAAS,EACzC,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,oBAAoB,GAC7B,OAAO,CAAC,OAAO,CAAC,CAiElB;AAED;;GAEG;AACH,wBAAsB,+BAA+B,CACnD,cAAc,EAAE,+BAA+B,EAC/C,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAC,EACrD,OAAO,EAAE,oBAAoB,GAAG,SAAS,EACzC,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,oBAAoB,GAC7B,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CA2BjC"}

package/dist/types/core/wrapper/stream-wrapper.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Stream Wrapper Module
+ *
+ * Handles wrapping of streaming responses for usage tracking.
+ * Extracted from wrapper.ts for better organization.
+ */
+import { UsageMetadata } from '../../types/index.js';
+import { OpenAIClientInstance } from '../../types/function-parameters.js';
+/**
+ * Create a simple stream wrapper that tracks usage when complete
+ */
+export declare function createTrackingStreamWrapper(originalStream: AsyncIterable<unknown>, usageMetadata: UsageMetadata | undefined, requestStartTime: number, instance: OpenAIClientInstance): AsyncIterable<unknown>;
+//# sourceMappingURL=stream-wrapper.d.ts.map

package/dist/types/core/wrapper/stream-wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-wrapper.d.ts","sourceRoot":"","sources":["../../../../src/core/wrapper/stream-wrapper.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EACL,oBAAoB,EAGrB,MAAM,oCAAoC,CAAC;AAS5C;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,cAAc,EAAE,aAAa,CAAC,OAAO,CAAC,EACtC,aAAa,EAAE,aAAa,GAAG,SAAS,EACxC,gBAAgB,EAAE,MAAM,EACxB,QAAQ,EAAE,oBAAoB,GAC7B,aAAa,CAAC,OAAO,CAAC,CAsExB"}

package/dist/types/index.d.ts

@@ -0,0 +1,179 @@
+/**
+ * Revenium OpenAI Middleware for TypeScript
+ *
+ * This middleware tracks OpenAI usage and sends metrics to Revenium.
+ * Uses hybrid initialization: auto-initializes on import with graceful fallback to manual init.
+ *
+ * Environment Variables:
+ * REVENIUM_METERING_API_KEY=hak_your_api_key
+ * REVENIUM_METERING_BASE_URL=https://api.revenium.io/meter (optional)
+ * OPENAI_API_KEY=sk_your_openai_key
+ *
+ * Simple Usage (auto-initialization):
+ * import { patchOpenAIInstance } from 'revenium-middleware-openai-node';
+ * import OpenAI from 'openai';
+ *
+ * const openai = patchOpenAIInstance(new OpenAI());
+ * // Auto-initializes from environment variables
+ *
+ * Advanced Usage (explicit initialization):
+ * import { initializeReveniumFromEnv, patchOpenAIInstance } from 'revenium-middleware-openai-node';
+ * import OpenAI from 'openai';
+ *
+ * const result = initializeReveniumFromEnv();
+ * if (!result.success) {
+ *   throw new Error(result.message);
+ * }
+ * const openai = patchOpenAIInstance(new OpenAI());
+ *
+ * const response = await openai.chat.completions.create({
+ *   model: 'gpt-4',
+ *   messages: [{ role: 'user', content: 'Hello!' }],
+ *   usageMetadata: {
+ *     subscriber: {
+ *       id: 'user-123',
+ *       email: 'user@my-org.com'
+ *     },
+ *     organizationId: 'my-org',
+ *     productId: 'my-app'
+ *   }
+ * });
+ */
+import './types/openai-augmentation.js';
+import type { ReveniumConfig } from './types/index.js';
+/**
+ * Core types for TypeScript developers using Revenium middleware
+ *
+ * These types provide comprehensive TypeScript support for the Revenium OpenAI middleware,
+ * enabling type-safe configuration, usage tracking, and integration with OpenAI APIs.
+ *
+ * @public
+ */
+export type { 
+/**
+ * Configuration interface for Revenium middleware initialization
+ *
+ * Defines all required and optional settings for connecting to Revenium's
+ * metering API and configuring middleware behavior.
+ *
+ * @example
+ * ```typescript
+ * const config: ReveniumConfig = {
+ *   reveniumApiKey: 'hak_your_api_key',
+ *   reveniumBaseUrl: 'https://api.revenium.io/meter',
+ *   debug: true
+ * };
+ * ```
+ */
+ReveniumConfig, 
+/**
+ * Usage metadata structure for tracking AI API calls
+ *
+ * Comprehensive metadata interface that allows tracking of user context,
+ * business information, and custom fields for detailed analytics and billing.
+ * All fields are optional to provide maximum flexibility.
+ *
+ * @example
+ * ```typescript
+ * const metadata: UsageMetadata = {
+ *   subscriber: { id: 'user-123', email: 'user@company.com' },
+ *   organizationId: 'company-456',
+ *   productId: 'chat-app',
+ *   taskType: 'customer-support'
+ * };
+ * ```
+ */
+UsageMetadata, 
+/**
+ * Logger interface for custom logging implementations
+ *
+ * Standardized logging interface that allows custom logger integration
+ * while maintaining consistent log levels and metadata support.
+ *
+ * @example
+ * ```typescript
+ * const customLogger: Logger = {
+ *   debug: (msg, meta) => console.debug(msg, meta),
+ *   info: (msg, meta) => console.info(msg, meta),
+ *   warn: (msg, meta) => console.warn(msg, meta),
+ *   error: (msg, meta) => console.error(msg, meta)
+ * };
+ * ```
+ */
+Logger, 
+/**
+ * Azure OpenAI configuration interface
+ *
+ * Specific configuration options for Azure OpenAI integration,
+ * including endpoint, API version, and deployment settings.
+ *
+ * @example
+ * ```typescript
+ * const azureConfig: AzureConfig = {
+ *   endpoint: 'https://your-resource.openai.azure.com',
+ *   apiVersion: '2024-02-01',
+ *   deployment: 'gpt-4'
+ * };
+ * ```
+ */
+AzureConfig, 
+/**
+ * AI provider enumeration
+ *
+ * Supported AI providers for automatic detection and routing.
+ * Used internally for provider-specific handling and metrics.
+ */
+Provider, 
+/**
+ * Provider information structure
+ *
+ * Detailed information about the detected AI provider, including
+ * configuration details and Azure-specific settings when applicable.
+ *
+ * @example
+ * ```typescript
+ * const providerInfo: ProviderInfo = {
+ *   provider: Provider.AZURE_OPENAI,
+ *   isAzure: true,
+ *   endpoint: 'https://your-resource.openai.azure.com',
+ *   deployment: 'gpt-4'
+ * };
+ * ```
+ */
+ProviderInfo, } from './types';
+export { trackUsageAsync, trackEmbeddingsUsageAsync } from './core/tracking/index.js';
+export { detectProvider, hasAzureConfig, validateAzureConfig, getProviderMetadata, } from './core/providers/index.js';
+export { getProviderInfo } from './core/wrapper/index.js';
+export { resolveAzureModelName, clearModelNameCache, getModelNameCacheStats, batchResolveModelNames, wouldTransformDeploymentName, } from './utils/azure-model-resolver.js';
+/**
+ * Initialize Revenium middleware with configuration
+ */
+export declare function initializeRevenium(config: ReveniumConfig): {
+    success: boolean;
+    message: string;
+};
+/**
+ * Initialize Revenium middleware from environment variables
+ */
+export declare function initializeReveniumFromEnv(): {
+    success: boolean;
+    message: string;
+};
+/**
+ * Manually patch an OpenAI instance (for advanced use cases)
+ */
+export { patchOpenAIInstance } from './core/wrapper/index.js';
+/**
+ * Check if middleware has been initialized
+ */
+export declare function isReveniumInitialized(): boolean;
+/**
+ * Get detailed initialization status
+ */
+export declare function getInitializationStatus(): {
+    initialized: boolean;
+    hasConfig: boolean;
+    hasApiKey: boolean;
+    autoInitAttempted: boolean;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAGH,OAAO,gCAAgC,CAAC;AAWxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAMvD;;;;;;;GAOG;AACH,YAAY;AACV;;;;;;;;;;;;;;GAcG;AACH,cAAc;AAEd;;;;;;;;;;;;;;;;GAgBG;AACH,aAAa;AAEb;;;;;;;;;;;;;;;GAeG;AACH,MAAM;AAEN;;;;;;;;;;;;;;GAcG;AACH,WAAW;AAEX;;;;;GAKG;AACH,QAAQ;AAER;;;;;;;;;;;;;;;GAeG;AACH,YAAY,GACb,MAAM,SAAS,CAAC;AAOjB,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAGtF,OAAO,EACL,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAG1D,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,4BAA4B,GAC7B,MAAM,iCAAiC,CAAC;AAKzC;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,cAAc,GAAG;IAC1D,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAoCA;AAED;;GAEG;AACH,wBAAgB,yBAAyB,IAAI;IAC3C,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CA8BA;AAED;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AA6B9D;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,OAAO,CAE/C;AAED;;GAEG;AACH,wBAAgB,uBAAuB,IAAI;IACzC,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAQA"}

package/dist/types/types/function-parameters.d.ts

@@ -0,0 +1,229 @@
+/**
+ * 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 OpenAI API structures and internal requirements.
+ *
+ * @fileoverview Type-safe function parameter definitions
+ * @author Revenium
+ * @since 1.0.0
+ */
+import { UsageMetadata } from './index';
+import { OpenAIResponsesRequest } from './responses-api';
+/**
+ * OpenAI API response structure for chat completions
+ *
+ * Represents the complete response structure returned by OpenAI's chat completions API.
+ * Includes usage statistics, response choices, and metadata. Used internally for
+ * processing responses and extracting usage metrics.
+ *
+ * @public
+ * @example
+ * ```typescript
+ * const response: OpenAIChatResponse = {
+ *   id: 'chatcmpl-123',
+ *   model: 'gpt-4o-mini',
+ *   usage: {
+ *     prompt_tokens: 10,
+ *     completion_tokens: 20,
+ *     total_tokens: 30
+ *   },
+ *   choices: [{
+ *     finish_reason: 'stop',
+ *     message: {
+ *       content: 'Hello! How can I help you?',
+ *       role: 'assistant'
+ *     }
+ *   }]
+ * };
+ * ```
+ */
+export interface OpenAIChatResponse {
+    /** Unique identifier for the chat completion */
+    id: string;
+    /** Model used for the completion */
+    model: string;
+    /** Token usage statistics */
+    usage: {
+        /** Number of tokens in the prompt */
+        prompt_tokens: number;
+        /** Number of tokens in the completion */
+        completion_tokens: number;
+        /** Total tokens used (prompt + completion) */
+        total_tokens: number;
+        /** Number of reasoning tokens (for reasoning models) */
+        reasoning_tokens?: number;
+        /** Number of cached tokens used */
+        cached_tokens?: number;
+    };
+    /** Array of completion choices */
+    choices: Array<{
+        /** Reason why the completion finished */
+        finish_reason: string | null;
+        /** Complete message (for non-streaming responses) */
+        message?: {
+            /** Message content */
+            content: string;
+            /** Message role (assistant, user, system) */
+            role: string;
+        };
+        /** Delta message (for streaming responses) */
+        delta?: {
+            /** Incremental content */
+            content?: string;
+            /** Message role */
+            role?: string;
+        };
+    }>;
+    /** Unix timestamp of when the completion was created */
+    created?: number;
+    /** Object type identifier */
+    object?: string;
+}
+/**
+ * OpenAI API response structure for embeddings
+ */
+export interface OpenAIEmbeddingResponse {
+    model: string;
+    usage: {
+        prompt_tokens: number;
+        total_tokens: number;
+    };
+    data: Array<{
+        embedding: number[];
+        index: number;
+        object: string;
+    }>;
+    object: string;
+}
+/**
+ * OpenAI chat completion request parameters
+ */
+export interface OpenAIChatRequest {
+    model: string;
+    messages: Array<{
+        role: string;
+        content: string;
+    }>;
+    stream?: boolean;
+    usageMetadata?: UsageMetadata;
+    max_tokens?: number;
+    temperature?: number;
+    top_p?: number;
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    stop?: string | string[];
+    [key: string]: unknown;
+}
+/**
+ * OpenAI embeddings request parameters
+ */
+export interface OpenAIEmbeddingRequest {
+    model: string;
+    input: string | string[];
+    usageMetadata?: UsageMetadata;
+    encoding_format?: string;
+    dimensions?: number;
+    user?: string;
+    [key: string]: unknown;
+}
+/**
+ * OpenAI client instance interface
+ */
+export interface OpenAIClientInstance {
+    baseURL?: string | URL;
+    constructor?: {
+        name: string;
+    };
+    chat?: {
+        completions?: {
+            create: any;
+        };
+    };
+    embeddings?: {
+        create: any;
+    };
+    [key: string]: unknown;
+}
+/**
+ * OpenAI request options
+ */
+export interface OpenAIRequestOptions {
+    headers?: Record<string, string>;
+    timeout?: number;
+    signal?: AbortSignal;
+    [key: string]: unknown;
+}
+/**
+ * Azure model resolver function parameters
+ */
+export interface AzureModelResolverParams {
+    deploymentName: string;
+    useCache?: boolean;
+}
+/**
+ * Provider detection function parameters
+ */
+export interface ProviderDetectionParams {
+    client: OpenAIClientInstance;
+}
+/**
+ * Azure configuration validation result
+ */
+export interface AzureConfigValidationResult {
+    isValid: boolean;
+    missingFields: string[];
+    warnings: string[];
+}
+/**
+ * Lazy loading function type for Azure modules
+ */
+export interface LazyLoadedModule {
+    [key: string]: any;
+}
+/**
+ * Console logger arguments type
+ */
+export type LoggerArgs = unknown[];
+/**
+ * Generic function type for original OpenAI methods
+ */
+export type OpenAIOriginalFunction = (params: OpenAIChatRequest | OpenAIEmbeddingRequest, options?: OpenAIRequestOptions) => Promise<OpenAIChatResponse | OpenAIEmbeddingResponse>;
+/**
+ * Function type for original OpenAI Responses API methods
+ */
+export type OpenAIResponsesOriginalFunction = (params: OpenAIResponsesRequest, options?: OpenAIRequestOptions) => Promise<unknown>;
+/**
+ * Stream chunk interface for streaming responses
+ */
+export interface StreamChunk {
+    id: string;
+    model: string;
+    usage?: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+        reasoning_tokens?: number;
+        cached_tokens?: number;
+    };
+    choices?: Array<{
+        delta?: {
+            content?: string;
+            role?: string;
+        };
+        finish_reason?: string | null;
+    }>;
+    [key: string]: unknown;
+}
+/**
+ * Extended usage interface that includes optional reasoning and cached tokens
+ */
+export interface ExtendedUsage {
+    prompt_tokens: number;
+    completion_tokens: number;
+    total_tokens: number;
+    reasoning_tokens?: number;
+    cached_tokens?: number;
+}
+//# sourceMappingURL=function-parameters.d.ts.map

package/dist/types/types/function-parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-parameters.d.ts","sourceRoot":"","sources":["../../../src/types/function-parameters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,aAAa,EAAgB,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,kBAAkB;IACjC,gDAAgD;IAChD,EAAE,EAAE,MAAM,CAAC;IACX,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,KAAK,EAAE;QACL,qCAAqC;QACrC,aAAa,EAAE,MAAM,CAAC;QACtB,yCAAyC;QACzC,iBAAiB,EAAE,MAAM,CAAC;QAC1B,8CAA8C;QAC9C,YAAY,EAAE,MAAM,CAAC;QACrB,wDAAwD;QACxD,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,mCAAmC;QACnC,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,kCAAkC;IAClC,OAAO,EAAE,KAAK,CAAC;QACb,yCAAyC;QACzC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,qDAAqD;QACrD,OAAO,CAAC,EAAE;YACR,sBAAsB;YACtB,OAAO,EAAE,MAAM,CAAC;YAChB,6CAA6C;YAC7C,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QACF,8CAA8C;QAC9C,KAAK,CAAC,EAAE;YACN,0BAA0B;YAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,mBAAmB;YACnB,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC,CAAC;IACH,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,IAAI,EAAE,KAAK,CAAC;QACV,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACvB,WAAW,CAAC,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,IAAI,CAAC,EAAE;QACL,WAAW,CAAC,EAAE;YACZ,MAAM,EAAE,GAAG,CAAC;SACb,CAAC;KACH,CAAC;IACF,UAAU,CAAC,EAAE;QACX,MAAM,EAAE,GAAG,CAAC;KACb,CAAC;IAEF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,oBAAoB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,EAAE,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CACnC,MAAM,EAAE,iBAAiB,GAAG,sBAAsB,EAClD,OAAO,CAAC,EAAE,oBAAoB,KAC3B,OAAO,CAAC,kBAAkB,GAAG,uBAAuB,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,+BAA+B,GAAG,CAC5C,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,oBAAoB,KAC3B,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE;QACN,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,YAAY,EAAE,MAAM,CAAC;QACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE;YACN,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;QACF,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B,CAAC,CAAC;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}