@juspay/neurolink 12.5.0 → 12.5.2

package/dist/providers/catalog/schema.js

@@ -0,0 +1,310 @@
+/**
+ * zod validator for the single-JSON provider catalog authoring format.
+ * Mirrors src/lib/types/providerCatalog.ts field-for-field with
+ * z.strictObject (unknown keys are authoring mistakes) plus the
+ * cross-field refinements the plain types cannot express. See
+ * docs/superpowers/plans/2026-08-28-provider-json-catalog-spec.md.
+ *
+ * provider-catalog.schema.json is a hand-kept JSON Schema mirror for
+ * editor validation only — this file is the authoritative validator.
+ */
+import { z } from "zod";
+const IDENTIFIER_PATTERN = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+const KEBAB_ID_PATTERN = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
+const DATE_PATTERN = /^\d{4}-\d{2}-\d{2}$/;
+const catalogPricingPerMTokSchema = z.strictObject({
+    input: z.number(),
+    output: z.number(),
+    cachedInput: z.number().optional(),
+});
+const catalogModelStatusSchema = z.enum(["production", "preview", "retired"]);
+const catalogModelSpecSchema = z.strictObject({
+    contextWindow: z.number().optional(),
+    maxOutputTokens: z.number().optional(),
+    pricingPerMTok: catalogPricingPerMTokSchema.optional(),
+    vision: z.boolean(),
+    status: catalogModelStatusSchema,
+    description: z.string(),
+    enumMember: z
+        .string()
+        .regex(IDENTIFIER_PATTERN, "enumMember must be a valid identifier")
+        .optional(),
+});
+const catalogWireSchema = z
+    .strictObject({
+    baseURL: z.string().optional(),
+    baseURLTemplate: z.string().optional(),
+    extraCredentials: z.array(z.string()).optional(),
+    missingCredentialMessage: z.string().optional(),
+    envOverrides: z
+        .strictObject({
+        apiKey: z.string().optional(),
+        baseURL: z.string().optional(),
+        model: z.string().optional(),
+    })
+        .optional(),
+})
+    .superRefine((wire, ctx) => {
+    const hasBaseURL = wire.baseURL !== undefined;
+    const hasTemplate = wire.baseURLTemplate !== undefined;
+    if (hasBaseURL === hasTemplate) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["baseURL"],
+            message: "wire requires exactly one of baseURL or baseURLTemplate",
+        });
+    }
+    if (wire.extraCredentials !== undefined) {
+        if (wire.extraCredentials.length !== 1) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["extraCredentials"],
+                message: "wire.extraCredentials must have exactly one entry",
+            });
+        }
+        else if (!IDENTIFIER_PATTERN.test(wire.extraCredentials[0])) {
+            // Embedded verbatim in generated credential typing — a non-identifier
+            // value would emit invalid TypeScript.
+            ctx.addIssue({
+                code: "custom",
+                path: ["extraCredentials", 0],
+                message: "wire.extraCredentials entry must be a valid identifier",
+            });
+        }
+        if (!hasTemplate) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["extraCredentials"],
+                message: "wire.extraCredentials is only valid with baseURLTemplate",
+            });
+        }
+    }
+    if (wire.missingCredentialMessage !== undefined && !hasTemplate) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["missingCredentialMessage"],
+            message: "wire.missingCredentialMessage is only valid with baseURLTemplate",
+        });
+    }
+    if (hasTemplate &&
+        wire.extraCredentials !== undefined &&
+        wire.extraCredentials.length === 1) {
+        const placeholder = `{${wire.extraCredentials[0]}}`;
+        if (!wire.baseURLTemplate?.includes(placeholder)) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["baseURLTemplate"],
+                message: "wire.baseURLTemplate must contain the extraCredentials[0] placeholder",
+            });
+        }
+    }
+});
+const catalogErrorRuleClassSchema = z.enum([
+    "authentication",
+    "rate-limit",
+    "invalid-model",
+    "network",
+    "provider",
+]);
+const catalogErrorRuleJsonSchema = z
+    .strictObject({
+    status: z.number().optional(),
+    pattern: z.string().optional(),
+    class: catalogErrorRuleClassSchema,
+    message: z.string(),
+})
+    .superRefine((rule, ctx) => {
+    if (rule.status === undefined && rule.pattern === undefined) {
+        ctx.addIssue({
+            code: "custom",
+            path: [],
+            message: "errorRules entry requires status or pattern",
+        });
+    }
+    if (rule.pattern !== undefined) {
+        try {
+            new RegExp(rule.pattern, "i");
+        }
+        catch {
+            ctx.addIssue({
+                code: "custom",
+                path: ["pattern"],
+                message: "errorRules pattern must compile as a regular expression",
+            });
+        }
+    }
+});
+const catalogQuirksSchema = z.strictObject({
+    timeoutErrorClass: z.literal("provider").optional(),
+    registryDefaultIgnoresModelEnvVar: z.boolean().optional(),
+});
+const catalogBillingPolicySchema = z.enum([
+    "free-tier",
+    "free-with-card",
+    "no-free-tier",
+]);
+const catalogSetupSchema = z.strictObject({
+    url: z.string(),
+    apiKeyFormat: z.string().nullable(),
+    billingPolicy: catalogBillingPolicySchema,
+    instructions: z.array(z.string()),
+    description: z.string().optional(),
+});
+const catalogProbeEvidenceSchema = z.strictObject({
+    date: z.string().regex(DATE_PATTERN, "date must match YYYY-MM-DD"),
+    status: z.number().optional(),
+    code: z.string().optional(),
+    method: z.string().optional(),
+});
+const catalogEvidenceSchema = z.strictObject({
+    rosterVerified: catalogProbeEvidenceSchema,
+    authProbe: catalogProbeEvidenceSchema.optional(),
+    billingProbe: catalogProbeEvidenceSchema.optional(),
+    liveMatrix: z
+        .strictObject({
+        date: z.string().regex(DATE_PATTERN, "date must match YYYY-MM-DD"),
+        result: z.string(),
+    })
+        .nullable(),
+    addedInPR: z.string(),
+});
+const catalogCapabilitiesSchema = z.strictObject({
+    text: z.boolean(),
+    streaming: z.boolean(),
+    tools: z.boolean(),
+    toolsWithStreaming: z.boolean(),
+    structuredOutput: z.boolean(),
+    structuredOutputWithTools: z.boolean(),
+    embeddings: z.boolean(),
+    thinking: z.boolean(),
+});
+const catalogModelsSchema = z
+    .strictObject({
+    default: z.string(),
+    fallbacks: z.array(z.string()),
+    fallbackModelName: z.string().optional(),
+    registryDefaultModel: z.string().optional(),
+    defaultContextWindow: z.number(),
+    defaultMaxOutputTokens: z.number(),
+    catalog: z.record(z.string(), catalogModelSpecSchema),
+    topModels: z.array(z.string()).min(1).optional(),
+    visionModel: z.string().optional(),
+    // Deliberately NOT constrained to catalog keys: testModel captures what
+    // the testing account can actually reach today, which may be a model
+    // the transcribed catalog predates.
+    testModel: z.string().min(1).optional(),
+})
+    .superRefine((models, ctx) => {
+    const catalogKeys = new Set(Object.keys(models.catalog));
+    if (models.fallbacks.length === 0) {
+        // The loader's fallbackModelName default is fallbacks[1] ?? fallbacks[0],
+        // which depends on fallbacks[0] existing.
+        ctx.addIssue({
+            code: "custom",
+            path: ["fallbacks"],
+            message: "models.fallbacks must have at least one entry",
+        });
+    }
+    if (!catalogKeys.has(models.default)) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["default"],
+            message: "models.default must be a key of models.catalog",
+        });
+    }
+    models.fallbacks.forEach((fallback, index) => {
+        if (!catalogKeys.has(fallback)) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["fallbacks", index],
+                message: "models.fallbacks entry must be a key of models.catalog",
+            });
+        }
+    });
+    if (models.fallbackModelName !== undefined &&
+        !catalogKeys.has(models.fallbackModelName)) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["fallbackModelName"],
+            message: "models.fallbackModelName must be a key of models.catalog",
+        });
+    }
+    if (models.registryDefaultModel !== undefined &&
+        !catalogKeys.has(models.registryDefaultModel)) {
+        ctx.addIssue({
+            code: "custom",
+            path: ["registryDefaultModel"],
+            message: "models.registryDefaultModel must be a key of models.catalog",
+        });
+    }
+    if (models.topModels !== undefined) {
+        models.topModels.forEach((modelId, index) => {
+            if (!catalogKeys.has(modelId)) {
+                ctx.addIssue({
+                    code: "custom",
+                    path: ["topModels", index],
+                    message: "models.topModels entry must be a key of models.catalog",
+                });
+            }
+        });
+        const seen = new Set();
+        models.topModels.forEach((modelId, index) => {
+            if (seen.has(modelId)) {
+                ctx.addIssue({
+                    code: "custom",
+                    path: ["topModels", index],
+                    message: "models.topModels must not contain duplicate entries",
+                });
+            }
+            seen.add(modelId);
+        });
+    }
+    if (models.visionModel !== undefined) {
+        const spec = models.catalog[models.visionModel];
+        if (!spec) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["visionModel"],
+                message: "models.visionModel must be a key of models.catalog",
+            });
+        }
+        else if (!spec.vision) {
+            ctx.addIssue({
+                code: "custom",
+                path: ["visionModel"],
+                message: "models.visionModel entry must have vision: true",
+            });
+        }
+    }
+});
+export const providerCatalogJsonSchema = z.strictObject({
+    $schema: z.string().optional(),
+    id: z.string().regex(KEBAB_ID_PATTERN, "id must be kebab-case"),
+    displayName: z.string(),
+    enumTypeName: z
+        .string()
+        .regex(IDENTIFIER_PATTERN, "enumTypeName must be a valid identifier")
+        .optional(),
+    credentialsKey: z
+        .string()
+        .regex(IDENTIFIER_PATTERN, "credentialsKey must be a valid identifier")
+        .optional(),
+    aliases: z.array(z.string()),
+    tier: z.literal(2),
+    wire: catalogWireSchema,
+    models: catalogModelsSchema,
+    capabilities: catalogCapabilitiesSchema,
+    errorRules: z.array(catalogErrorRuleJsonSchema),
+    quirks: catalogQuirksSchema.optional(),
+    setup: catalogSetupSchema,
+    evidence: catalogEvidenceSchema,
+});
+export function parseProviderCatalogJson(raw, sourcePath) {
+    const result = providerCatalogJsonSchema.safeParse(raw);
+    if (!result.success) {
+        throw new Error(`Invalid provider catalog file ${sourcePath}: ${result.error.issues
+            .map((i) => `${i.path.join(".")}: ${i.message}`)
+            .join("; ")}`);
+    }
+    return result.data;
+}

package/dist/providers/catalog/together-ai.json

@@ -0,0 +1,172 @@
+{
+    "$schema": "./provider-catalog.schema.json",
+    "id": "together-ai",
+    "displayName": "Together AI",
+    "enumTypeName": "TogetherAIModels",
+    "credentialsKey": "together",
+    "aliases": ["together"],
+    "tier": 2,
+    "wire": {
+        "baseURL": "https://api.together.xyz/v1",
+        "envOverrides": {
+            "apiKey": "TOGETHER_API_KEY",
+            "baseURL": "TOGETHER_BASE_URL",
+            "model": "TOGETHER_MODEL"
+        }
+    },
+    "models": {
+        "default": "meta-llama/Llama-3.3-70B-Instruct-Turbo",
+        "fallbackModelName": "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo",
+        "fallbacks": [
+            "meta-llama/Llama-3.3-70B-Instruct-Turbo",
+            "meta-llama/Meta-Llama-3.1-405B-Instruct-Turbo",
+            "meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo",
+            "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo",
+            "mistralai/Mixtral-8x22B-Instruct-v0.1",
+            "Qwen/Qwen2.5-72B-Instruct-Turbo",
+            "deepseek-ai/DeepSeek-R1",
+            "deepseek-ai/DeepSeek-V3"
+        ],
+        "defaultContextWindow": 128000,
+        "defaultMaxOutputTokens": 4096,
+        "catalog": {
+            "meta-llama/Llama-3.3-70B-Instruct-Turbo": {
+                "enumMember": "LLAMA_3_3_70B_INSTRUCT_TURBO",
+                "contextWindow": 128000,
+                "pricingPerMTok": { "input": 0.88, "output": 0.88 },
+                "vision": false,
+                "status": "production",
+                "description": "Recommended - Llama 3.3 70B Turbo"
+            },
+            "meta-llama/Meta-Llama-3.1-405B-Instruct-Turbo": {
+                "enumMember": "LLAMA_3_1_405B_INSTRUCT_TURBO",
+                "contextWindow": 128000,
+                "pricingPerMTok": { "input": 3.5, "output": 3.5 },
+                "vision": false,
+                "status": "production",
+                "description": "Flagship 405B"
+            },
+            "meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo": {
+                "enumMember": "LLAMA_3_1_70B_INSTRUCT_TURBO",
+                "contextWindow": 128000,
+                "pricingPerMTok": { "input": 0.88, "output": 0.88 },
+                "vision": false,
+                "status": "production",
+                "description": "Llama 3.1 70B Instruct Turbo"
+            },
+            "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo": {
+                "enumMember": "LLAMA_3_1_8B_INSTRUCT_TURBO",
+                "contextWindow": 128000,
+                "pricingPerMTok": { "input": 0.18, "output": 0.18 },
+                "vision": false,
+                "status": "production",
+                "description": "Llama 3.1 8B Instruct Turbo — fastest"
+            },
+            "mistralai/Mixtral-8x22B-Instruct-v0.1": {
+                "enumMember": "MIXTRAL_8X22B_INSTRUCT",
+                "contextWindow": 65536,
+                "pricingPerMTok": { "input": 1.2, "output": 1.2 },
+                "vision": false,
+                "status": "production",
+                "description": "Mistral 8x22B MoE"
+            },
+            "mistralai/Mixtral-8x7B-Instruct-v0.1": {
+                "enumMember": "MIXTRAL_8X7B_INSTRUCT",
+                "contextWindow": 32768,
+                "pricingPerMTok": { "input": 0.6, "output": 0.6 },
+                "vision": false,
+                "status": "production",
+                "description": "Mixtral 8x7B Instruct"
+            },
+            "Qwen/Qwen2.5-72B-Instruct-Turbo": {
+                "enumMember": "QWEN_2_5_72B_INSTRUCT_TURBO",
+                "contextWindow": 32768,
+                "pricingPerMTok": { "input": 1.2, "output": 1.2 },
+                "vision": false,
+                "status": "production",
+                "description": "Qwen 2.5 72B Turbo"
+            },
+            "Qwen/Qwen2.5-Coder-32B-Instruct": {
+                "enumMember": "QWEN_2_5_CODER_32B",
+                "contextWindow": 32768,
+                "vision": false,
+                "status": "production",
+                "description": "Qwen 2.5 Coder 32B Instruct"
+            },
+            "deepseek-ai/DeepSeek-R1": {
+                "enumMember": "DEEPSEEK_R1",
+                "contextWindow": 64000,
+                "pricingPerMTok": { "input": 7.0, "output": 7.0 },
+                "vision": false,
+                "status": "production",
+                "description": "DeepSeek R1 reasoning"
+            },
+            "deepseek-ai/DeepSeek-V3": {
+                "enumMember": "DEEPSEEK_V3",
+                "contextWindow": 64000,
+                "pricingPerMTok": { "input": 1.25, "output": 1.25 },
+                "vision": false,
+                "status": "production",
+                "description": "DeepSeek V3"
+            },
+            "google/gemma-2-27b-it": {
+                "enumMember": "GEMMA_2_27B_IT",
+                "contextWindow": 8192,
+                "vision": false,
+                "status": "production",
+                "description": "Google Gemma 2 27B IT"
+            },
+            "microsoft/WizardLM-2-8x22B": {
+                "enumMember": "WIZARDLM_2_8X22B",
+                "contextWindow": 65536,
+                "vision": false,
+                "status": "production",
+                "description": "WizardLM 2 8x22B"
+            }
+        },
+        "topModels": [
+            "meta-llama/Llama-3.3-70B-Instruct-Turbo",
+            "meta-llama/Meta-Llama-3.1-405B-Instruct-Turbo",
+            "Qwen/Qwen2.5-72B-Instruct-Turbo",
+            "deepseek-ai/DeepSeek-R1",
+            "mistralai/Mixtral-8x22B-Instruct-v0.1"
+        ]
+    },
+    "capabilities": {
+        "text": true,
+        "streaming": true,
+        "tools": true,
+        "toolsWithStreaming": true,
+        "structuredOutput": true,
+        "structuredOutputWithTools": true,
+        "embeddings": false,
+        "thinking": false
+    },
+    "errorRules": [
+        {
+            "status": 401,
+            "pattern": "Invalid API key|Authentication",
+            "class": "authentication",
+            "message": "Invalid Together AI API key. Get one at https://api.together.xyz/settings/api-keys"
+        }
+    ],
+    "setup": {
+        "url": "https://api.together.xyz/settings/api-keys",
+        "apiKeyFormat": null,
+        "billingPolicy": "free-with-card",
+        "instructions": [
+            "1. Visit: https://api.together.xyz/settings/api-keys",
+            "2. Sign in to your Together AI account",
+            "3. Create a new API key",
+            "4. Set {apiKeyEnvVar} in your .env file"
+        ]
+    },
+    "evidence": {
+        "rosterVerified": {
+            "date": "2026-08-28",
+            "method": "transcribed from pre-migration TS catalog"
+        },
+        "liveMatrix": null,
+        "addedInPR": "https://github.com/juspay/neurolink/pull/1587"
+    }
+}

package/dist/providers/catalog/xai.json

@@ -0,0 +1,108 @@
+{
+    "$schema": "./provider-catalog.schema.json",
+    "id": "xai",
+    "displayName": "xAI",
+    "aliases": ["grok"],
+    "tier": 2,
+    "wire": {
+        "baseURL": "https://api.x.ai/v1"
+    },
+    "models": {
+        "default": "grok-3",
+        "fallbacks": [
+            "grok-3",
+            "grok-3-mini",
+            "grok-2-latest",
+            "grok-2-vision-latest",
+            "grok-beta"
+        ],
+        "defaultContextWindow": 131072,
+        "defaultMaxOutputTokens": 4096,
+        "catalog": {
+            "grok-3": {
+                "contextWindow": 131072,
+                "pricingPerMTok": { "input": 3.0, "output": 15.0 },
+                "vision": false,
+                "status": "production",
+                "description": "Recommended - Latest flagship Grok"
+            },
+            "grok-3-mini": {
+                "contextWindow": 131072,
+                "pricingPerMTok": { "input": 0.3, "output": 0.5 },
+                "vision": false,
+                "status": "production",
+                "description": "Faster + cheaper Grok 3"
+            },
+            "grok-2-latest": {
+                "contextWindow": 131072,
+                "pricingPerMTok": { "input": 2.0, "output": 10.0 },
+                "vision": false,
+                "status": "production",
+                "description": "Previous flagship"
+            },
+            "grok-2-vision-latest": {
+                "contextWindow": 32768,
+                "pricingPerMTok": { "input": 2.0, "output": 10.0 },
+                "vision": true,
+                "status": "production",
+                "description": "Multimodal (text + images)"
+            },
+            "grok-beta": {
+                "contextWindow": 131072,
+                "pricingPerMTok": { "input": 5.0, "output": 15.0 },
+                "vision": false,
+                "status": "preview",
+                "description": "Pre-release / experimental"
+            }
+        },
+        "topModels": [
+            "grok-3",
+            "grok-3-mini",
+            "grok-2-vision-latest",
+            "grok-2-latest",
+            "grok-beta"
+        ]
+    },
+    "capabilities": {
+        "text": true,
+        "streaming": true,
+        "tools": true,
+        "toolsWithStreaming": true,
+        "structuredOutput": true,
+        "structuredOutputWithTools": true,
+        "embeddings": false,
+        "thinking": false
+    },
+    "errorRules": [
+        {
+            "status": 401,
+            "pattern": "Invalid API key|Authentication|invalid_api_key",
+            "class": "authentication",
+            "message": "Invalid xAI API key. Please check your {apiKeyEnvVar} environment variable. Get one at https://console.x.ai/"
+        },
+        {
+            "pattern": "insufficient_quota|quota exceeded",
+            "class": "provider",
+            "message": "xAI account has insufficient quota. Top up at https://console.x.ai/"
+        }
+    ],
+    "setup": {
+        "url": "https://console.x.ai/",
+        "apiKeyFormat": null,
+        "billingPolicy": "no-free-tier",
+        "instructions": [
+            "1. Visit: https://console.x.ai/",
+            "2. Sign in with your xAI account",
+            "3. Create an API key",
+            "4. Set {apiKeyEnvVar} in your .env file"
+        ]
+    },
+    "evidence": {
+        "rosterVerified": {
+            "date": "2026-08-28",
+            "method": "transcribed from pre-migration TS catalog"
+        },
+        "liveMatrix": null,
+        "addedInPR": "https://github.com/juspay/neurolink/pull/1587"
+    }
+}

package/dist/providers/openaiCompatCatalog.d.ts

@@ -6,19 +6,19 @@ import type { OpenAICompatCatalogEntry } from "../types/index.js";
  * for the class that reads these entries, and providerRegistry.ts for the
  * registration loop that consumes this array.
  *
- * `errorRules` mirrors each provider's LIVE `formatProviderError` rule array
- * (post plan-07/wave-2 migration), not the original hand-rolled ladder these
- * providers had when plan 05 was first drafted: every provider below now
- * keeps only its bespoke rule(s) — auth, plus Groq's model_decommissioned and
- * xAI's insufficient_quota — before spreading the SAME exported
- * `DEFAULT_ERROR_RULES` constant that the live subclasses spread (never an
- * inlined copy, so this catalog cannot drift from that table independently).
- * See plan-05/progress.md Ruling R4 for the full rationale.
+ * The entries themselves are derived from the JSON catalog
+ * (src/lib/providers/catalog/<id>.json) via buildCatalogEntries() — that
+ * JSON is now the single source of truth for these 9 providers' identity,
+ * models, error rules and wire config. See
+ * src/lib/providers/catalog/loader.ts for the derivation logic and
+ * docs/superpowers/plans/2026-08-28-provider-json-catalog-spec.md for the
+ * authoring format.
  *
- * To add a new zero-quirk OpenAI-compatible provider: add one entry here.
- * Do NOT add a provider here if it needs any hook override beyond the 3
- * mandatory ones (getProviderName/getDefaultModel/formatProviderError) —
- * write a dedicated subclass instead (see deepseek.ts, azureOpenai.ts, and
- * Task 14's docs task for the deciding criteria).
+ * To add a new zero-quirk OpenAI-compatible provider: add one JSON file
+ * under src/lib/providers/catalog/ (see provider-catalog.schema.json) and
+ * run `pnpm run codegen:catalog`. Do NOT add a provider here if it needs
+ * any hook override beyond the 3 mandatory ones
+ * (getProviderName/getDefaultModel/formatProviderError) — write a
+ * dedicated subclass instead (see deepseek.ts, azureOpenai.ts).
  */
 export declare const OPENAI_COMPAT_CATALOG: readonly OpenAICompatCatalogEntry[];