@usagetap/sdk 1.2.0 → 1.3.2

package/dist/{client-EMXt9_fA.d.cts → client-BD8O2J8Z.d.cts}

@@ -310,8 +310,14 @@ interface UsageTapLogEntry {
     error?: unknown;
 }
 interface UsageTapClientOptions {
-    apiKey: string;
-    baseUrl: string;
+    /**
+     * UsageTap API key. Defaults to the server-side USAGETAP_API_KEY environment variable.
+     */
+    apiKey?: string;
+    /**
+     * UsageTap API base URL. Defaults to USAGETAP_BASE_URL, then https://api.usagetap.com.
+     */
+    baseUrl?: string;
     defaultFeature?: string;
     defaultTags?: string[];
     fetchImpl?: typeof fetch;
@@ -587,6 +593,14 @@ declare function compressPromptToon<TInput = unknown>(input: TInput): PromptComp
 declare function compressPromptMessages<TInput = unknown>(options: PromptCompressionMessagesInput<TInput>): Promise<PromptCompressionResult<TInput>>;
 declare function estimatePromptTokens(input: unknown): number;
 
+type UsageTapCompressOptions = Omit<PromptCompressionStandaloneOptions, "provider">;
+type UsageTapCompressResult = Omit<PromptCompressionResult<string>, "compressedInput"> & {
+    /** The compressed text, ready to pass to an LLM. */
+    output: string;
+    /** Alias retained for consistency with the lower-level compression APIs. */
+    compressedInput: string;
+};
+type MeterRequest = string | BeginCallRequest;
 declare class UsageTapClient {
     private readonly apiKey;
     private readonly baseUrl;
@@ -612,12 +626,19 @@ declare class UsageTapClient {
     private readonly usageTapCompressionMessagesEndpoint?;
     private readonly usageTapCompressionModel?;
     private readonly usageTapCompressionAggressiveness?;
-    constructor(options: UsageTapClientOptions);
+    constructor(options?: UsageTapClientOptions);
     beginCall(request: BeginCallRequest, options?: BeginCallOptions): Promise<UsageTapSuccessResponse<BeginCallResponseBody>>;
     promptCompress(request: PromptCompressionRequest, options?: PromptCompressionOptions): Promise<PromptCompressionResult & {
         callId: string;
     }>;
     compressPromptInput<TInput = unknown>(input: TInput, options?: PromptCompressionStandaloneOptions): Promise<PromptCompressionResult<TInput>>;
+    /**
+     * Compress text with UsageTap's hosted compression service.
+     *
+     * This is the short, standalone path. It does not create a metered call and
+     * fails open to the original text unless failOpen is explicitly disabled.
+     */
+    compress(text: string, options?: UsageTapCompressOptions): Promise<UsageTapCompressResult>;
     compressPromptMessages<TInput = unknown>(input: TInput, options?: PromptCompressionMessagesOptions): Promise<PromptCompressionResult<TInput>>;
     recordPromptCompression(request: RecordPromptCompressionRequest, options?: PromptCompressionOptions): Promise<UsageTapSuccessResponse<PromptCompressionResponseBody>>;
     endCall(request: EndCallRequest, options?: EndCallOptions): Promise<UsageTapSuccessResponse<EndCallResponseBody>>;
@@ -626,6 +647,11 @@ declare class UsageTapClient {
     changePlan(request: ChangePlanRequest, options?: ChangePlanOptions): Promise<UsageTapSuccessResponse<ChangePlanResponseBody>>;
     incrementCustomMeter(request: IncrementCustomMeterRequest, options?: IncrementCustomMeterOptions): Promise<UsageTapSuccessResponse<IncrementCustomMeterResponseBody>>;
     withUsage<T>(beginRequest: BeginCallRequest, handler: (context: WithUsageContext) => Promise<T>, options?: WithUsageOptions): Promise<T>;
+    /**
+     * Meter one operation. Pass only a customer ID for the common path, or the
+     * existing begin-call request object when feature, tags, or entitlements are needed.
+     */
+    meter<T>(request: MeterRequest, handler: (context: WithUsageContext) => Promise<T>, options?: WithUsageOptions): Promise<T>;
     private toPromptCompressionTelemetry;
     private request;
     private requestGet;
@@ -639,4 +665,4 @@ declare class UsageTapClient {
     private toApiError;
 }
 
-export { type MeteredUsage as $, type CheckUsageResponseBody as A, type BeginCallRequest as B, type CreateCustomerOptions as C, type ChangePlanOptions as D, type EndCallRequest as E, type ChangePlanRequest as F, type ChangePlanResponseBody as G, type ChangePlanStrategy as H, type IncrementCustomMeterOptions as I, type IncrementCustomMeterRequest as J, type IncrementCustomMeterResponseBody as K, type CustomMeterSlot as L, type EndCallOptions as M, type EndCallResponseBody as N, type BalanceSummary as O, type PromptCompressionProvider as P, type SpendVelocityWindow as Q, type RecordPromptCompressionRequest as R, type SpendVelocitySnapshot as S, type SpendVelocityWindowKey as T, UsageTapClient as U, type VendorHints as V, type WithUsageOptions as W, type EntitlementHints as X, type PlanSummary as Y, type MeterSummary as Z, type MeterSnapshot as _, type PromptCompressionTelemetry as a, type RateLimitsSnapshot as a0, type RemainingRatios as a1, type RollingCallsRateLimitState as a2, type RequestedEntitlements as a3, type AllowedEntitlements as a4, type RetryOptions as a5, type UsageTapClientOptions as a6, type UsageTapErrorResponse as a7, type UsageTapResultEnvelope as a8, type UsageTapResultStatus as a9, type UsageTapLogEntry as aa, type WithUsageContext as ab, type LimitType as ac, type SubscriptionSnapshot as ad, type ModelHints as ae, type IdempotencyMetadata as af, type UsageMetricEvent as ag, type UsageTapSuccessResponse as b, type BeginCallResponseBody as c, compressPrompt as d, compressPromptMessages as e, compressPromptHeuristic as f, compressPromptToon as g, estimatePromptTokens as h, protectPromptText as i, type PromptCompressionInput as j, type PromptCompressionMessagesAggressiveness as k, type PromptCompressionMessagesInput as l, type PromptCompressionMessageRole as m, type PromptCompressionResult as n, type PromptCompressionRoleAggressiveness as o, protect as p, type BeginCallOptions as q, type PromptCompressionRequest as r, type PromptCompressionOptions as s, type PromptCompressionMessagesOptions as t, type PromptCompressionResponseBody as u, type PromptCompressionStandaloneOptions as v, type CreateCustomerRequest as w, type CreateCustomerResponseBody as x, type CheckUsageOptions as y, type CheckUsageRequest as z };
+export { type PlanSummary as $, type CheckUsageOptions as A, type BeginCallRequest as B, type CreateCustomerOptions as C, type CheckUsageRequest as D, type EndCallRequest as E, type CheckUsageResponseBody as F, type ChangePlanOptions as G, type ChangePlanRequest as H, type ChangePlanResponseBody as I, type ChangePlanStrategy as J, type IncrementCustomMeterOptions as K, type IncrementCustomMeterRequest as L, type MeterRequest as M, type IncrementCustomMeterResponseBody as N, type CustomMeterSlot as O, type PromptCompressionProvider as P, type EndCallOptions as Q, type RecordPromptCompressionRequest as R, type EndCallResponseBody as S, type BalanceSummary as T, UsageTapClient as U, type VendorHints as V, type WithUsageOptions as W, type SpendVelocitySnapshot as X, type SpendVelocityWindow as Y, type SpendVelocityWindowKey as Z, type EntitlementHints as _, type PromptCompressionTelemetry as a, type MeterSummary as a0, type MeterSnapshot as a1, type MeteredUsage as a2, type RateLimitsSnapshot as a3, type RemainingRatios as a4, type RollingCallsRateLimitState as a5, type RequestedEntitlements as a6, type AllowedEntitlements as a7, type RetryOptions as a8, type UsageTapClientOptions as a9, type UsageTapErrorResponse as aa, type UsageTapResultEnvelope as ab, type UsageTapResultStatus as ac, type UsageTapLogEntry as ad, type WithUsageContext as ae, type LimitType as af, type SubscriptionSnapshot as ag, type ModelHints as ah, type IdempotencyMetadata as ai, type UsageMetricEvent as aj, type UsageTapSuccessResponse as b, type BeginCallResponseBody as c, type UsageTapCompressOptions as d, type UsageTapCompressResult as e, compressPrompt as f, compressPromptMessages as g, compressPromptHeuristic as h, compressPromptToon as i, estimatePromptTokens as j, protectPromptText as k, type PromptCompressionInput as l, type PromptCompressionMessagesAggressiveness as m, type PromptCompressionMessagesInput as n, type PromptCompressionMessageRole as o, protect as p, type PromptCompressionResult as q, type PromptCompressionRoleAggressiveness as r, type BeginCallOptions as s, type PromptCompressionRequest as t, type PromptCompressionOptions as u, type PromptCompressionMessagesOptions as v, type PromptCompressionResponseBody as w, type PromptCompressionStandaloneOptions as x, type CreateCustomerRequest as y, type CreateCustomerResponseBody as z };

package/dist/{client-EMXt9_fA.d.ts → client-BD8O2J8Z.d.ts}

@@ -310,8 +310,14 @@ interface UsageTapLogEntry {
     error?: unknown;
 }
 interface UsageTapClientOptions {
-    apiKey: string;
-    baseUrl: string;
+    /**
+     * UsageTap API key. Defaults to the server-side USAGETAP_API_KEY environment variable.
+     */
+    apiKey?: string;
+    /**
+     * UsageTap API base URL. Defaults to USAGETAP_BASE_URL, then https://api.usagetap.com.
+     */
+    baseUrl?: string;
     defaultFeature?: string;
     defaultTags?: string[];
     fetchImpl?: typeof fetch;
@@ -587,6 +593,14 @@ declare function compressPromptToon<TInput = unknown>(input: TInput): PromptComp
 declare function compressPromptMessages<TInput = unknown>(options: PromptCompressionMessagesInput<TInput>): Promise<PromptCompressionResult<TInput>>;
 declare function estimatePromptTokens(input: unknown): number;
 
+type UsageTapCompressOptions = Omit<PromptCompressionStandaloneOptions, "provider">;
+type UsageTapCompressResult = Omit<PromptCompressionResult<string>, "compressedInput"> & {
+    /** The compressed text, ready to pass to an LLM. */
+    output: string;
+    /** Alias retained for consistency with the lower-level compression APIs. */
+    compressedInput: string;
+};
+type MeterRequest = string | BeginCallRequest;
 declare class UsageTapClient {
     private readonly apiKey;
     private readonly baseUrl;
@@ -612,12 +626,19 @@ declare class UsageTapClient {
     private readonly usageTapCompressionMessagesEndpoint?;
     private readonly usageTapCompressionModel?;
     private readonly usageTapCompressionAggressiveness?;
-    constructor(options: UsageTapClientOptions);
+    constructor(options?: UsageTapClientOptions);
     beginCall(request: BeginCallRequest, options?: BeginCallOptions): Promise<UsageTapSuccessResponse<BeginCallResponseBody>>;
     promptCompress(request: PromptCompressionRequest, options?: PromptCompressionOptions): Promise<PromptCompressionResult & {
         callId: string;
     }>;
     compressPromptInput<TInput = unknown>(input: TInput, options?: PromptCompressionStandaloneOptions): Promise<PromptCompressionResult<TInput>>;
+    /**
+     * Compress text with UsageTap's hosted compression service.
+     *
+     * This is the short, standalone path. It does not create a metered call and
+     * fails open to the original text unless failOpen is explicitly disabled.
+     */
+    compress(text: string, options?: UsageTapCompressOptions): Promise<UsageTapCompressResult>;
     compressPromptMessages<TInput = unknown>(input: TInput, options?: PromptCompressionMessagesOptions): Promise<PromptCompressionResult<TInput>>;
     recordPromptCompression(request: RecordPromptCompressionRequest, options?: PromptCompressionOptions): Promise<UsageTapSuccessResponse<PromptCompressionResponseBody>>;
     endCall(request: EndCallRequest, options?: EndCallOptions): Promise<UsageTapSuccessResponse<EndCallResponseBody>>;
@@ -626,6 +647,11 @@ declare class UsageTapClient {
     changePlan(request: ChangePlanRequest, options?: ChangePlanOptions): Promise<UsageTapSuccessResponse<ChangePlanResponseBody>>;
     incrementCustomMeter(request: IncrementCustomMeterRequest, options?: IncrementCustomMeterOptions): Promise<UsageTapSuccessResponse<IncrementCustomMeterResponseBody>>;
     withUsage<T>(beginRequest: BeginCallRequest, handler: (context: WithUsageContext) => Promise<T>, options?: WithUsageOptions): Promise<T>;
+    /**
+     * Meter one operation. Pass only a customer ID for the common path, or the
+     * existing begin-call request object when feature, tags, or entitlements are needed.
+     */
+    meter<T>(request: MeterRequest, handler: (context: WithUsageContext) => Promise<T>, options?: WithUsageOptions): Promise<T>;
     private toPromptCompressionTelemetry;
     private request;
     private requestGet;
@@ -639,4 +665,4 @@ declare class UsageTapClient {
     private toApiError;
 }
 
-export { type MeteredUsage as $, type CheckUsageResponseBody as A, type BeginCallRequest as B, type CreateCustomerOptions as C, type ChangePlanOptions as D, type EndCallRequest as E, type ChangePlanRequest as F, type ChangePlanResponseBody as G, type ChangePlanStrategy as H, type IncrementCustomMeterOptions as I, type IncrementCustomMeterRequest as J, type IncrementCustomMeterResponseBody as K, type CustomMeterSlot as L, type EndCallOptions as M, type EndCallResponseBody as N, type BalanceSummary as O, type PromptCompressionProvider as P, type SpendVelocityWindow as Q, type RecordPromptCompressionRequest as R, type SpendVelocitySnapshot as S, type SpendVelocityWindowKey as T, UsageTapClient as U, type VendorHints as V, type WithUsageOptions as W, type EntitlementHints as X, type PlanSummary as Y, type MeterSummary as Z, type MeterSnapshot as _, type PromptCompressionTelemetry as a, type RateLimitsSnapshot as a0, type RemainingRatios as a1, type RollingCallsRateLimitState as a2, type RequestedEntitlements as a3, type AllowedEntitlements as a4, type RetryOptions as a5, type UsageTapClientOptions as a6, type UsageTapErrorResponse as a7, type UsageTapResultEnvelope as a8, type UsageTapResultStatus as a9, type UsageTapLogEntry as aa, type WithUsageContext as ab, type LimitType as ac, type SubscriptionSnapshot as ad, type ModelHints as ae, type IdempotencyMetadata as af, type UsageMetricEvent as ag, type UsageTapSuccessResponse as b, type BeginCallResponseBody as c, compressPrompt as d, compressPromptMessages as e, compressPromptHeuristic as f, compressPromptToon as g, estimatePromptTokens as h, protectPromptText as i, type PromptCompressionInput as j, type PromptCompressionMessagesAggressiveness as k, type PromptCompressionMessagesInput as l, type PromptCompressionMessageRole as m, type PromptCompressionResult as n, type PromptCompressionRoleAggressiveness as o, protect as p, type BeginCallOptions as q, type PromptCompressionRequest as r, type PromptCompressionOptions as s, type PromptCompressionMessagesOptions as t, type PromptCompressionResponseBody as u, type PromptCompressionStandaloneOptions as v, type CreateCustomerRequest as w, type CreateCustomerResponseBody as x, type CheckUsageOptions as y, type CheckUsageRequest as z };
+export { type PlanSummary as $, type CheckUsageOptions as A, type BeginCallRequest as B, type CreateCustomerOptions as C, type CheckUsageRequest as D, type EndCallRequest as E, type CheckUsageResponseBody as F, type ChangePlanOptions as G, type ChangePlanRequest as H, type ChangePlanResponseBody as I, type ChangePlanStrategy as J, type IncrementCustomMeterOptions as K, type IncrementCustomMeterRequest as L, type MeterRequest as M, type IncrementCustomMeterResponseBody as N, type CustomMeterSlot as O, type PromptCompressionProvider as P, type EndCallOptions as Q, type RecordPromptCompressionRequest as R, type EndCallResponseBody as S, type BalanceSummary as T, UsageTapClient as U, type VendorHints as V, type WithUsageOptions as W, type SpendVelocitySnapshot as X, type SpendVelocityWindow as Y, type SpendVelocityWindowKey as Z, type EntitlementHints as _, type PromptCompressionTelemetry as a, type MeterSummary as a0, type MeterSnapshot as a1, type MeteredUsage as a2, type RateLimitsSnapshot as a3, type RemainingRatios as a4, type RollingCallsRateLimitState as a5, type RequestedEntitlements as a6, type AllowedEntitlements as a7, type RetryOptions as a8, type UsageTapClientOptions as a9, type UsageTapErrorResponse as aa, type UsageTapResultEnvelope as ab, type UsageTapResultStatus as ac, type UsageTapLogEntry as ad, type WithUsageContext as ae, type LimitType as af, type SubscriptionSnapshot as ag, type ModelHints as ah, type IdempotencyMetadata as ai, type UsageMetricEvent as aj, type UsageTapSuccessResponse as b, type BeginCallResponseBody as c, type UsageTapCompressOptions as d, type UsageTapCompressResult as e, compressPrompt as f, compressPromptMessages as g, compressPromptHeuristic as h, compressPromptToon as i, estimatePromptTokens as j, protectPromptText as k, type PromptCompressionInput as l, type PromptCompressionMessagesAggressiveness as m, type PromptCompressionMessagesInput as n, type PromptCompressionMessageRole as o, protect as p, type PromptCompressionResult as q, type PromptCompressionRoleAggressiveness as r, type BeginCallOptions as s, type PromptCompressionRequest as t, type PromptCompressionOptions as u, type PromptCompressionMessagesOptions as v, type PromptCompressionResponseBody as w, type PromptCompressionStandaloneOptions as x, type CreateCustomerRequest as y, type CreateCustomerResponseBody as z };

package/dist/express/index.cjs

@@ -495,6 +495,12 @@ async function compressChatParams(params, usageTap, compression, signal) {
   if (!messages) {
     return { params, segments: [] };
   }
+  if (isBelowMinContextTokens(
+    { messages, tools: source.tools },
+    compression.minContextTokens
+  )) {
+    return { params, segments: [] };
+  }
   if (shouldUseUsageTapMessageEndpoint(compression)) {
     const result = await usageTap.compressPromptMessages(source, {
       provider: "usagetap",
@@ -526,6 +532,16 @@ async function compressResponsesParams(params, usageTap, compression, signal) {
   }
   const source = cloneRecord(params);
   const segments = [];
+  if (isBelowMinContextTokens(
+    {
+      instructions: source.instructions,
+      input: source.input,
+      tools: source.tools
+    },
+    compression.minContextTokens
+  )) {
+    return { params, segments };
+  }
   if (typeof source.instructions === "string") {
     const compressed = await compressTextForRole(
       source.instructions,
@@ -755,6 +771,9 @@ function normalizePromptCompressionOptions(options) {
   }
   return options;
 }
+function isBelowMinContextTokens(context, minContextTokens) {
+  return typeof minContextTokens === "number" && estimatePromptTokens(context) < Math.max(0, minContextTokens);
+}
 function resolveEffectivePromptCompressionOptions(defaults, override) {
   if (override === false) {
     return void 0;