@usagetap/sdk 1.1.0 → 1.3.1

package/dist/adapters/openai.d.cts

@@ -1,5 +1,5 @@
 import OpenAI from 'openai';
-import { B as BeginCallRequest, P as PromptCompressionProvider, U as UsageTapClient, W as WithUsageOptions, a as PromptCompressionTelemetry, V as VendorHints, b as UsageTapSuccessResponse, c as BeginCallResponseBody, E as EndCallRequest } from '../client-BA-QlnRq.cjs';
+import { B as BeginCallRequest, P as PromptCompressionProvider, U as UsageTapClient, W as WithUsageOptions, a as PromptCompressionTelemetry, V as VendorHints, b as UsageTapSuccessResponse, c as BeginCallResponseBody, E as EndCallRequest } from '../client-BD8O2J8Z.cjs';
 
 interface OpenAIAdapterInit {
     client: OpenAI;
@@ -46,18 +46,33 @@ interface OpenAIPromptCompressionRoleOptions {
     enabled?: boolean;
     provider?: PromptCompressionProvider;
     minTokens?: number;
+    aggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
     tokenCompanyAggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number;
 }
 type OpenAIPromptCompressionRoleSetting = boolean | OpenAIPromptCompressionRoleOptions;
 interface OpenAIPromptCompressionOptions {
     enabled?: boolean;
     provider?: PromptCompressionProvider;
     roles?: Partial<Record<OpenAIPromptCompressionRole, OpenAIPromptCompressionRoleSetting>>;
+    /**
+     * Skip compression when the combined request context is estimated below this
+     * many tokens. `withCompression` defaults to 1,000; set to 0 to always try.
+     */
+    minContextTokens?: number;
+    /** Minimum estimated tokens for each individual text segment. */
     minTokens?: number;
     failOpen?: boolean;
     tokenCompanyModel?: string;
+    aggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+    /** @deprecated Use aggressiveness instead. */
     tokenCompanyAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
     tokenCompanyAppId?: string;
+    usageTapCompressionModel?: string;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
 }
 interface OpenAIPromptCompressionTurnStats extends PromptCompressionTelemetry {
     callId: string;
@@ -94,6 +109,24 @@ interface WrapOpenAIOptions {
     applyVendorHints?: boolean;
     promptCompression?: boolean | OpenAIPromptCompressionOptions;
 }
+interface OpenAICompressionOptions extends OpenAIPromptCompressionOptions {
+    /** UsageTap API key. Defaults to USAGETAP_API_KEY. */
+    apiKey?: string;
+    /** Reuse an existing client when custom transport or endpoints are configured. */
+    usageTapClient?: UsageTapClient;
+}
+type CompressionWrappedOpenAI = OpenAI & {
+    /** Return the original, unwrapped OpenAI-compatible client. */
+    unwrap: () => OpenAI;
+};
+type WithMeteringOpenAIOptions = BeginCallRequest & {
+    /** UsageTap API key. Defaults to USAGETAP_API_KEY. */
+    apiKey?: string;
+    /** Reuse an existing client when custom transport or endpoints are configured. */
+    usageTapClient?: UsageTapClient;
+    applyVendorHints?: boolean;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
+};
 type ChatCompletionsResource = OpenAI["chat"]["completions"];
 type ChatCompletionCreate = ChatCompletionsResource["create"];
 type ChatCompletionCreateParams = Parameters<ChatCompletionCreate>[0];
@@ -175,6 +208,17 @@ type UsageTapStream<T> = AsyncIterable<T> & {
 };
 declare function toNextResponse<T>(stream: UsageTapStream<T>, options?: StreamToResponseOptions): Response;
 declare function pipeToResponse<T>(stream: UsageTapStream<T>, res: NodeResponseLike, options?: StreamToResponseOptions): Promise<void>;
+/**
+ * Add hosted prompt compression to an OpenAI-compatible client without
+ * changing any of its call sites. Works with OpenAI and OpenRouter clients.
+ */
+declare function withCompression(client: OpenAI, options?: OpenAICompressionOptions): CompressionWrappedOpenAI;
+/**
+ * Add UsageTap metering to an OpenAI-compatible client. The string form is the
+ * shortest path; pass an object when feature, tags, entitlements, or compression
+ * are also needed.
+ */
+declare function withMetering(client: OpenAI, customer: string | WithMeteringOpenAIOptions): WrappedOpenAI;
 declare function wrapOpenAI(client: OpenAI, usageTap: UsageTapClient, options?: WrapOpenAIOptions): WrappedOpenAI;
 declare function streamOpenAIRoute(usageTap: UsageTapClient, openai: OpenAI, options: StreamOpenAIRouteOptions): (req: Request) => Promise<Response>;
 interface NodeResponseLike {
@@ -187,4 +231,4 @@ interface NodeResponseLike {
     flush?(): void;
 }
 
-export { type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIPromptCompressionFailure, type OpenAIPromptCompressionOptions, type OpenAIPromptCompressionRole, type OpenAIPromptCompressionRoleOptions, type OpenAIPromptCompressionRoleSetting, OpenAIPromptCompressionStats, type OpenAIPromptCompressionTurnStats, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, wrapOpenAI };
+export { type CompressionWrappedOpenAI, type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAICompressionOptions, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIPromptCompressionFailure, type OpenAIPromptCompressionOptions, type OpenAIPromptCompressionRole, type OpenAIPromptCompressionRoleOptions, type OpenAIPromptCompressionRoleSetting, OpenAIPromptCompressionStats, type OpenAIPromptCompressionTurnStats, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WithMeteringOpenAIOptions, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, withCompression, withMetering, wrapOpenAI };

package/dist/adapters/openai.d.ts

@@ -1,5 +1,5 @@
 import OpenAI from 'openai';
-import { B as BeginCallRequest, P as PromptCompressionProvider, U as UsageTapClient, W as WithUsageOptions, a as PromptCompressionTelemetry, V as VendorHints, b as UsageTapSuccessResponse, c as BeginCallResponseBody, E as EndCallRequest } from '../client-BA-QlnRq.js';
+import { B as BeginCallRequest, P as PromptCompressionProvider, U as UsageTapClient, W as WithUsageOptions, a as PromptCompressionTelemetry, V as VendorHints, b as UsageTapSuccessResponse, c as BeginCallResponseBody, E as EndCallRequest } from '../client-BD8O2J8Z.js';
 
 interface OpenAIAdapterInit {
     client: OpenAI;
@@ -46,18 +46,33 @@ interface OpenAIPromptCompressionRoleOptions {
     enabled?: boolean;
     provider?: PromptCompressionProvider;
     minTokens?: number;
+    aggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
     tokenCompanyAggressiveness?: number;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number;
 }
 type OpenAIPromptCompressionRoleSetting = boolean | OpenAIPromptCompressionRoleOptions;
 interface OpenAIPromptCompressionOptions {
     enabled?: boolean;
     provider?: PromptCompressionProvider;
     roles?: Partial<Record<OpenAIPromptCompressionRole, OpenAIPromptCompressionRoleSetting>>;
+    /**
+     * Skip compression when the combined request context is estimated below this
+     * many tokens. `withCompression` defaults to 1,000; set to 0 to always try.
+     */
+    minContextTokens?: number;
+    /** Minimum estimated tokens for each individual text segment. */
     minTokens?: number;
     failOpen?: boolean;
     tokenCompanyModel?: string;
+    aggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
+    /** @deprecated Use aggressiveness instead. */
     tokenCompanyAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
     tokenCompanyAppId?: string;
+    usageTapCompressionModel?: string;
+    /** @deprecated Use aggressiveness instead. */
+    usageTapCompressionAggressiveness?: number | Partial<Record<OpenAIPromptCompressionRole, number>>;
 }
 interface OpenAIPromptCompressionTurnStats extends PromptCompressionTelemetry {
     callId: string;
@@ -94,6 +109,24 @@ interface WrapOpenAIOptions {
     applyVendorHints?: boolean;
     promptCompression?: boolean | OpenAIPromptCompressionOptions;
 }
+interface OpenAICompressionOptions extends OpenAIPromptCompressionOptions {
+    /** UsageTap API key. Defaults to USAGETAP_API_KEY. */
+    apiKey?: string;
+    /** Reuse an existing client when custom transport or endpoints are configured. */
+    usageTapClient?: UsageTapClient;
+}
+type CompressionWrappedOpenAI = OpenAI & {
+    /** Return the original, unwrapped OpenAI-compatible client. */
+    unwrap: () => OpenAI;
+};
+type WithMeteringOpenAIOptions = BeginCallRequest & {
+    /** UsageTap API key. Defaults to USAGETAP_API_KEY. */
+    apiKey?: string;
+    /** Reuse an existing client when custom transport or endpoints are configured. */
+    usageTapClient?: UsageTapClient;
+    applyVendorHints?: boolean;
+    promptCompression?: boolean | OpenAIPromptCompressionOptions;
+};
 type ChatCompletionsResource = OpenAI["chat"]["completions"];
 type ChatCompletionCreate = ChatCompletionsResource["create"];
 type ChatCompletionCreateParams = Parameters<ChatCompletionCreate>[0];
@@ -175,6 +208,17 @@ type UsageTapStream<T> = AsyncIterable<T> & {
 };
 declare function toNextResponse<T>(stream: UsageTapStream<T>, options?: StreamToResponseOptions): Response;
 declare function pipeToResponse<T>(stream: UsageTapStream<T>, res: NodeResponseLike, options?: StreamToResponseOptions): Promise<void>;
+/**
+ * Add hosted prompt compression to an OpenAI-compatible client without
+ * changing any of its call sites. Works with OpenAI and OpenRouter clients.
+ */
+declare function withCompression(client: OpenAI, options?: OpenAICompressionOptions): CompressionWrappedOpenAI;
+/**
+ * Add UsageTap metering to an OpenAI-compatible client. The string form is the
+ * shortest path; pass an object when feature, tags, entitlements, or compression
+ * are also needed.
+ */
+declare function withMetering(client: OpenAI, customer: string | WithMeteringOpenAIOptions): WrappedOpenAI;
 declare function wrapOpenAI(client: OpenAI, usageTap: UsageTapClient, options?: WrapOpenAIOptions): WrappedOpenAI;
 declare function streamOpenAIRoute(usageTap: UsageTapClient, openai: OpenAI, options: StreamOpenAIRouteOptions): (req: Request) => Promise<Response>;
 interface NodeResponseLike {
@@ -187,4 +231,4 @@ interface NodeResponseLike {
     flush?(): void;
 }
 
-export { type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIPromptCompressionFailure, type OpenAIPromptCompressionOptions, type OpenAIPromptCompressionRole, type OpenAIPromptCompressionRoleOptions, type OpenAIPromptCompressionRoleSetting, OpenAIPromptCompressionStats, type OpenAIPromptCompressionTurnStats, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, wrapOpenAI };
+export { type CompressionWrappedOpenAI, type NodeResponseLike, type OpenAIAdapter, type OpenAIAdapterInit, type OpenAICompressionOptions, type OpenAIInvokeParams, type OpenAIInvokeResult, type OpenAIPromptCompressionFailure, type OpenAIPromptCompressionOptions, type OpenAIPromptCompressionRole, type OpenAIPromptCompressionRoleOptions, type OpenAIPromptCompressionRoleSetting, OpenAIPromptCompressionStats, type OpenAIPromptCompressionTurnStats, type OpenAIRequestContext, type OpenAIStreamCallResult, type OpenAIStreamParams, type OpenAIStreamResult, type StreamMode, type StreamOpenAIRouteOptions, type StreamToResponseOptions, type UsageTapStream, type WithMeteringOpenAIOptions, type WrapOpenAICallOptions, type WrapOpenAIContext, type WrapOpenAIOptions, type WrapOpenAIResponseCallOptions, type WrappedOpenAI, createOpenAIAdapter, pipeToResponse, streamOpenAIRoute, toNextResponse, withCompression, withMetering, wrapOpenAI };