@nodetool-ai/runtime 0.7.0-rc.23 → 0.8.1

package/dist/providers/cost-calculator.d.ts

@@ -1,20 +1,21 @@
 /**
- * Centralized cost calculation for all AI providers.
+ * Centralized cost calculation for all AI providers — in real US dollars.
  *
- * This module provides a unified interface for calculating API costs in credits.
- * 1 credit = $0.01 USD (i.e., 1000 credits = $10 USD)
- * All rates include a 50% premium over provider base costs.
+ * Token and embedding pricing comes from `@pydantic/genai-prices` (the bundled,
+ * community-maintained price catalog), so chat/LLM costs track each provider's
+ * published per-token rates exactly, including prompt-cache discounts and
+ * tiered (context-length) pricing. No markup is applied.
+ *
+ * A small local table covers the modalities genai-prices does not price per
+ * token — image generation (per image), speech-to-text (per minute),
+ * text-to-speech (per 1k characters) and 3D generation (per task). Those values
+ * are the providers' list prices in USD.
  *
  * Usage:
  *    import { CostCalculator, UsageInfo } from "./cost-calculator.js";
- *
- *    // Calculate cost for a chat completion
- *    const usage: UsageInfo = { inputTokens: 1000, outputTokens: 500 };
- *    const cost = CostCalculator.calculate("gpt-4o-mini", usage, "openai");
- *
- *    // Or use convenience helper functions
- *    const cost2 = calculateChatCost("gpt-4o-mini", 1000, 500);
+ *    const cost = CostCalculator.calculate("gpt-4o-mini", { inputTokens: 1000, outputTokens: 500 }, "openai");
  */
+import { type ProviderId } from "@nodetool-ai/protocol";
 export declare enum CostType {
     TOKEN_BASED = "token_based",
     EMBEDDING = "embedding",
@@ -27,83 +28,101 @@ export declare enum CostType {
 }
 export interface PricingTier {
     costType: CostType;
-    inputPer1kTokens?: number;
-    outputPer1kTokens?: number;
-    cachedPer1kTokens?: number;
+    /** USD per 1000 characters (CostType.CHARACTER_BASED). */
     per1kChars?: number;
+    /** USD per minute of audio (CostType.DURATION_BASED). */
     perMinute?: number;
+    /** USD per generated image (CostType.IMAGE_BASED). */
     perImage?: number;
+    /** USD per second of video (CostType.VIDEO_BASED). */
     perSecondVideo?: number;
-    /** Cost per submitted task (CostType.TASK_BASED). In nodetool credits (1 credit = $0.01). */
+    /** USD per submitted task (CostType.TASK_BASED). */
     perTask?: number;
 }
 /**
- * Pricing tiers by tier name - derived from Python cost_calculator.py PRICING_TIERS.
+ * Local pricing for non-token modalities, in USD (provider list prices).
+ * Token/embedding models are intentionally absent — those are priced via
+ * `@pydantic/genai-prices`.
  */
 export declare const PRICING_TIERS: Record<string, PricingTier>;
 /**
- * Model ID to tier mapping.
- * Keys are "provider:modelId" strings for provider-specific pricing.
+ * Model ID to tier mapping for the local (non-token) pricing table.
+ * Keys are "provider:modelId". Token/embedding models are priced via
+ * genai-prices and are deliberately not listed here.
  */
 export declare const MODEL_TO_TIER: Record<string, string>;
 export interface UsageInfo {
+    /**
+     * Total prompt/input tokens, **inclusive** of `cachedTokens` and
+     * `cacheWriteTokens`. This matches the `@pydantic/genai-prices` contract,
+     * which derives the full-price text input as
+     * `inputTokens - cachedTokens - cacheWriteTokens`. Providers whose API
+     * reports the uncached portion separately (e.g. Anthropic) must add the
+     * cache read/write counts back in before populating this field.
+     */
     inputTokens?: number;
     outputTokens?: number;
+    /** Text tokens supplied to an image model. */
+    inputTextTokens?: number;
+    /** Image tokens supplied to an image model. */
+    inputImageTokens?: number;
+    /** Image tokens generated by an image model. */
+    outputImageTokens?: number;
+    /** Cache-read (hit) tokens — a subset of {@link inputTokens}, priced at a discount. */
     cachedTokens?: number;
+    /** Cache-write (creation) tokens — a subset of {@link inputTokens}, priced at a premium. */
+    cacheWriteTokens?: number;
     reasoningTokens?: number;
     inputCharacters?: number;
     durationSeconds?: number;
     imageCount?: number;
+    /** Requested image quality (`low` | `medium` | `high`) for per-image pricing. */
+    imageQuality?: string;
     videoSeconds?: number;
     /** Number of tasks submitted (for CostType.TASK_BASED providers). */
     taskCount?: number;
 }
 export declare class CostCalculator {
     /**
-     * Get the pricing tier for a model ID scoped by provider.
-     *
-     * @param modelId - The model identifier
-     * @param provider - Provider name (e.g., "openai", "anthropic")
-     * @returns The pricing tier name, or null if not found
+     * Get the local (non-token) pricing tier for a model, scoped by provider.
+     * Token/embedding models are priced via genai-prices and return `null` here.
      */
-    static getTier(modelId: string, provider: string): string | null;
+    static getTier(modelId: string, provider: ProviderId): string | null;
     /**
-     * Calculate cost in credits for an API call.
+     * Calculate the cost of an API call in USD.
      *
      * @param modelId - The model identifier
      * @param usage - Usage information from the API response
      * @param provider - Provider name for pricing lookup
-     * @returns Cost in credits (1 credit = $0.01 USD)
+     * @returns Cost in US dollars (0 when no price is known)
      */
-    static calculate(modelId: string, usage: UsageInfo, provider: string): number;
+    static calculate(modelId: string, usage: UsageInfo, provider: ProviderId): number;
     /**
-     * Calculate cost based on tier type.
+     * Token cost in USD, or `null` when no price is known for the model.
+     *
+     * {@link calculate} answers 0 for an unpriced model because accounting must
+     * never break a generation that already ran. A budget decides whether a call
+     * happens *at all*, and there "unknown" must not read as "free" — so the
+     * missing-price case is a distinct answer here, and callers that reserve
+     * against a cap fail closed on it.
      */
+    static estimateTokenCostUsd(modelId: string, usage: UsageInfo, provider: ProviderId): number | null;
+    /** Cost for a local non-token modality tier, in USD. */
     private static _calculateForTier;
 }
+/** Calculate chat completion cost in USD. */
+export declare function calculateChatCost(modelId: string, inputTokens: number, outputTokens: number, cachedTokens?: number, provider?: ProviderId): number;
+/** Calculate embedding cost in USD. */
+export declare function calculateEmbeddingCost(modelId: string, inputTokens: number, provider?: ProviderId): number;
+/** Calculate TTS cost in USD. */
+export declare function calculateSpeechCost(modelId: string, inputChars: number, provider?: ProviderId): number;
+/** Calculate ASR/Whisper cost in USD. */
+export declare function calculateWhisperCost(modelId: string, durationSeconds: number, provider?: ProviderId): number;
 /**
- * Calculate chat completion cost.
- */
-export declare function calculateChatCost(modelId: string, inputTokens: number, outputTokens: number, cachedTokens?: number, provider?: string): number;
-/**
- * Calculate embedding cost.
- */
-export declare function calculateEmbeddingCost(modelId: string, inputTokens: number, provider?: string): number;
-/**
- * Calculate TTS cost.
- */
-export declare function calculateSpeechCost(modelId: string, inputChars: number, provider?: string): number;
-/**
- * Calculate ASR/Whisper cost.
- */
-export declare function calculateWhisperCost(modelId: string, durationSeconds: number, provider?: string): number;
-/**
- * Calculate 3D model generation cost.
+ * Calculate 3D model generation cost in USD.
  * Pass `taskCount` > 1 only if multiple tasks were submitted (rare).
  */
-export declare function calculateModel3DCost(modelId: string, provider: string, taskCount?: number): number;
-/**
- * Calculate image generation cost.
- */
-export declare function calculateImageCost(modelId: string, imageCount?: number, quality?: string, provider?: string): number;
+export declare function calculateModel3DCost(modelId: string, provider: ProviderId, taskCount?: number): number;
+/** Calculate image generation cost in USD. */
+export declare function calculateImageCost(modelId: string, imageCount?: number, quality?: string, provider?: ProviderId): number;
 //# sourceMappingURL=cost-calculator.d.ts.map

package/dist/providers/cost-calculator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cost-calculator.d.ts","sourceRoot":"","sources":["../../src/providers/cost-calculator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,oBAAY,QAAQ;IAClB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;IAC3B,4EAA4E;IAC5E,UAAU,eAAe;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6FAA6F;IAC7F,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAkNrD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CA6FhD,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,qBAAa,cAAc;IACzB;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAgChE;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,MAAM,GACf,MAAM;IAkBT;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;CA6CjC;AAID;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,YAAY,GAAE,MAAU,EACxB,QAAQ,GAAE,MAAiB,GAC1B,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,QAAQ,GAAE,MAAiB,GAC1B,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,MAAiB,GAC1B,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,EACvB,QAAQ,GAAE,MAAiB,GAC1B,MAAM,CAGR;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAU,GACpB,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,UAAU,GAAE,MAAU,EACtB,OAAO,GAAE,MAAiB,EAC1B,QAAQ,GAAE,MAAiB,GAC1B,MAAM,CAkBR"}
+{"version":3,"file":"cost-calculator.d.ts","sourceRoot":"","sources":["../../src/providers/cost-calculator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAIH,OAAO,EAIL,KAAK,UAAU,EAChB,MAAM,uBAAuB,CAAC;AAK/B,oBAAY,QAAQ;IAClB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,WAAW,gBAAgB;IAC3B,WAAW,gBAAgB;IAC3B,4EAA4E;IAC5E,UAAU,eAAe;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,QAAQ,CAAC;IACnB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CA+BrD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAoBhD,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+CAA+C;IAC/C,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gDAAgD;IAChD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,uFAAuF;IACvF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4FAA4F;IAC5F,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AA2GD,qBAAa,cAAc;IACzB;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CA8BnE;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,SAAS,CACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,UAAU,GACnB,MAAM,CA8BR;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,oBAAoB,CACzB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,UAAU,GACnB,MAAM,GAAG,IAAI,CAEf;IAED,wDAAwD;IACxD,OAAO,CAAC,MAAM,CAAC,iBAAiB;CAwBjC;AAED,6CAA6C;AAC7C,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,YAAY,GAAE,MAAU,EACxB,QAAQ,GAAE,UAAgC,GACzC,MAAM,CAGR;AAED,uCAAuC;AACvC,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,QAAQ,GAAE,UAAgC,GACzC,MAAM,CAGR;AAED,iCAAiC;AACjC,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,UAAgC,GACzC,MAAM,CAGR;AAED,yCAAyC;AACzC,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,eAAe,EAAE,MAAM,EACvB,QAAQ,GAAE,UAAgC,GACzC,MAAM,CAGR;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,UAAU,EACpB,SAAS,GAAE,MAAU,GACpB,MAAM,CAGR;AAED,8CAA8C;AAC9C,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,UAAU,GAAE,MAAU,EAEtB,OAAO,GAAE,MAAiB,EAC1B,QAAQ,GAAE,UAAgC,GACzC,MAAM,CAGR"}