@ggui-ai/protocol 0.1.0-rc.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"llm.d.ts","sourceRoot":"","sources":["../../src/types/llm.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAMH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,CAAC;AAE3E,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,WAAW,EAAE;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAKzF,CAAC;AAMF,MAAM,MAAM,OAAO,GAEf,4BAA4B,GAC5B,6BAA6B,GAC7B,2BAA2B,GAE3B,sCAAsC,GACtC,+BAA+B,GAC/B,+BAA+B,GAE/B,sBAAsB,GACtB,gBAAgB,GAChB,qBAAqB,GACrB,qBAAqB,CAAC;AAE1B,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAExD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,WAAW,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE;QACL,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAMD,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,OAAO,EAAE,WAAW,CAgG9C,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,OAAsC,CAAC;AAMnE,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,EAAE,IAAI,OAAO,CAExD;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAsBhE;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAM7D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,EAAE,CAIrE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,EAAE,CAI3D;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAK1D"}

package/dist/types/llm.js

@@ -0,0 +1,186 @@
+/**
+ * LLM Provider and Model Types for BYOK (Bring Your Own Key)
+ *
+ * Model IDs use LiteLLM format: "provider/model-name"
+ * This allows direct passthrough to LiteLLM proxy without transformation.
+ *
+ * Pricing last verified: March 2026
+ * Sources:
+ *   https://docs.anthropic.com/en/docs/about-claude/pricing
+ *   https://developers.openai.com/api/docs/pricing/
+ *   https://ai.google.dev/gemini-api/docs/pricing
+ */
+export const PROVIDER_INFO = {
+    anthropic: { displayName: "Anthropic", keyPrefix: "sk-ant-" },
+    google: { displayName: "Google AI", keyPrefix: "AIza" },
+    openai: { displayName: "OpenAI", keyPrefix: "sk-" },
+    openrouter: { displayName: "OpenRouter", keyPrefix: "sk-or-" },
+};
+// =============================================================================
+// Model Registry — verified pricing March 2026
+// =============================================================================
+export const MODEL_REGISTRY = {
+    // ── Anthropic Claude ──────────────────────────────────────────────
+    "anthropic/claude-haiku-4-5": {
+        id: "anthropic/claude-haiku-4-5",
+        provider: "anthropic",
+        displayName: "Claude Haiku 4.5",
+        tier: "fast",
+        costs: { inputPer1M: 1.0, outputPer1M: 5.0 },
+        maxTokens: 200000,
+        supportsTools: true,
+    },
+    "anthropic/claude-sonnet-4-6": {
+        id: "anthropic/claude-sonnet-4-6",
+        provider: "anthropic",
+        displayName: "Claude Sonnet 4.6",
+        tier: "balanced",
+        costs: { inputPer1M: 3.0, outputPer1M: 15.0 },
+        maxTokens: 200000,
+        supportsTools: true,
+    },
+    "anthropic/claude-opus-4-6": {
+        id: "anthropic/claude-opus-4-6",
+        provider: "anthropic",
+        displayName: "Claude Opus 4.6",
+        tier: "premium",
+        costs: { inputPer1M: 5.0, outputPer1M: 25.0 },
+        maxTokens: 1000000,
+        supportsTools: true,
+    },
+    // ── Google Gemini (API requires "-preview" suffix) ──────────────
+    "gemini/gemini-3.1-flash-lite-preview": {
+        id: "gemini/gemini-3.1-flash-lite-preview",
+        provider: "google",
+        displayName: "Gemini 3.1 Flash Lite",
+        tier: "fast",
+        costs: { inputPer1M: 0.25, outputPer1M: 1.5 },
+        maxTokens: 1000000,
+        supportsTools: true,
+    },
+    "gemini/gemini-3-flash-preview": {
+        id: "gemini/gemini-3-flash-preview",
+        provider: "google",
+        displayName: "Gemini 3 Flash",
+        tier: "fast",
+        costs: { inputPer1M: 0.5, outputPer1M: 3.0 },
+        maxTokens: 1000000,
+        supportsTools: true,
+    },
+    "gemini/gemini-3.1-pro-preview": {
+        id: "gemini/gemini-3.1-pro-preview",
+        provider: "google",
+        displayName: "Gemini 3.1 Pro",
+        tier: "balanced",
+        costs: { inputPer1M: 2.0, outputPer1M: 12.0 },
+        maxTokens: 1000000,
+        supportsTools: true,
+    },
+    // ── OpenAI ────────────────────────────────────────────────────────
+    "openai/gpt-5.3-codex": {
+        id: "openai/gpt-5.3-codex",
+        provider: "openai",
+        displayName: "GPT-5.3 Codex",
+        tier: "balanced",
+        costs: { inputPer1M: 1.75, outputPer1M: 14.0 },
+        maxTokens: 200000,
+        supportsTools: true,
+    },
+    "openai/gpt-5.4": {
+        id: "openai/gpt-5.4",
+        provider: "openai",
+        displayName: "GPT-5.4",
+        tier: "premium",
+        costs: { inputPer1M: 2.5, outputPer1M: 15.0 },
+        maxTokens: 1050000,
+        supportsTools: true,
+    },
+    "openai/gpt-5.4-mini": {
+        id: "openai/gpt-5.4-mini",
+        provider: "openai",
+        displayName: "GPT-5.4 Mini",
+        tier: "fast",
+        costs: { inputPer1M: 0.75, outputPer1M: 4.5 },
+        maxTokens: 400000,
+        supportsTools: true,
+    },
+    "openai/gpt-5.4-nano": {
+        id: "openai/gpt-5.4-nano",
+        provider: "openai",
+        displayName: "GPT-5.4 Nano",
+        tier: "fast",
+        costs: { inputPer1M: 0.20, outputPer1M: 1.25 },
+        maxTokens: 400000,
+        supportsTools: true,
+    },
+};
+/**
+ * Default model for generation
+ */
+export const DEFAULT_MODEL = "anthropic/claude-haiku-4-5";
+// =============================================================================
+// Helper Functions
+// =============================================================================
+export function isValidModelId(id) {
+    return id in MODEL_REGISTRY;
+}
+/**
+ * Get provider name from a LiteLLM-format model ID.
+ * Returns 'anthropic' as default for unrecognized formats.
+ */
+export function getProviderForModel(modelId) {
+    const slash = modelId.indexOf("/");
+    if (slash < 0) {
+        console.warn(`Unrecognized model format (no slash): "${modelId}" — defaulting to anthropic`);
+        return "anthropic";
+    }
+    const prefix = modelId.substring(0, slash);
+    const providerMap = {
+        anthropic: "anthropic",
+        gemini: "google",
+        openai: "openai",
+        openrouter: "openrouter",
+    };
+    const provider = providerMap[prefix];
+    if (!provider) {
+        console.warn(`Unrecognized model format: "${modelId}" — defaulting to anthropic`);
+        return "anthropic";
+    }
+    return provider;
+}
+/**
+ * Validate LiteLLM format: "provider/model-name"
+ */
+export function isValidLiteLLMFormat(modelId) {
+    const slash = modelId.indexOf("/");
+    if (slash <= 0)
+        return false;
+    const prefix = modelId.substring(0, slash);
+    return ["anthropic", "gemini", "openai", "openrouter"].includes(prefix)
+        && modelId.length > slash + 1;
+}
+/**
+ * Get all model IDs for a given provider.
+ */
+export function getModelsForProvider(provider) {
+    return Object.values(MODEL_REGISTRY)
+        .filter((m) => m.provider === provider)
+        .map((m) => m.id);
+}
+/**
+ * Get all model IDs for a given tier.
+ */
+export function getModelsForTier(tier) {
+    return Object.values(MODEL_REGISTRY)
+        .filter((m) => m.tier === tier)
+        .map((m) => m.id);
+}
+/**
+ * Select the default model for a given tier.
+ */
+export function selectModelByTier(tier) {
+    const models = getModelsForTier(tier);
+    // Prefer Anthropic models as default
+    const anthropic = models.find((m) => m.startsWith("anthropic/"));
+    return anthropic ?? models[0] ?? DEFAULT_MODEL;
+}

package/dist/types/mcp-proxy.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Third-party MCP discovery + relay — wire shapes and public
+ * constants for external MCP providers.
+ *
+ * Scope: constants and types that describe how OSS tooling and
+ * hosted services talk to upstream MCP discovery APIs (Claude.ai
+ * today; Anthropic's MCP-servers API). These are third-party
+ * PROTOCOL fragments — any OSS relay that proxies Claude.ai MCP
+ * servers would need the same constants and discovery-response
+ * shapes.
+ *
+ * Hosted-overlay config types for linking these proxies into an
+ * app's per-tenant config are a hosting concept and live outside
+ * this open protocol package.
+ *
+ * What remains here:
+ *
+ * - Claude.ai OAuth + discovery endpoint constants (third-party
+ *   public API surface).
+ * - {@link DiscoveredMcpServer} — the normalised shape consumers
+ *   get back from any discovery call.
+ * - {@link ClaudeAiDiscoveryResponse} — raw Claude.ai discovery
+ *   response wire shape.
+ * - {@link CLAUDE_AI_SERVICE_ID} — credential-store service id
+ *   used across the stack to name Claude.ai user credentials.
+ */
+/** Claude Code's registered public OAuth client_id (PKCE, no secret). */
+export declare const CLAUDE_AI_CLIENT_ID = "9d1c250a-e61b-44d9-88ed-5944d1962f5e";
+/** Claude.ai OAuth endpoints. */
+export declare const CLAUDE_AI_OAUTH: {
+    readonly authorizeUrl: "https://claude.ai/oauth/authorize";
+    readonly tokenUrl: "https://platform.claude.com/v1/oauth/token";
+    /** Manual redirect — shows auth code for user to copy. */
+    readonly manualRedirectUrl: "https://console.anthropic.com/oauth/code/callback";
+    /** Discovery endpoint for user's MCP servers. */
+    readonly discoveryUrl: "https://api.anthropic.com/v1/mcp_servers";
+    /** MCP proxy URL pattern. */
+    readonly proxyUrl: "https://mcp-proxy.anthropic.com/v1/mcp/{server_id}";
+};
+/** Scopes needed for MCP server access via Claude.ai. */
+export declare const CLAUDE_AI_MCP_SCOPES: readonly ["user:mcp_servers"];
+/** Beta header required for MCP servers API. */
+export declare const CLAUDE_AI_MCP_BETA_HEADER = "mcp-servers-2025-12-04";
+/** A single MCP server discovered from a proxy's discovery endpoint. */
+export interface DiscoveredMcpServer {
+    /** Server identifier (used in proxy URL template). */
+    id: string;
+    /** Human-readable name (e.g. "Google Calendar", "Gmail"). */
+    displayName: string;
+    /** Direct server URL (for reference — calls go through the proxy). */
+    url: string;
+}
+/** Discovery API response shape (Claude.ai format). */
+export interface ClaudeAiDiscoveryResponse {
+    data: Array<{
+        type: 'mcp_server';
+        id: string;
+        display_name: string;
+        url: string;
+        created_at: string;
+    }>;
+    has_more: boolean;
+    next_page: string | null;
+}
+/** ServiceId used for Claude.ai platform credentials in UserCredential. */
+export declare const CLAUDE_AI_SERVICE_ID = "claude_ai_platform";
+//# sourceMappingURL=mcp-proxy.d.ts.map

package/dist/types/mcp-proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mcp-proxy.d.ts","sourceRoot":"","sources":["../../src/types/mcp-proxy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAIH,yEAAyE;AACzE,eAAO,MAAM,mBAAmB,yCAAyC,CAAC;AAE1E,iCAAiC;AACjC,eAAO,MAAM,eAAe;;;IAG1B,0DAA0D;;IAE1D,iDAAiD;;IAEjD,6BAA6B;;CAErB,CAAC;AAEX,yDAAyD;AACzD,eAAO,MAAM,oBAAoB,+BAAgC,CAAC;AAElE,gDAAgD;AAChD,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAIlE,wEAAwE;AACxE,MAAM,WAAW,mBAAmB;IAClC,sDAAsD;IACtD,EAAE,EAAE,MAAM,CAAC;IACX,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;IACpB,sEAAsE;IACtE,GAAG,EAAE,MAAM,CAAC;CACb;AAED,uDAAuD;AACvD,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC;QACV,IAAI,EAAE,YAAY,CAAC;QACnB,EAAE,EAAE,MAAM,CAAC;QACX,YAAY,EAAE,MAAM,CAAC;QACrB,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,2EAA2E;AAC3E,eAAO,MAAM,oBAAoB,uBAAuB,CAAC"}

package/dist/types/mcp-proxy.js

@@ -0,0 +1,46 @@
+/**
+ * Third-party MCP discovery + relay — wire shapes and public
+ * constants for external MCP providers.
+ *
+ * Scope: constants and types that describe how OSS tooling and
+ * hosted services talk to upstream MCP discovery APIs (Claude.ai
+ * today; Anthropic's MCP-servers API). These are third-party
+ * PROTOCOL fragments — any OSS relay that proxies Claude.ai MCP
+ * servers would need the same constants and discovery-response
+ * shapes.
+ *
+ * Hosted-overlay config types for linking these proxies into an
+ * app's per-tenant config are a hosting concept and live outside
+ * this open protocol package.
+ *
+ * What remains here:
+ *
+ * - Claude.ai OAuth + discovery endpoint constants (third-party
+ *   public API surface).
+ * - {@link DiscoveredMcpServer} — the normalised shape consumers
+ *   get back from any discovery call.
+ * - {@link ClaudeAiDiscoveryResponse} — raw Claude.ai discovery
+ *   response wire shape.
+ * - {@link CLAUDE_AI_SERVICE_ID} — credential-store service id
+ *   used across the stack to name Claude.ai user credentials.
+ */
+// ── Claude.ai constants ─────────────────────────────────────────────
+/** Claude Code's registered public OAuth client_id (PKCE, no secret). */
+export const CLAUDE_AI_CLIENT_ID = '9d1c250a-e61b-44d9-88ed-5944d1962f5e';
+/** Claude.ai OAuth endpoints. */
+export const CLAUDE_AI_OAUTH = {
+    authorizeUrl: 'https://claude.ai/oauth/authorize',
+    tokenUrl: 'https://platform.claude.com/v1/oauth/token',
+    /** Manual redirect — shows auth code for user to copy. */
+    manualRedirectUrl: 'https://console.anthropic.com/oauth/code/callback',
+    /** Discovery endpoint for user's MCP servers. */
+    discoveryUrl: 'https://api.anthropic.com/v1/mcp_servers',
+    /** MCP proxy URL pattern. */
+    proxyUrl: 'https://mcp-proxy.anthropic.com/v1/mcp/{server_id}',
+};
+/** Scopes needed for MCP server access via Claude.ai. */
+export const CLAUDE_AI_MCP_SCOPES = ['user:mcp_servers'];
+/** Beta header required for MCP servers API. */
+export const CLAUDE_AI_MCP_BETA_HEADER = 'mcp-servers-2025-12-04';
+/** ServiceId used for Claude.ai platform credentials in UserCredential. */
+export const CLAUDE_AI_SERVICE_ID = 'claude_ai_platform';