@juspay/neurolink
Version:
The pipe layer of an AI nervous system: one interface connecting provider neurons to your application, across three inference types — generate, stream and decide. `decide` returns typed, calibrated judgements from a non-generative model (~400ms, ~$0.00002
530 lines (529 loc) • 18.9 kB
JavaScript
/**
* Anthropic Models - Subscription Tier Access and Capabilities
*
* This module defines Anthropic Claude models, their availability by subscription tier,
* model capabilities, and provides helper functions for tier-based access control.
*/
import { ModelAccessError } from "../types/index.js";
import { anthropicManifest } from "./manifests/anthropic.js";
// Re-export runtime value for convenience
export { ModelAccessError };
// ============================================================================
// ANTHROPIC MODEL ENUM
// ============================================================================
/**
* Anthropic Claude model identifiers
*
* @description Enum of all available Claude models with their exact API identifiers.
* Models are organized by family (Haiku, Sonnet, Opus) and version.
*/
export var AnthropicModel;
(function (AnthropicModel) {
// Claude 3 Haiku (Legacy - Fast, efficient)
AnthropicModel["CLAUDE_3_HAIKU"] = "claude-3-haiku-20240307";
// Claude 3.5 Haiku (Current fast model)
AnthropicModel["CLAUDE_3_5_HAIKU"] = "claude-3-5-haiku-20241022";
// Claude 3.5 Sonnet (Balanced performance)
AnthropicModel["CLAUDE_3_5_SONNET"] = "claude-3-5-sonnet-20241022";
// Claude 3.5 Sonnet V2 (Updated version)
AnthropicModel["CLAUDE_3_5_SONNET_V2"] = "claude-3-5-sonnet-v2-20241022";
// Claude Sonnet 4 (Latest Sonnet)
AnthropicModel["CLAUDE_SONNET_4"] = "claude-sonnet-4-20250514";
// Claude Sonnet 4.6
AnthropicModel["CLAUDE_SONNET_4_6"] = "claude-sonnet-4-6";
// Claude Opus 4.5
AnthropicModel["CLAUDE_OPUS_4_5"] = "claude-opus-4-5-20251101";
// Claude Sonnet 4.5
AnthropicModel["CLAUDE_SONNET_4_5"] = "claude-sonnet-4-5-20250929";
// Claude 4.5 Haiku
AnthropicModel["CLAUDE_HAIKU_4_5"] = "claude-haiku-4-5-20251001";
// Claude 3 Opus (Legacy flagship)
AnthropicModel["CLAUDE_3_OPUS"] = "claude-3-opus-20240229";
// Claude Opus 4 (Latest flagship)
AnthropicModel["CLAUDE_OPUS_4"] = "claude-opus-4-20250514";
// Claude Opus 4.6
AnthropicModel["CLAUDE_OPUS_4_6"] = "claude-opus-4-6";
})(AnthropicModel || (AnthropicModel = {}));
// ============================================================================
// MODEL TIER ACCESS DEFINITIONS
// ============================================================================
/**
* Model access mapping by subscription tier
*
* Each tier includes progressively more models:
* - free: Basic models for casual use (Haiku only)
* - pro: Professional tier with Sonnet models
* - max: All models including the latest flagship Opus
* - api: Full API access to all models (based on API access)
*/
export const MODEL_TIER_ACCESS = {
// Free tier: Basic/older Haiku models only
free: [AnthropicModel.CLAUDE_3_HAIKU, AnthropicModel.CLAUDE_3_5_HAIKU],
// Pro tier: Haiku + Sonnet models
pro: [
// Haiku models
AnthropicModel.CLAUDE_3_HAIKU,
AnthropicModel.CLAUDE_3_5_HAIKU,
// Sonnet models
AnthropicModel.CLAUDE_3_5_SONNET,
AnthropicModel.CLAUDE_3_5_SONNET_V2,
AnthropicModel.CLAUDE_SONNET_4,
AnthropicModel.CLAUDE_SONNET_4_6,
],
// Max tier: All models including Opus
max: ["*"], // All models
// Max 5x tier: Same access as max tier (5x usage multiplier)
max_5: ["*"], // All models
// Max 20x tier: Same access as max tier (20x usage multiplier)
max_20: ["*"], // All models
// API tier: Full access to all models (based on API access)
api: ["*"], // All models
};
// ============================================================================
// MODEL METADATA
// ============================================================================
/**
* Model metadata by model ID, derived from the anthropic manifest
* (src/lib/models/manifests/anthropic.ts) so this catalog can no longer
* silently drift from the canonical source. Family/description fields —
* not tracked by the manifest — are supplied by the small per-id lookups
* below, unchanged from their pre-migration values.
*/
const FAMILY_BY_MODEL = {
[AnthropicModel.CLAUDE_3_HAIKU]: "haiku",
[AnthropicModel.CLAUDE_3_5_HAIKU]: "haiku",
[AnthropicModel.CLAUDE_3_5_SONNET]: "sonnet",
[AnthropicModel.CLAUDE_3_5_SONNET_V2]: "sonnet",
[AnthropicModel.CLAUDE_SONNET_4]: "sonnet",
[AnthropicModel.CLAUDE_SONNET_4_6]: "sonnet",
[AnthropicModel.CLAUDE_3_OPUS]: "opus",
[AnthropicModel.CLAUDE_OPUS_4]: "opus",
[AnthropicModel.CLAUDE_OPUS_4_6]: "opus",
[AnthropicModel.CLAUDE_OPUS_4_5]: "opus",
[AnthropicModel.CLAUDE_SONNET_4_5]: "sonnet",
[AnthropicModel.CLAUDE_HAIKU_4_5]: "haiku",
};
const DESCRIPTION_BY_MODEL = {
[AnthropicModel.CLAUDE_3_HAIKU]: "Fast and efficient model for simple tasks",
[AnthropicModel.CLAUDE_3_5_HAIKU]: "Improved fast model with better performance",
[AnthropicModel.CLAUDE_3_5_SONNET]: "Balanced model for most tasks",
[AnthropicModel.CLAUDE_3_5_SONNET_V2]: "Updated Sonnet with improved capabilities",
[AnthropicModel.CLAUDE_SONNET_4]: "Latest Sonnet with extended thinking support",
[AnthropicModel.CLAUDE_3_OPUS]: "Legacy flagship model for complex tasks",
[AnthropicModel.CLAUDE_OPUS_4]: "Latest flagship model with advanced reasoning",
[AnthropicModel.CLAUDE_SONNET_4_6]: "Claude 4.6 Sonnet with 1M context window",
[AnthropicModel.CLAUDE_OPUS_4_6]: "Claude 4.6 Opus flagship with 1M context window",
[AnthropicModel.CLAUDE_OPUS_4_5]: "Claude 4.5 Opus flagship model",
[AnthropicModel.CLAUDE_SONNET_4_5]: "Claude 4.5 Sonnet balanced model",
[AnthropicModel.CLAUDE_HAIKU_4_5]: "Claude 4.5 Haiku fast model",
};
const DEPRECATED_MODELS = new Set([
AnthropicModel.CLAUDE_3_HAIKU,
AnthropicModel.CLAUDE_3_OPUS,
]);
/**
* CLAUDE_3_5_SONNET_V2's enum value ("claude-3-5-sonnet-v2-20241022") is a
* synthetic id minted only inside this file, pre-dating the manifest — it
* never was a real Anthropic wire id and has no row anywhere else in the
* codebase (pricing.ts, contextWindows.ts, VISION_CAPABILITIES all key off
* "claude-3-5-sonnet-20241022" for both v1 and v2). Route the manifest
* lookup to the real entry instead of inventing a duplicate manifest row
* for the same model; the enum member's name and exported value are left
* untouched.
*/
const MANIFEST_ID_OVERRIDES = {
[AnthropicModel.CLAUDE_3_5_SONNET_V2]: AnthropicModel.CLAUDE_3_5_SONNET,
};
/**
* displayName override applied only where routing through
* MANIFEST_ID_OVERRIDES would otherwise silently rename a model the caller
* already knows by its pre-migration display name (avoids user-visible
* naming churn, same principle the manifest itself documents for its
* pre-existing MODEL_REGISTRY-derived ids).
*/
const DISPLAY_NAME_OVERRIDES = {
[AnthropicModel.CLAUDE_3_5_SONNET_V2]: "Claude 3.5 Sonnet V2",
};
function metadataFromManifest(model) {
const manifestId = MANIFEST_ID_OVERRIDES[model] ?? model;
const entry = anthropicManifest.models[manifestId];
if (!entry) {
throw new Error(`metadataFromManifest: no manifest entry for "${model}" — add it to ` +
`src/lib/models/manifests/anthropic.ts before referencing it here`);
}
return {
displayName: DISPLAY_NAME_OVERRIDES[model] ?? entry.displayName ?? model,
contextWindow: entry.contextWindow,
maxOutputTokens: entry.maxOutputTokens,
supportsVision: entry.vision,
supportsExtendedThinking: entry.reasoning ?? false,
supportsToolUse: entry.functionCalling,
supportsStreaming: true,
deprecated: DEPRECATED_MODELS.has(model),
family: FAMILY_BY_MODEL[model] ?? "sonnet",
description: DESCRIPTION_BY_MODEL[model] ?? entry.displayName ?? model,
};
}
export const MODEL_METADATA = Object.fromEntries(Object.values(AnthropicModel).map((model) => [
model,
metadataFromManifest(model),
]));
// ============================================================================
// DEFAULT MODELS BY TIER
// ============================================================================
/**
* Default model for each subscription tier
*
* These are the recommended default models that provide the best
* balance of capability and cost for each tier level.
*/
export const DEFAULT_MODELS_BY_TIER = {
free: AnthropicModel.CLAUDE_3_5_HAIKU,
pro: AnthropicModel.CLAUDE_SONNET_4,
max: AnthropicModel.CLAUDE_OPUS_4,
max_5: AnthropicModel.CLAUDE_OPUS_4,
max_20: AnthropicModel.CLAUDE_OPUS_4,
api: AnthropicModel.CLAUDE_SONNET_4, // Sonnet is often best balance for API usage
};
// ============================================================================
// HELPER FUNCTIONS
// ============================================================================
/**
* Get all available model IDs
*
* @returns Array of all model ID strings
*/
function getAllModelIds() {
return Object.values(AnthropicModel);
}
/**
* Check if a model is available for a given subscription tier
*
* @param model - The model ID to check (can be enum value or string)
* @param tier - The subscription tier to check against
* @returns true if the model is available for the tier
*
* @example
* ```typescript
* if (isModelAvailableForTier(AnthropicModel.CLAUDE_OPUS_4, "pro")) {
* // Model not available for pro tier
* }
*
* if (isModelAvailableForTier(AnthropicModel.CLAUDE_OPUS_4, "max")) {
* // Model available for max tier
* }
* ```
*/
export function isModelAvailableForTier(model, tier) {
const availableModels = MODEL_TIER_ACCESS[tier];
// Check for wildcard access (all models)
if (availableModels.includes("*")) {
// Verify model is a valid Anthropic model
return getAllModelIds().includes(model);
}
return availableModels.includes(model);
}
/**
* Get all models available for a given subscription tier
*
* @param tier - The subscription tier
* @returns Array of model IDs available for the tier
*
* @example
* ```typescript
* const models = getAvailableModelsForTier("pro");
* console.log(models);
* // ["claude-3-haiku-20240307", "claude-3-5-haiku-20241022", "claude-3-5-sonnet-20241022", ...]
* ```
*/
export function getAvailableModelsForTier(tier) {
const availableModels = MODEL_TIER_ACCESS[tier];
// If wildcard, return all models
if (availableModels.includes("*")) {
return getAllModelIds();
}
return [...availableModels];
}
/**
* Get the human-readable display name for a model
*
* @param model - The model ID
* @returns The display name, or the model ID if not found
*
* @example
* ```typescript
* const name = getModelDisplayName(AnthropicModel.CLAUDE_OPUS_4);
* console.log(name); // "Claude Opus 4"
*
* const unknown = getModelDisplayName("unknown-model");
* console.log(unknown); // "unknown-model"
* ```
*/
export function getModelDisplayName(model) {
const metadata = MODEL_METADATA[model];
return metadata?.displayName ?? model;
}
/**
* Get the default/recommended model for a given subscription tier
*
* Returns the best default model that should be used for each tier.
*
* @param tier - The subscription tier
* @returns The default model ID for the tier
*
* @example
* ```typescript
* const model = getDefaultModelForTier("max");
* console.log(model); // "claude-opus-4-20250514"
*
* const proModel = getDefaultModelForTier("pro");
* console.log(proModel); // "claude-sonnet-4-20250514"
* ```
*/
export function getDefaultModelForTier(tier) {
return DEFAULT_MODELS_BY_TIER[tier];
}
/**
* Get metadata for a specific model
*
* @param model - The model ID
* @returns The model metadata, or undefined if not found
*
* @example
* ```typescript
* const metadata = getModelMetadata(AnthropicModel.CLAUDE_OPUS_4);
* if (metadata?.supportsExtendedThinking) {
* // Enable extended thinking mode
* }
* ```
*/
export function getModelMetadata(model) {
return MODEL_METADATA[model];
}
/**
* Check if a model supports a specific capability
*
* @param model - The model ID
* @param capability - The capability to check
* @returns true if the model supports the capability
*
* @example
* ```typescript
* if (modelSupportsCapability(AnthropicModel.CLAUDE_OPUS_4, "supportsExtendedThinking")) {
* // Use extended thinking
* }
* ```
*/
export function modelSupportsCapability(model, capability) {
const metadata = MODEL_METADATA[model];
if (!metadata) {
return false;
}
const value = metadata[capability];
// For boolean capabilities, return the value directly
// For numeric capabilities, check if truthy (> 0)
return typeof value === "boolean" ? value : Boolean(value);
}
/**
* Get the minimum subscription tier required for a model
*
* @param model - The model ID to check
* @returns The minimum tier required, or "api" if model not found
*
* @example
* ```typescript
* const tier = getMinimumTierForModel(AnthropicModel.CLAUDE_OPUS_4);
* console.log(tier); // "max"
*
* const haikuTier = getMinimumTierForModel(AnthropicModel.CLAUDE_3_HAIKU);
* console.log(haikuTier); // "free"
* ```
*/
export function getMinimumTierForModel(model) {
// Check tiers in order from lowest to highest
const tierOrder = [
"free",
"pro",
"max",
"max_5",
"max_20",
"api",
];
for (const tier of tierOrder) {
if (isModelAvailableForTier(model, tier)) {
return tier;
}
}
// Default to API tier if model not found (for custom/unknown models)
return "api";
}
/**
* Get all models that support a specific capability
*
* @param capability - The capability to filter by
* @returns Array of model IDs that have the capability
*
* @example
* ```typescript
* const thinkingModels = getModelsWithCapability("supportsExtendedThinking");
* console.log(thinkingModels);
* // ["claude-sonnet-4-20250514", "claude-opus-4-20250514"]
* ```
*/
export function getModelsWithCapability(capability) {
return Object.entries(MODEL_METADATA)
.filter(([_, metadata]) => {
const value = metadata[capability];
return typeof value === "boolean" ? value : Boolean(value);
})
.map(([modelId]) => modelId);
}
/**
* Get models filtered by family (haiku, sonnet, opus)
*
* @param family - The model family to filter by
* @returns Array of model IDs in the specified family
*
* @example
* ```typescript
* const opusModels = getModelsByFamily("opus");
* // ["claude-3-opus-20240229", "claude-opus-4-20250514"]
* ```
*/
export function getModelsByFamily(family) {
return Object.entries(MODEL_METADATA)
.filter(([_, metadata]) => metadata.family === family)
.map(([modelId]) => modelId);
}
/**
* Get the latest (non-deprecated) model in each family
*
* @returns Object mapping family name to the latest model in that family
*
* @example
* ```typescript
* const latest = getLatestModelsByFamily();
* console.log(latest.opus); // "claude-opus-4-20250514"
* console.log(latest.sonnet); // "claude-sonnet-4-20250514"
* ```
*/
export function getLatestModelsByFamily() {
const result = {
haiku: undefined,
sonnet: undefined,
opus: undefined,
};
// Priority order for each family (latest first based on model version)
const familyPriority = {
haiku: [
AnthropicModel.CLAUDE_HAIKU_4_5,
AnthropicModel.CLAUDE_3_5_HAIKU,
AnthropicModel.CLAUDE_3_HAIKU,
],
sonnet: [
AnthropicModel.CLAUDE_SONNET_4_6,
AnthropicModel.CLAUDE_SONNET_4_5,
AnthropicModel.CLAUDE_SONNET_4,
AnthropicModel.CLAUDE_3_5_SONNET_V2,
AnthropicModel.CLAUDE_3_5_SONNET,
],
opus: [
AnthropicModel.CLAUDE_OPUS_4_6,
AnthropicModel.CLAUDE_OPUS_4_5,
AnthropicModel.CLAUDE_OPUS_4,
AnthropicModel.CLAUDE_3_OPUS,
],
};
for (const family of Object.keys(familyPriority)) {
for (const model of familyPriority[family]) {
const metadata = MODEL_METADATA[model];
if (metadata && !metadata.deprecated) {
result[family] = model;
break;
}
}
}
return result;
}
/**
* Validate that a model is accessible for a given tier, throwing if not
*
* @param model - The model ID to validate
* @param tier - The subscription tier to validate against
* @throws {ModelAccessError} If the model is not available for the tier
*
* @example
* ```typescript
* try {
* validateModelAccess(AnthropicModel.CLAUDE_OPUS_4, "free");
* } catch (error) {
* if (error instanceof ModelAccessError) {
* console.log(`Upgrade to ${error.requiredTier} to use this model`);
* }
* }
* ```
*/
export function validateModelAccess(model, tier) {
if (!isModelAvailableForTier(model, tier)) {
const requiredTier = getMinimumTierForModel(model);
throw new ModelAccessError(model, tier, requiredTier);
}
}
/**
* Compare subscription tiers
*
* @param tier1 - First tier to compare
* @param tier2 - Second tier to compare
* @returns Negative if tier1 < tier2, positive if tier1 > tier2, 0 if equal
*/
export function compareTiers(tier1, tier2) {
const tierOrder = [
"free",
"pro",
"max",
"max_5",
"max_20",
"api",
];
return tierOrder.indexOf(tier1) - tierOrder.indexOf(tier2);
}
/**
* Get context window size for a model
*
* @param model - The model ID
* @returns The context window size in tokens, or 0 if model not found
*/
export function getContextWindow(model) {
return MODEL_METADATA[model]?.contextWindow ?? 0;
}
/**
* Get max output tokens for a model
*
* @param model - The model ID
* @returns The max output tokens, or 0 if model not found
*/
export function getMaxOutputTokens(model) {
return MODEL_METADATA[model]?.maxOutputTokens ?? 0;
}
/**
* Check if a model supports extended thinking
*
* @param model - The model ID
* @returns true if the model supports extended thinking
*/
export function supportsExtendedThinking(model) {
return MODEL_METADATA[model]?.supportsExtendedThinking ?? false;
}
// ============================================================================
// BACKWARD COMPATIBILITY ALIASES
// ============================================================================
/**
* Alias for getDefaultModelForTier for backward compatibility
* @deprecated Use getDefaultModelForTier instead
*/
export const getRecommendedModelForTier = getDefaultModelForTier;
/**
* Alias for getModelMetadata for backward compatibility
* @deprecated Use getModelMetadata instead
*/
export const getModelCapabilities = getModelMetadata;