@revenium/openai 1.0.13 → 1.0.14

package/dist/types/index.d.ts

@@ -2,45 +2,8 @@
  * 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.ai (optional)
- * OPENAI_API_KEY=sk_your_openai_key
- *
- * Simple Usage (auto-initialization):
- * import { patchOpenAIInstance } from '@revenium/openai';
- * import OpenAI from 'openai';
- *
- * const openai = patchOpenAIInstance(new OpenAI());
- * // Auto-initializes from environment variables
- *
- * Advanced Usage (explicit initialization):
- * import { initializeReveniumFromEnv, patchOpenAIInstance } from '@revenium/openai';
- * 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';
+import "./types/openai-augmentation.js";
 /**
  * Core types for TypeScript developers using Revenium middleware
  *
@@ -55,15 +18,6 @@ export type {
  *
  * 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.ai',
- *   debug: true
- * };
- * ```
  */
 ReveniumConfig, 
 /**
@@ -72,16 +26,6 @@ ReveniumConfig,
  * 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, 
 /**
@@ -89,16 +33,7 @@ UsageMetadata,
  *
  * 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, 
 /**
@@ -106,15 +41,6 @@ Logger,
  *
  * 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, 
 /**
@@ -129,72 +55,22 @@ Provider,
  *
  * 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;
-};
-/**
- * Configure Revenium middleware manually
- * Alias for initializeRevenium() with a more intuitive name
- *
- * @param config - Revenium configuration object
- * @returns Initialization result with success status and message
- *
- * @example
- * ```typescript
- * import { configure } from '@revenium/openai';
- *
- * configure({
- *   reveniumApiKey: 'hak_your_api_key',
- *   reveniumBaseUrl: 'https://api.revenium.ai',
- * });
- * ```
  */
-export declare function configure(config: ReveniumConfig): {
-    success: boolean;
-    message: string;
-};
+ProviderInfo, } from "./types";
 /**
- * Initialize Revenium middleware from environment variables
+ * Main API
  */
-export declare function initializeReveniumFromEnv(): {
-    success: boolean;
-    message: string;
-};
+export { Initialize, GetClient, IsInitialized, Reset, Configure, } from "./core/client";
 /**
- * Manually patch an OpenAI instance (for advanced use cases)
+ * Middleware classes
  */
-export { patchOpenAIInstance } from './core/wrapper/index.js';
+export { ReveniumOpenAI, ChatInterface, CompletionsInterface, EmbeddingsInterface, ResponsesInterface, StreamingWrapper, } from "./core/middleware";
 /**
- * Check if middleware has been initialized
+ * Tracking functions (for advanced use cases)
  */
-export declare function isReveniumInitialized(): boolean;
+export { trackUsageAsync, trackEmbeddingsUsageAsync } from "./core/tracking";
 /**
- * Get detailed initialization status
+ * Provider detection functions
  */
-export declare function getInitializationStatus(): {
-    initialized: boolean;
-    hasConfig: boolean;
-    hasApiKey: boolean;
-    autoInitAttempted: boolean;
-};
+export { detectProvider, hasAzureConfig, validateAzureConfig, getProviderMetadata, } from "./core/providers";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,cAAc,GAAG;IACjD,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB,CAEA;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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,gCAAgC,CAAC;AAExC;;;;;;;GAOG;AACH,YAAY;AACV;;;;;GAKG;AACH,cAAc;AAEd;;;;;;GAMG;AACH,aAAa;AAEb;;;;;;GAMG;AACH,MAAM;AAEN;;;;;GAKG;AACH,WAAW;AAEX;;;;;GAKG;AACH,QAAQ;AAER;;;;;GAKG;AACH,YAAY,GACb,MAAM,SAAS,CAAC;AAMjB;;GAEG;AACH,OAAO,EACL,UAAU,EACV,SAAS,EACT,aAAa,EACb,KAAK,EACL,SAAS,GACV,MAAM,eAAe,CAAC;AAEvB;;GAEG;AACH,OAAO,EACL,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAE7E;;GAEG;AACH,OAAO,EACL,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC"}

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

@@ -9,35 +9,14 @@
  * @author Revenium
  * @since 1.0.0
  */
-import { UsageMetadata } from './index';
-import { OpenAIResponsesRequest } from './responses-api';
+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 */

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

@@ -1 +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"}
+{"version":3,"file":"function-parameters.d.ts","sourceRoot":"","sources":["../../../src/types/function-parameters.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD;;;;;;GAMG;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"}

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

@@ -4,22 +4,13 @@
  * Central type definitions for the Revenium OpenAI middleware.
  * This module exports all core types used throughout the application.
  */
-export * from './function-parameters.js';
-export * from './responses-api.js';
+export * from "./function-parameters.js";
+export * from "./responses-api.js";
 /**
  * Credential information for subscriber authentication
  *
  * Represents authentication credentials that can be attached to subscriber information
  * for enhanced security and tracking capabilities.
- *
- * @public
- * @example
- * ```typescript
- * const credential: Credential = {
- *   name: 'api_token',
- *   value: 'user_token_abc123'
- * };
- * ```
  */
 export interface Credential {
     /** The name/type of the credential (e.g., 'api_token', 'session_id') */
@@ -32,19 +23,6 @@ export interface Credential {
  *
  * Represents end-user information for tracking and billing purposes.
  * All fields are optional to provide maximum flexibility in implementation.
- *
- * @public
- * @example
- * ```typescript
- * const subscriber: Subscriber = {
- *   id: 'user-12345',
- *   email: 'john.doe@company.com',
- *   credential: {
- *     name: 'session_token',
- *     value: 'abc123xyz'
- *   }
- * };
- * ```
  */
 export interface Subscriber {
     /** Unique identifier for the subscriber/user */
@@ -60,23 +38,6 @@ export interface Subscriber {
  * Comprehensive metadata structure that enables detailed tracking of AI API usage
  * for analytics, billing, and business intelligence purposes. All fields are optional
  * to provide maximum flexibility while maintaining consistency across language implementations.
- *
- * @public
- * @example
- * ```typescript
- * const metadata: UsageMetadata = {
- *   subscriber: {
- *     id: 'user-123',
- *     email: 'user@company.com'
- *   },
- *   organizationId: 'org-456',
- *   productId: 'chat-assistant',
- *   taskType: 'customer-support',
- *   traceId: 'trace-789',
- *   responseQualityScore: 0.95,  // 0.0-1.0 scale per API spec
- *   agent: 'support-bot-v2'
- * };
- * ```
  */
 export interface UsageMetadata {
     /** User identification information (nested structure for detailed tracking) */
@@ -102,18 +63,7 @@ export interface UsageMetadata {
  * Detailed information about the detected AI provider, including configuration
  * details and Azure-specific settings when applicable. Used internally for
  * provider-specific handling and metrics collection.
- *
- * @public
- * @example
- * ```typescript
- * const providerInfo: ProviderInfo = {
- *   provider: Provider.AZURE_OPENAI,
- *   isAzure: true,
- *   endpoint: 'https://my-resource.openai.azure.com',
- *   apiVersion: '2024-02-01',
- *   deployment: 'gpt-4-turbo'
- * };
- * ```
+
  */
 export interface ProviderInfo {
     /** The detected AI provider type */
@@ -124,8 +74,6 @@ export interface ProviderInfo {
     endpoint?: string;
     /** API version (for Azure OpenAI) */
     apiVersion?: string;
-    /** Deployment name (for Azure OpenAI) */
-    deployment?: string;
     /** Complete Azure configuration when available */
     azureConfig?: AzureConfig;
 }
@@ -134,14 +82,6 @@ export interface ProviderInfo {
  *
  * Enumeration of AI providers supported by the Revenium middleware.
  * Used for automatic detection, routing, and provider-specific handling.
- *
- * @public
- * @example
- * ```typescript
- * if (providerInfo.provider === Provider.AZURE_OPENAI) {
- *   console.log('Using Azure OpenAI');
- * }
- * ```
  */
 export declare enum Provider {
     /** Standard OpenAI API */
@@ -155,18 +95,6 @@ export declare enum Provider {
  * Configuration interface for Azure OpenAI Service integration.
  * Provides all necessary settings for connecting to Azure OpenAI endpoints
  * with proper authentication and resource identification.
- *
- * @public
- * @example
- * ```typescript
- * const azureConfig: AzureConfig = {
- *   endpoint: 'https://my-resource.openai.azure.com',
- *   apiKey: process.env.AZURE_OPENAI_API_KEY,
- *   apiVersion: '2024-02-01',
- *   deployment: 'gpt-4-turbo',
- *   tenantId: 'your-tenant-id'
- * };
- * ```
  */
 export interface AzureConfig {
     /** Azure OpenAI endpoint URL */
@@ -175,12 +103,6 @@ export interface AzureConfig {
     apiKey?: string;
     /** Azure OpenAI API version */
     apiVersion?: string;
-    /** Azure OpenAI deployment name */
-    deployment?: string;
-    /** Azure tenant ID for authentication */
-    tenantId?: string;
-    /** Azure resource group name */
-    resourceGroup?: string;
 }
 /**
  * Revenium configuration interface
@@ -188,17 +110,7 @@ export interface AzureConfig {
  * Main configuration interface for initializing the Revenium middleware.
  * Defines all required and optional settings for connecting to Revenium's
  * metering API and configuring middleware behavior.
- *
- * @public
- * @example
- * ```typescript
- * const config: ReveniumConfig = {
- *   reveniumApiKey: 'hak_your_revenium_api_key',
- *   reveniumBaseUrl: 'https://api.revenium.ai',
- *   debug: true,
- *   openaiApiKey: process.env.OPENAI_API_KEY
- * };
- * ```
+
  */
 export interface ReveniumConfig {
     /** Revenium API key for authentication (required) */
@@ -212,23 +124,17 @@ export interface ReveniumConfig {
     /** OpenAI API key (optional, can be set via environment variable) */
     openaiApiKey?: string;
 }
+/**
+ * Alias for ReveniumConfig for internal use
+ * @public
+ */
+export type Config = ReveniumConfig;
 /**
  * Logger interface for consistent logging
  *
  * Standardized logging interface that allows custom logger integration
  * while maintaining consistent log levels and metadata support throughout
  * the middleware. Supports both structured and string metadata.
- *
- * @public
- * @example
- * ```typescript
- * const customLogger: Logger = {
- *   debug: (msg, meta) => console.debug(`[DEBUG] ${msg}`, meta),
- *   info: (msg, meta) => console.info(`[INFO] ${msg}`, meta),
- *   warn: (msg, meta) => console.warn(`[WARN] ${msg}`, meta),
- *   error: (msg, meta) => console.error(`[ERROR] ${msg}`, meta)
- * };
- * ```
  */
 export interface Logger {
     /** Log debug-level messages with optional metadata */
@@ -245,8 +151,8 @@ export interface Logger {
  */
 export interface ReveniumPayload {
     transactionId: string;
-    operationType: 'CHAT' | 'GENERATE' | 'EMBED' | 'CLASSIFY' | 'SUMMARIZE' | 'TRANSLATE' | 'OTHER';
-    costType: 'AI';
+    operationType: "CHAT" | "GENERATE" | "EMBED" | "CLASSIFY" | "SUMMARIZE" | "TRANSLATE" | "OTHER";
+    costType: "AI";
     model: string;
     provider: string;
     modelSource?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,cAAc,0BAA0B,CAAC;AAGzC,cAAc,oBAAoB,CAAC;AAEnC;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,UAAU;IACzB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,UAAU;IACzB,gDAAgD;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,yEAAyE;IACzE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,iFAAiF;IACjF,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;;;;;;;;;;;;GAaG;AACH,oBAAY,QAAQ;IAClB,0BAA0B;IAC1B,MAAM,WAAW;IACjB,2BAA2B;IAC3B,YAAY,iBAAiB;CAC9B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,cAAc;IAC7B,qDAAqD;IACrD,cAAc,EAAE,MAAM,CAAC;IACvB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,oEAAoE;IACpE,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,MAAM;IACrB,sDAAsD;IACtD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IACtE,qDAAqD;IACrD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IACrE,wDAAwD;IACxD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IACrE,sDAAsD;IACtD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;CACjF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAE9B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;IAChG,QAAQ,EAAE,IAAI,CAAC;IAGf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAG5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IAGxB,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IAGxC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAGtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,cAAc,0BAA0B,CAAC;AAGzC,cAAc,oBAAoB,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,gDAAgD;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,uEAAuE;IACvE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,yEAAyE;IACzE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,iFAAiF;IACjF,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,oCAAoC;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;;;;GAKG;AACH,oBAAY,QAAQ;IAClB,0BAA0B;IAC1B,MAAM,WAAW;IACjB,2BAA2B;IAC3B,YAAY,iBAAiB;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,qDAAqD;IACrD,cAAc,EAAE,MAAM,CAAC;IACvB,4EAA4E;IAC5E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,oEAAoE;IACpE,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,cAAc,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,WAAW,MAAM;IACrB,sDAAsD;IACtD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IACtE,qDAAqD;IACrD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IACrE,wDAAwD;IACxD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IACrE,sDAAsD;IACtD,KAAK,CACH,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,OAAO,GAChD,IAAI,CAAC;CACT;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAE9B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,UAAU,GACV,WAAW,GACX,WAAW,GACX,OAAO,CAAC;IACZ,QAAQ,EAAE,IAAI,CAAC;IAGf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IAGzB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAG5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IAGxB,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,uBAAuB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAC;IAGxC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAGtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B"}

package/dist/types/types/openai-augmentation.d.ts

@@ -1,56 +1,7 @@
 /**
  * TypeScript module augmentation for OpenAI SDK
- *
- * This file extends OpenAI's existing types to include the usageMetadata field
- * through TypeScript's declaration merging feature. This provides seamless
- * integration with the OpenAI SDK, allowing developers to use usageMetadata
- * directly in OpenAI API calls without type casting or additional imports.
- *
- * The augmentation covers all major OpenAI API endpoints including:
- * - Chat completions (streaming and non-streaming)
- * - Embeddings
- * - Future API endpoints as they become available
- *
- * @fileoverview OpenAI SDK type augmentation for Revenium middleware
- * @author Revenium
- * @since 1.0.0
- *
- * @example Basic usage with chat completions
- * ```typescript
- * import '@revenium/openai';
- * import OpenAI from 'openai';
- *
- * const openai = new OpenAI();
- *
- * const response = await openai.chat.completions.create({
- *   model: 'gpt-4o-mini',
- *   messages: [{ role: 'user', content: 'Hello!' }],
- *   usageMetadata: {  // TypeScript recognizes this natively
- *     subscriber: {
- *       id: 'user-123',
- *       email: 'user@my-company.com'
- *     },
- *     organizationId: 'my-company',
- *     productId: 'chat-app',
- *     taskType: 'customer-support'
- *   }
- * });
- * ```
- *
- * @example Usage with embeddings
- * ```typescript
- * const embedding = await openai.embeddings.create({
- *   model: 'text-embedding-ada-002',
- *   input: 'Text to embed',
- *   usageMetadata: {
- *     subscriber: { id: 'user-456' },
- *     productId: 'search-engine',
- *     taskType: 'document-indexing'
- *   }
- * });
- * ```
  */
-import { UsageMetadata } from './index.js';
+import { UsageMetadata } from "./index.js";
 export {};
 /**
  * OpenAI Chat Completions API augmentation
@@ -58,7 +9,7 @@ export {};
  * Extends the OpenAI chat completions interfaces to include usageMetadata
  * for all completion types (base, streaming, and non-streaming).
  */
-declare module 'openai/resources/chat/completions/completions' {
+declare module "openai/resources/chat/completions/completions" {
     interface ChatCompletionCreateParamsBase {
         /**
          * Optional metadata for enhanced tracking and analytics.
@@ -68,32 +19,6 @@ declare module 'openai/resources/chat/completions/completions' {
          *
          * This metadata is automatically captured by the Revenium middleware and sent to
          * the Revenium API for detailed usage analytics and billing calculations.
-         *
-         * @since 1.0.0
-         * @example Basic user tracking
-         * ```typescript
-         * usageMetadata: {
-         *   subscriber: {
-         *     id: 'user-123',
-         *     email: 'user@my-company.com'
-         *   },
-         *   organizationId: 'my-company',
-         *   productId: 'support-app'
-         * }
-         * ```
-         *
-         * @example Advanced tracking with quality metrics
-         * ```typescript
-         * usageMetadata: {
-         *   subscriber: { id: 'user-456' },
-         *   organizationId: 'enterprise-corp',
-         *   productId: 'ai-assistant',
-         *   taskType: 'customer-support',
-         *   traceId: 'session-abc-123',
-         *   responseQualityScore: 0.95,
-         *   agent: 'support-bot-v2'
-         * }
-         * ```
          */
         usageMetadata?: UsageMetadata;
     }
@@ -126,7 +51,7 @@ declare module 'openai/resources/chat/completions/completions' {
  * Extends the OpenAI embeddings interface to include usageMetadata
  * for comprehensive tracking of embedding generation requests.
  */
-declare module 'openai/resources/embeddings' {
+declare module "openai/resources/embeddings" {
     interface EmbeddingCreateParams {
         /**
          * Optional metadata for enhanced tracking and analytics.
@@ -137,31 +62,6 @@ declare module 'openai/resources/embeddings' {
          *
          * All fields are optional to maintain backward compatibility and provide maximum flexibility.
          *
-         * @since 1.0.0
-         * @example Document indexing workflow
-         * ```typescript
-         * usageMetadata: {
-         *   subscriber: {
-         *     id: 'user-123',
-         *     email: 'user@my-company.com'
-         *   },
-         *   organizationId: 'my-company',
-         *   productId: 'vector-search',
-         *   taskType: 'document-indexing'
-         * }
-         * ```
-         *
-         * @example Semantic search application
-         * ```typescript
-         * usageMetadata: {
-         *   subscriber: { id: 'user-456' },
-         *   organizationId: 'enterprise-corp',
-         *   productId: 'knowledge-base',
-         *   taskType: 'semantic-search',
-         *   traceId: 'search-session-789'
-         * }
-         * ```
-         *
          * @see {@link UsageMetadata} for detailed field descriptions
          */
         usageMetadata?: UsageMetadata;
@@ -173,7 +73,7 @@ declare module 'openai/resources/embeddings' {
  * Extends the new Responses API to support usageMetadata for comprehensive tracking.
  * The Responses API is OpenAI's new unified interface for agent-like applications.
  */
-declare module 'openai' {
+declare module "openai" {
     namespace Responses {
         interface ResponseCreateParams {
             /**
@@ -182,40 +82,6 @@ declare module 'openai' {
              * Enables comprehensive tracking and analytics for Responses API calls.
              * All fields are optional and can be customized based on your application needs.
              *
-             * @example Basic Responses API usage with metadata
-             * ```typescript
-             * const response = await openai.responses.create({
-             *   model: 'gpt-4.1',
-             *   input: 'Analyze this data and provide insights',
-             *   usageMetadata: {
-             *     subscriber: {
-             *       id: 'analyst-123',
-             *       email: 'analyst@company.com'
-             *     },
-             *     organizationId: 'data-corp',
-             *     productId: 'analytics-platform',
-             *     taskType: 'data-analysis',
-             *     agent: 'responses-api-v1'
-             *   }
-             * });
-             * ```
-             *
-             * @example Streaming Responses API with metadata
-             * ```typescript
-             * const stream = await openai.responses.create({
-             *   model: 'gpt-4.1',
-             *   input: [
-             *     { role: 'user', content: 'Generate a detailed report' }
-             *   ],
-             *   stream: true,
-             *   usageMetadata: {
-             *     subscriber: { id: 'user-456' },
-             *     taskType: 'report-generation',
-             *     traceId: 'session-789'
-             *   }
-             * });
-             * ```
-             *
              * @see {@link UsageMetadata} for detailed field descriptions
              */
             usageMetadata?: UsageMetadata;

package/dist/types/types/openai-augmentation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openai-augmentation.d.ts","sourceRoot":"","sources":["../../../src/types/openai-augmentation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAAE,CAAC;AAEV;;;;;GAKG;AACH,OAAO,QAAQ,+CAA+C,CAAC;IAC7D,UAAU,8BAA8B;QACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAkCG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,UAAU,sCAAsC;QAC9C;;;;;;;WAOG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,UAAU,mCAAmC;QAC3C;;;;;;;WAOG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;CACF;AAED;;;;;GAKG;AACH,OAAO,QAAQ,6BAA6B,CAAC;IAC3C,UAAU,qBAAqB;QAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmCG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;CACF;AAED;;;;;GAKG;AACH,OAAO,QAAQ,QAAQ,CAAC;IACtB,UAAU,SAAS,CAAC;QAClB,UAAU,oBAAoB;YAC5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAyCG;YACH,aAAa,CAAC,EAAE,aAAa,CAAC;SAC/B;KACF;CACF"}
+{"version":3,"file":"openai-augmentation.d.ts","sourceRoot":"","sources":["../../../src/types/openai-augmentation.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAAE,CAAC;AAEV;;;;;GAKG;AACH,OAAO,QAAQ,+CAA+C,CAAC;IAC7D,UAAU,8BAA8B;QACtC;;;;;;;;WAQG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,UAAU,sCAAsC;QAC9C;;;;;;;WAOG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;IAED,UAAU,mCAAmC;QAC3C;;;;;;;WAOG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;CACF;AAED;;;;;GAKG;AACH,OAAO,QAAQ,6BAA6B,CAAC;IAC3C,UAAU,qBAAqB;QAC7B;;;;;;;;;;WAUG;QACH,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B;CACF;AAED;;;;;GAKG;AACH,OAAO,QAAQ,QAAQ,CAAC;IACtB,UAAU,SAAS,CAAC;QAClB,UAAU,oBAAoB;YAC5B;;;;;;;eAOG;YACH,aAAa,CAAC,EAAE,aAAa,CAAC;SAC/B;KACF;CACF"}