@warlock.js/ai-xai 4.6.0

package/esm/known-models.mjs

@@ -0,0 +1,96 @@
+//#region ../@warlock.js/ai-xai/src/known-models.ts
+/**
+* Capability inference for xAI Grok model ids.
+*
+* xAI speaks the OpenAI Chat Completions protocol, so the wire-level
+* adapter is `OpenAISDK`. But Grok model names (`grok-4`,
+* `grok-2-vision`, …) don't match OpenAI's `gpt-*` / `o*` prefixes, so
+* OpenAI's own inference lists would mis-classify every Grok model as
+* non-vision / non-reasoning. This module supplies xAI's OWN name lists
+* and the `XaiSDK` wrapper injects the resulting capability flags into
+* each `OpenAIModelConfig` before delegating, so the right capabilities
+* are set even though the names aren't OpenAI names.
+*
+* All lists are matched as a prefix so dated / `-latest` / `-fast`
+* variants (`grok-4-0709`, `grok-2-vision-latest`,
+* `grok-3-mini-beta`) are covered without enumerating every release
+* tag. Devs can always override per-model via
+* `xai.model({ name, vision: true | false, reasoning: true | false })`
+* — explicit config wins over inference in either direction.
+*/
+/**
+* Model-name prefixes for Grok families that accept image input
+* (vision) on the OpenAI-compatible Chat Completions endpoint.
+*
+* - `grok-4` is natively multimodal (text + image input).
+* - `grok-2-vision` is the dedicated image-understanding Grok 2 model.
+*
+* Text-only families (`grok-3`, `grok-3-mini`, the base `grok-2`
+* text model) are intentionally excluded so passing an image
+* attachment to them surfaces a clear, agent-side capability error
+* rather than an opaque xAI 400.
+*/
+const XAI_VISION_MODEL_PREFIXES = ["grok-4", "grok-2-vision"];
+/**
+* Model-name prefixes for Grok families that expose internal reasoning
+* and accept reasoning controls (e.g. `reasoning_effort`) on the
+* OpenAI-compatible Chat Completions endpoint.
+*
+* - `grok-4` is a reasoning-first model (it always reasons).
+* - `grok-3-mini` is the "think" variant of Grok 3 and reasons; the
+*   full-size `grok-3` does not, so it is deliberately NOT covered by
+*   the `grok-3-mini` prefix.
+*/
+const XAI_REASONING_MODEL_PREFIXES = ["grok-4", "grok-3-mini"];
+/**
+* A convenience list of the current public Grok chat model ids, handy
+* for menus, validation, and docs. Not exhaustive of every dated alias
+* xAI publishes — pass any id through `xai.model({ name })`; the prefix
+* inference above handles dated / `-latest` variants.
+*
+* @example
+* XAI_CHAT_MODELS.includes("grok-4");          // → true
+*/
+const XAI_CHAT_MODELS = [
+	"grok-4",
+	"grok-3",
+	"grok-3-mini",
+	"grok-2-vision",
+	"grok-2"
+];
+/**
+* Infer whether a given Grok model id supports vision based on xAI's
+* known-prefix list. Unknown ids default to `false` so that passing an
+* image attachment to an unsupported model surfaces a clear,
+* agent-side capability error instead of an opaque xAI 400.
+*
+* @example
+* inferVisionCapability("grok-4");                 // → true
+* inferVisionCapability("grok-2-vision-latest");   // → true
+* inferVisionCapability("grok-3");                 // → false
+* inferVisionCapability("grok-3-mini");            // → false
+*/
+function inferVisionCapability(modelId) {
+	const normalized = modelId.toLowerCase();
+	return XAI_VISION_MODEL_PREFIXES.some((prefix) => normalized.startsWith(prefix));
+}
+/**
+* Infer whether a given Grok model id is a reasoning model based on
+* xAI's known-prefix list. Unknown ids default to `false` so the
+* adapter never forwards an unsupported reasoning param to a
+* non-reasoning model.
+*
+* @example
+* inferReasoningCapability("grok-4");          // → true
+* inferReasoningCapability("grok-3-mini");     // → true
+* inferReasoningCapability("grok-3");          // → false
+* inferReasoningCapability("grok-2-vision");   // → false
+*/
+function inferReasoningCapability(modelId) {
+	const normalized = modelId.toLowerCase();
+	return XAI_REASONING_MODEL_PREFIXES.some((prefix) => normalized.startsWith(prefix));
+}
+
+//#endregion
+export { XAI_CHAT_MODELS, XAI_REASONING_MODEL_PREFIXES, XAI_VISION_MODEL_PREFIXES, inferReasoningCapability, inferVisionCapability };
+//# sourceMappingURL=known-models.mjs.map

package/esm/known-models.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"known-models.mjs","names":[],"sources":["../../../../../../@warlock.js/ai-xai/src/known-models.ts"],"sourcesContent":["/**\n * Capability inference for xAI Grok model ids.\n *\n * xAI speaks the OpenAI Chat Completions protocol, so the wire-level\n * adapter is `OpenAISDK`. But Grok model names (`grok-4`,\n * `grok-2-vision`, …) don't match OpenAI's `gpt-*` / `o*` prefixes, so\n * OpenAI's own inference lists would mis-classify every Grok model as\n * non-vision / non-reasoning. This module supplies xAI's OWN name lists\n * and the `XaiSDK` wrapper injects the resulting capability flags into\n * each `OpenAIModelConfig` before delegating, so the right capabilities\n * are set even though the names aren't OpenAI names.\n *\n * All lists are matched as a prefix so dated / `-latest` / `-fast`\n * variants (`grok-4-0709`, `grok-2-vision-latest`,\n * `grok-3-mini-beta`) are covered without enumerating every release\n * tag. Devs can always override per-model via\n * `xai.model({ name, vision: true | false, reasoning: true | false })`\n * — explicit config wins over inference in either direction.\n */\n\n/**\n * Model-name prefixes for Grok families that accept image input\n * (vision) on the OpenAI-compatible Chat Completions endpoint.\n *\n * - `grok-4` is natively multimodal (text + image input).\n * - `grok-2-vision` is the dedicated image-understanding Grok 2 model.\n *\n * Text-only families (`grok-3`, `grok-3-mini`, the base `grok-2`\n * text model) are intentionally excluded so passing an image\n * attachment to them surfaces a clear, agent-side capability error\n * rather than an opaque xAI 400.\n */\nexport const XAI_VISION_MODEL_PREFIXES = [\"grok-4\", \"grok-2-vision\"] as const;\n\n/**\n * Model-name prefixes for Grok families that expose internal reasoning\n * and accept reasoning controls (e.g. `reasoning_effort`) on the\n * OpenAI-compatible Chat Completions endpoint.\n *\n * - `grok-4` is a reasoning-first model (it always reasons).\n * - `grok-3-mini` is the \"think\" variant of Grok 3 and reasons; the\n *   full-size `grok-3` does not, so it is deliberately NOT covered by\n *   the `grok-3-mini` prefix.\n */\nexport const XAI_REASONING_MODEL_PREFIXES = [\"grok-4\", \"grok-3-mini\"] as const;\n\n/**\n * A convenience list of the current public Grok chat model ids, handy\n * for menus, validation, and docs. Not exhaustive of every dated alias\n * xAI publishes — pass any id through `xai.model({ name })`; the prefix\n * inference above handles dated / `-latest` variants.\n *\n * @example\n * XAI_CHAT_MODELS.includes(\"grok-4\");          // → true\n */\nexport const XAI_CHAT_MODELS = [\n  \"grok-4\",\n  \"grok-3\",\n  \"grok-3-mini\",\n  \"grok-2-vision\",\n  \"grok-2\",\n] as const;\n\n/**\n * Infer whether a given Grok model id supports vision based on xAI's\n * known-prefix list. Unknown ids default to `false` so that passing an\n * image attachment to an unsupported model surfaces a clear,\n * agent-side capability error instead of an opaque xAI 400.\n *\n * @example\n * inferVisionCapability(\"grok-4\");                 // → true\n * inferVisionCapability(\"grok-2-vision-latest\");   // → true\n * inferVisionCapability(\"grok-3\");                 // → false\n * inferVisionCapability(\"grok-3-mini\");            // → false\n */\nexport function inferVisionCapability(modelId: string): boolean {\n  const normalized = modelId.toLowerCase();\n\n  return XAI_VISION_MODEL_PREFIXES.some((prefix) => normalized.startsWith(prefix));\n}\n\n/**\n * Infer whether a given Grok model id is a reasoning model based on\n * xAI's known-prefix list. Unknown ids default to `false` so the\n * adapter never forwards an unsupported reasoning param to a\n * non-reasoning model.\n *\n * @example\n * inferReasoningCapability(\"grok-4\");          // → true\n * inferReasoningCapability(\"grok-3-mini\");     // → true\n * inferReasoningCapability(\"grok-3\");          // → false\n * inferReasoningCapability(\"grok-2-vision\");   // → false\n */\nexport function inferReasoningCapability(modelId: string): boolean {\n  const normalized = modelId.toLowerCase();\n\n  return XAI_REASONING_MODEL_PREFIXES.some((prefix) => normalized.startsWith(prefix));\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,MAAa,4BAA4B,CAAC,UAAU,eAAe;;;;;;;;;;;AAYnE,MAAa,+BAA+B,CAAC,UAAU,aAAa;;;;;;;;;;AAWpE,MAAa,kBAAkB;CAC7B;CACA;CACA;CACA;CACA;AACF;;;;;;;;;;;;;AAcA,SAAgB,sBAAsB,SAA0B;CAC9D,MAAM,aAAa,QAAQ,YAAY;CAEvC,OAAO,0BAA0B,MAAM,WAAW,WAAW,WAAW,MAAM,CAAC;AACjF;;;;;;;;;;;;;AAcA,SAAgB,yBAAyB,SAA0B;CACjE,MAAM,aAAa,QAAQ,YAAY;CAEvC,OAAO,6BAA6B,MAAM,WAAW,WAAW,WAAW,MAAM,CAAC;AACpF"}

package/esm/sdk.d.mts

@@ -0,0 +1,108 @@
+import { XaiEmbedderConfig, XaiImageConfig, XaiModelConfig, XaiSDKConfig } from "./config.type.mjs";
+import { EmbedderContract, ImageModelContract, ModelContract, SDKAdapterContract } from "@warlock.js/ai";
+
+//#region ../@warlock.js/ai-xai/src/sdk.d.ts
+/**
+ * xAI Grok-backed implementation of `SDKAdapterContract`.
+ *
+ * **Role.** The package entry point for xAI's Grok models. xAI speaks
+ * the OpenAI Chat Completions protocol, so `XaiSDK` is a *thin wrapper*
+ * over the already-battle-tested {@link OpenAISDK} from
+ * `@warlock.js/ai-openai` — NOT a reimplementation. It constructs one
+ * internal `OpenAISDK` pointed at xAI's `baseURL` and labeled
+ * `provider: "xai"`, then delegates `model()` / `embedder()` /
+ * `image()` / `count()` to it. Construct one SDK per account and reuse
+ * it everywhere.
+ *
+ * **Responsibility.**
+ * - Owns: the xAI defaults (`baseURL` → `https://api.x.ai/v1`,
+ *   `provider` → `"xai"`) and this provider's OWN capability inference.
+ *   Grok model names (`grok-4`, `grok-2-vision`, …) don't match
+ *   OpenAI's `gpt-*` / `o*` prefixes, so before delegating `model()`
+ *   the wrapper injects the `vision` / `reasoning` flags inferred from
+ *   xAI's name lists (see `known-models.ts`). Because explicit config
+ *   wins over OpenAI's inference inside `OpenAIModel`, the produced
+ *   `ModelContract` carries the correct Grok capabilities.
+ * - Does NOT own: the wire protocol, request/response mapping,
+ *   streaming, tool-call accumulation, error wrapping, or pricing
+ *   resolution — all of that is the wrapped `OpenAISDK`'s job and is
+ *   reused verbatim.
+ *
+ * Modeled as a class (see §4.2 of code-style.md — "long-lived state
+ * across many calls"): it holds one live `OpenAISDK` (which in turn
+ * holds one live `OpenAI` client), fronted by FP usage like the other
+ * adapters.
+ *
+ * @example
+ * const xai = new XaiSDK({ apiKey: process.env.XAI_API_KEY! });
+ * const model = xai.model({ name: "grok-4", temperature: 0.7 });
+ * const myAgent = ai.agent({ model });
+ *
+ * @example
+ * // Compose into an `ai.xai` namespace for ergonomic agent wiring.
+ * const ai = { agent, tool, systemPrompt, xai: new XaiSDK({ apiKey }) };
+ * const fast = ai.agent({ model: ai.xai.model({ name: "grok-3-mini" }) });
+ */
+declare class XaiSDK implements SDKAdapterContract {
+  /**
+   * The wrapped OpenAI-compatible adapter doing the actual wire work.
+   * Constructed once with xAI's `baseURL` + `provider` and the caller's
+   * `apiKey` / client options, then reused for every produced model,
+   * embedder, and image model.
+   */
+  private readonly openai;
+  /**
+   * Optional SDK-level pricing registry, kept so `model()` can resolve
+   * a per-model entry while still applying this provider's default
+   * capability inference. The wrapped `OpenAISDK` also resolves
+   * pricing, but we surface it here for parity and to keep the default
+   * baseURL/provider injection in one place.
+   */
+  private readonly pricing?;
+  constructor(config: XaiSDKConfig);
+  /**
+   * Build a `ModelContract` for a Grok model. Delegates to the wrapped
+   * `OpenAISDK.model()` after injecting this provider's OWN capability
+   * inference: `vision` and `reasoning` are resolved from xAI's
+   * name-prefix lists (see `known-models.ts`) unless the caller set them
+   * explicitly. Because explicit config wins over OpenAI's inference
+   * inside `OpenAIModel`, the returned model self-identifies as
+   * `provider: "xai"` and carries Grok's real capabilities even though
+   * the model name isn't an OpenAI name.
+   *
+   * Pricing resolution is left to the wrapped adapter: per-model
+   * `config.pricing` wins, otherwise the SDK-level registry entry keyed
+   * by `config.name`, otherwise `undefined` (no cost computed).
+   *
+   * @example
+   * xai.model({ name: "grok-4" });        // vision + reasoning auto-true
+   * xai.model({ name: "grok-3-mini" });   // reasoning auto-true, vision false
+   */
+  model(config: XaiModelConfig): ModelContract;
+  /**
+   * Rough token-count estimate. Delegates straight to the wrapped
+   * `OpenAISDK.count()` (the shared character-heuristic from the core
+   * package — offline, good for budgeting/quota guards, not billing).
+   */
+  count(text: string, model?: string): Promise<number>;
+  /**
+   * Build an `EmbedderContract` by delegating to the wrapped
+   * `OpenAISDK.embedder()`.
+   *
+   * NOTE: xAI does not currently expose a public embeddings endpoint, so
+   * this is wired for protocol parity but a call to `embed()` /
+   * `embedMany()` will fail upstream. Point an embedder at a dedicated
+   * embeddings provider (e.g. `@warlock.js/ai-openai`) for vectors.
+   */
+  embedder(config: XaiEmbedderConfig): EmbedderContract;
+  /**
+   * Build an `ImageModelContract` by delegating to the wrapped
+   * `OpenAISDK.image()` for use with `ai.image({ model, prompt })`.
+   * Pricing resolution mirrors `model()` (per-model `pricing` > SDK
+   * registry > `undefined`).
+   */
+  image(config: XaiImageConfig): ImageModelContract;
+}
+//#endregion
+export { XaiSDK };
+//# sourceMappingURL=sdk.d.mts.map

package/esm/sdk.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.d.mts","names":[],"sources":["../../../../../../@warlock.js/ai-xai/src/sdk.ts"],"mappings":";;;;;;AAuEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0F0D;;cA1F7C,MAAA,YAAkB,kBAAA;;;;;;;mBAOZ,MAAA;;;;;;;;mBASA,OAAA;cAEE,MAAA,EAAQ,YAAA;;;;;;;;;;;;;;;;;;;EAiCpB,KAAA,CAAM,MAAA,EAAQ,cAAA,GAAiB,aAAA;;;;;;EAgBzB,KAAA,CAAM,IAAA,UAAc,KAAA,YAAiB,OAAA;;;;;;;;;;EAa3C,QAAA,CAAS,MAAA,EAAQ,iBAAA,GAAoB,gBAAA;;;;;;;EAUrC,KAAA,CAAM,MAAA,EAAQ,cAAA,GAAiB,kBAAA;AAAA"}

package/esm/sdk.mjs

@@ -0,0 +1,126 @@
+import { inferReasoningCapability, inferVisionCapability } from "./known-models.mjs";
+import { OpenAISDK } from "@warlock.js/ai-openai";
+
+//#region ../@warlock.js/ai-xai/src/sdk.ts
+/**
+* The xAI OpenAI-compatible base URL. xAI exposes Chat Completions at
+* `POST /v1/chat/completions` on this host, so the whole adapter rides
+* on the OpenAI wire protocol.
+*/
+const XAI_BASE_URL = "https://api.x.ai/v1";
+/**
+* The default `provider` label stamped on every model this SDK
+* produces. Surfaces on `ModelContract.provider`, `AgentReport.model`,
+* logs, and any provider-aware middleware.
+*/
+const XAI_PROVIDER = "xai";
+/**
+* xAI Grok-backed implementation of `SDKAdapterContract`.
+*
+* **Role.** The package entry point for xAI's Grok models. xAI speaks
+* the OpenAI Chat Completions protocol, so `XaiSDK` is a *thin wrapper*
+* over the already-battle-tested {@link OpenAISDK} from
+* `@warlock.js/ai-openai` — NOT a reimplementation. It constructs one
+* internal `OpenAISDK` pointed at xAI's `baseURL` and labeled
+* `provider: "xai"`, then delegates `model()` / `embedder()` /
+* `image()` / `count()` to it. Construct one SDK per account and reuse
+* it everywhere.
+*
+* **Responsibility.**
+* - Owns: the xAI defaults (`baseURL` → `https://api.x.ai/v1`,
+*   `provider` → `"xai"`) and this provider's OWN capability inference.
+*   Grok model names (`grok-4`, `grok-2-vision`, …) don't match
+*   OpenAI's `gpt-*` / `o*` prefixes, so before delegating `model()`
+*   the wrapper injects the `vision` / `reasoning` flags inferred from
+*   xAI's name lists (see `known-models.ts`). Because explicit config
+*   wins over OpenAI's inference inside `OpenAIModel`, the produced
+*   `ModelContract` carries the correct Grok capabilities.
+* - Does NOT own: the wire protocol, request/response mapping,
+*   streaming, tool-call accumulation, error wrapping, or pricing
+*   resolution — all of that is the wrapped `OpenAISDK`'s job and is
+*   reused verbatim.
+*
+* Modeled as a class (see §4.2 of code-style.md — "long-lived state
+* across many calls"): it holds one live `OpenAISDK` (which in turn
+* holds one live `OpenAI` client), fronted by FP usage like the other
+* adapters.
+*
+* @example
+* const xai = new XaiSDK({ apiKey: process.env.XAI_API_KEY! });
+* const model = xai.model({ name: "grok-4", temperature: 0.7 });
+* const myAgent = ai.agent({ model });
+*
+* @example
+* // Compose into an `ai.xai` namespace for ergonomic agent wiring.
+* const ai = { agent, tool, systemPrompt, xai: new XaiSDK({ apiKey }) };
+* const fast = ai.agent({ model: ai.xai.model({ name: "grok-3-mini" }) });
+*/
+var XaiSDK = class {
+	constructor(config) {
+		const { baseURL, provider, ...rest } = config;
+		this.openai = new OpenAISDK({
+			...rest,
+			baseURL: baseURL ?? XAI_BASE_URL,
+			provider: provider ?? XAI_PROVIDER
+		});
+		this.pricing = config.pricing;
+	}
+	/**
+	* Build a `ModelContract` for a Grok model. Delegates to the wrapped
+	* `OpenAISDK.model()` after injecting this provider's OWN capability
+	* inference: `vision` and `reasoning` are resolved from xAI's
+	* name-prefix lists (see `known-models.ts`) unless the caller set them
+	* explicitly. Because explicit config wins over OpenAI's inference
+	* inside `OpenAIModel`, the returned model self-identifies as
+	* `provider: "xai"` and carries Grok's real capabilities even though
+	* the model name isn't an OpenAI name.
+	*
+	* Pricing resolution is left to the wrapped adapter: per-model
+	* `config.pricing` wins, otherwise the SDK-level registry entry keyed
+	* by `config.name`, otherwise `undefined` (no cost computed).
+	*
+	* @example
+	* xai.model({ name: "grok-4" });        // vision + reasoning auto-true
+	* xai.model({ name: "grok-3-mini" });   // reasoning auto-true, vision false
+	*/
+	model(config) {
+		return this.openai.model({
+			...config,
+			vision: config.vision ?? inferVisionCapability(config.name),
+			reasoning: config.reasoning ?? inferReasoningCapability(config.name)
+		});
+	}
+	/**
+	* Rough token-count estimate. Delegates straight to the wrapped
+	* `OpenAISDK.count()` (the shared character-heuristic from the core
+	* package — offline, good for budgeting/quota guards, not billing).
+	*/
+	async count(text, model) {
+		return this.openai.count(text, model);
+	}
+	/**
+	* Build an `EmbedderContract` by delegating to the wrapped
+	* `OpenAISDK.embedder()`.
+	*
+	* NOTE: xAI does not currently expose a public embeddings endpoint, so
+	* this is wired for protocol parity but a call to `embed()` /
+	* `embedMany()` will fail upstream. Point an embedder at a dedicated
+	* embeddings provider (e.g. `@warlock.js/ai-openai`) for vectors.
+	*/
+	embedder(config) {
+		return this.openai.embedder(config);
+	}
+	/**
+	* Build an `ImageModelContract` by delegating to the wrapped
+	* `OpenAISDK.image()` for use with `ai.image({ model, prompt })`.
+	* Pricing resolution mirrors `model()` (per-model `pricing` > SDK
+	* registry > `undefined`).
+	*/
+	image(config) {
+		return this.openai.image(config);
+	}
+};
+
+//#endregion
+export { XaiSDK };
+//# sourceMappingURL=sdk.mjs.map

package/esm/sdk.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.mjs","names":[],"sources":["../../../../../../@warlock.js/ai-xai/src/sdk.ts"],"sourcesContent":["import type {\n  EmbedderContract,\n  ImageModelContract,\n  ModelContract,\n  ModelPricing,\n  SDKAdapterContract,\n} from \"@warlock.js/ai\";\nimport { OpenAISDK } from \"@warlock.js/ai-openai\";\nimport type {\n  XaiEmbedderConfig,\n  XaiImageConfig,\n  XaiModelConfig,\n  XaiSDKConfig,\n} from \"./config.type\";\nimport { inferReasoningCapability, inferVisionCapability } from \"./known-models\";\n\n/**\n * The xAI OpenAI-compatible base URL. xAI exposes Chat Completions at\n * `POST /v1/chat/completions` on this host, so the whole adapter rides\n * on the OpenAI wire protocol.\n */\nconst XAI_BASE_URL = \"https://api.x.ai/v1\";\n\n/**\n * The default `provider` label stamped on every model this SDK\n * produces. Surfaces on `ModelContract.provider`, `AgentReport.model`,\n * logs, and any provider-aware middleware.\n */\nconst XAI_PROVIDER = \"xai\";\n\n/**\n * xAI Grok-backed implementation of `SDKAdapterContract`.\n *\n * **Role.** The package entry point for xAI's Grok models. xAI speaks\n * the OpenAI Chat Completions protocol, so `XaiSDK` is a *thin wrapper*\n * over the already-battle-tested {@link OpenAISDK} from\n * `@warlock.js/ai-openai` — NOT a reimplementation. It constructs one\n * internal `OpenAISDK` pointed at xAI's `baseURL` and labeled\n * `provider: \"xai\"`, then delegates `model()` / `embedder()` /\n * `image()` / `count()` to it. Construct one SDK per account and reuse\n * it everywhere.\n *\n * **Responsibility.**\n * - Owns: the xAI defaults (`baseURL` → `https://api.x.ai/v1`,\n *   `provider` → `\"xai\"`) and this provider's OWN capability inference.\n *   Grok model names (`grok-4`, `grok-2-vision`, …) don't match\n *   OpenAI's `gpt-*` / `o*` prefixes, so before delegating `model()`\n *   the wrapper injects the `vision` / `reasoning` flags inferred from\n *   xAI's name lists (see `known-models.ts`). Because explicit config\n *   wins over OpenAI's inference inside `OpenAIModel`, the produced\n *   `ModelContract` carries the correct Grok capabilities.\n * - Does NOT own: the wire protocol, request/response mapping,\n *   streaming, tool-call accumulation, error wrapping, or pricing\n *   resolution — all of that is the wrapped `OpenAISDK`'s job and is\n *   reused verbatim.\n *\n * Modeled as a class (see §4.2 of code-style.md — \"long-lived state\n * across many calls\"): it holds one live `OpenAISDK` (which in turn\n * holds one live `OpenAI` client), fronted by FP usage like the other\n * adapters.\n *\n * @example\n * const xai = new XaiSDK({ apiKey: process.env.XAI_API_KEY! });\n * const model = xai.model({ name: \"grok-4\", temperature: 0.7 });\n * const myAgent = ai.agent({ model });\n *\n * @example\n * // Compose into an `ai.xai` namespace for ergonomic agent wiring.\n * const ai = { agent, tool, systemPrompt, xai: new XaiSDK({ apiKey }) };\n * const fast = ai.agent({ model: ai.xai.model({ name: \"grok-3-mini\" }) });\n */\nexport class XaiSDK implements SDKAdapterContract {\n  /**\n   * The wrapped OpenAI-compatible adapter doing the actual wire work.\n   * Constructed once with xAI's `baseURL` + `provider` and the caller's\n   * `apiKey` / client options, then reused for every produced model,\n   * embedder, and image model.\n   */\n  private readonly openai: OpenAISDK;\n\n  /**\n   * Optional SDK-level pricing registry, kept so `model()` can resolve\n   * a per-model entry while still applying this provider's default\n   * capability inference. The wrapped `OpenAISDK` also resolves\n   * pricing, but we surface it here for parity and to keep the default\n   * baseURL/provider injection in one place.\n   */\n  private readonly pricing?: Record<string, ModelPricing>;\n\n  public constructor(config: XaiSDKConfig) {\n    const { baseURL, provider, ...rest } = config;\n\n    // Inject xAI's defaults — `baseURL` → the xAI OpenAI-compatible\n    // endpoint, `provider` → \"xai\" — while still letting the caller\n    // override either (e.g. a corporate proxy or a relabeled gateway).\n    this.openai = new OpenAISDK({\n      ...rest,\n      baseURL: baseURL ?? XAI_BASE_URL,\n      provider: provider ?? XAI_PROVIDER,\n    });\n\n    this.pricing = config.pricing;\n  }\n\n  /**\n   * Build a `ModelContract` for a Grok model. Delegates to the wrapped\n   * `OpenAISDK.model()` after injecting this provider's OWN capability\n   * inference: `vision` and `reasoning` are resolved from xAI's\n   * name-prefix lists (see `known-models.ts`) unless the caller set them\n   * explicitly. Because explicit config wins over OpenAI's inference\n   * inside `OpenAIModel`, the returned model self-identifies as\n   * `provider: \"xai\"` and carries Grok's real capabilities even though\n   * the model name isn't an OpenAI name.\n   *\n   * Pricing resolution is left to the wrapped adapter: per-model\n   * `config.pricing` wins, otherwise the SDK-level registry entry keyed\n   * by `config.name`, otherwise `undefined` (no cost computed).\n   *\n   * @example\n   * xai.model({ name: \"grok-4\" });        // vision + reasoning auto-true\n   * xai.model({ name: \"grok-3-mini\" });   // reasoning auto-true, vision false\n   */\n  public model(config: XaiModelConfig): ModelContract {\n    return this.openai.model({\n      ...config,\n      // xAI names don't match OpenAI's vision/reasoning prefixes, so we\n      // resolve them here and pass explicit flags through — explicit\n      // config always wins over the OpenAI adapter's own inference.\n      vision: config.vision ?? inferVisionCapability(config.name),\n      reasoning: config.reasoning ?? inferReasoningCapability(config.name),\n    });\n  }\n\n  /**\n   * Rough token-count estimate. Delegates straight to the wrapped\n   * `OpenAISDK.count()` (the shared character-heuristic from the core\n   * package — offline, good for budgeting/quota guards, not billing).\n   */\n  public async count(text: string, model?: string): Promise<number> {\n    return this.openai.count(text, model);\n  }\n\n  /**\n   * Build an `EmbedderContract` by delegating to the wrapped\n   * `OpenAISDK.embedder()`.\n   *\n   * NOTE: xAI does not currently expose a public embeddings endpoint, so\n   * this is wired for protocol parity but a call to `embed()` /\n   * `embedMany()` will fail upstream. Point an embedder at a dedicated\n   * embeddings provider (e.g. `@warlock.js/ai-openai`) for vectors.\n   */\n  public embedder(config: XaiEmbedderConfig): EmbedderContract {\n    return this.openai.embedder(config);\n  }\n\n  /**\n   * Build an `ImageModelContract` by delegating to the wrapped\n   * `OpenAISDK.image()` for use with `ai.image({ model, prompt })`.\n   * Pricing resolution mirrors `model()` (per-model `pricing` > SDK\n   * registry > `undefined`).\n   */\n  public image(config: XaiImageConfig): ImageModelContract {\n    return this.openai.image(config);\n  }\n}\n"],"mappings":";;;;;;;;;AAqBA,MAAM,eAAe;;;;;;AAOrB,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CrB,IAAa,SAAb,MAAkD;CAkBhD,AAAO,YAAY,QAAsB;EACvC,MAAM,EAAE,SAAS,UAAU,GAAG,SAAS;EAKvC,KAAK,SAAS,IAAI,UAAU;GAC1B,GAAG;GACH,SAAS,WAAW;GACpB,UAAU,YAAY;EACxB,CAAC;EAED,KAAK,UAAU,OAAO;CACxB;;;;;;;;;;;;;;;;;;;CAoBA,AAAO,MAAM,QAAuC;EAClD,OAAO,KAAK,OAAO,MAAM;GACvB,GAAG;GAIH,QAAQ,OAAO,UAAU,sBAAsB,OAAO,IAAI;GAC1D,WAAW,OAAO,aAAa,yBAAyB,OAAO,IAAI;EACrE,CAAC;CACH;;;;;;CAOA,MAAa,MAAM,MAAc,OAAiC;EAChE,OAAO,KAAK,OAAO,MAAM,MAAM,KAAK;CACtC;;;;;;;;;;CAWA,AAAO,SAAS,QAA6C;EAC3D,OAAO,KAAK,OAAO,SAAS,MAAM;CACpC;;;;;;;CAQA,AAAO,MAAM,QAA4C;EACvD,OAAO,KAAK,OAAO,MAAM,MAAM;CACjC;AACF"}

package/llms-full.txt

@@ -0,0 +1,128 @@
+# Warlock AI Xai — full skills
+
+> Package: `@warlock.js/ai-xai`
+
+> Generated artifact. Concatenates every SKILL.md and reference file under `@warlock.js/ai-xai/skills/`. Re-run `node scripts/generate-llms.mjs` after any change.
+
+## setup-xai  `@warlock.js/ai-xai/setup-xai/SKILL.md`
+
+---
+name: setup-xai
+description: 'Wire @warlock.js/ai-xai — new XaiSDK({apiKey, baseURL?, provider?, pricing?}) for xAI Grok, .model({name, vision?, reasoning?, structuredOutput?}) for a ModelContract, .embedder({name, dimensions?}) and .image({name, pricing?}) delegated to the OpenAI-compatible adapter. Thin wrapper over OpenAISDK: uses the xAI OpenAI-compatible endpoint (https://api.x.ai/v1) and injects xAI''s own vision/reasoning inference so Grok names resolve to the right capabilities. Triggers: `XaiSDK`, `grok`, `grok-4`, `grok-3`, `grok-3-mini`, `grok-2-vision`, `.model`, `x.ai`, `api.x.ai`, `XAI_API_KEY`, `reasoning_effort` on Grok, "wire xai/grok into a warlock agent", "configure grok-4", "use grok reasoning effort", "send an image to grok-4 / grok-2-vision"; typical import `import { XaiSDK } from "@warlock.js/ai-xai"`. Skip: agent wiring — `@warlock.js/ai/run-ai-agent/SKILL.md`; the underlying OpenAI-compatible adapter and its full capability/streaming/error surface — `@warlock.js/ai-openai/skills/setup-openai/SKILL.md`; adapter comparison — `@warlock.js/ai/pick-ai-provider/SKILL.md`; competing adapters `@warlock.js/ai-anthropic`, `@warlock.js/ai-google`, `@warlock.js/ai-ollama`; raw `openai` SDK pointed at x.ai by hand.'
+---
+
+# `@warlock.js/ai-xai`
+
+Provider adapter for xAI's **Grok** models. xAI speaks the OpenAI Chat Completions protocol, so `XaiSDK` is a **thin wrapper** over [`OpenAISDK`](../../../ai-openai/skills/setup-openai/SKILL.md) — it does not reimplement the wire layer. It constructs one internal `OpenAISDK` pointed at xAI's `baseURL` and labeled `provider: "xai"`, then delegates `model()` / `embedder()` / `image()` / `count()`, injecting xAI's own capability inference so Grok model names resolve correctly. Pair with `@warlock.js/ai` for the agent / tool / system-prompt surface.
+
+## Construction
+
+```ts
+import { XaiSDK } from "@warlock.js/ai-xai";
+
+const xai = new XaiSDK({ apiKey: process.env.XAI_API_KEY! });
+```
+
+- `baseURL` defaults to `https://api.x.ai/v1` (the xAI OpenAI-compatible endpoint). Override only to target a proxy/gateway.
+- `provider` defaults to `"xai"` — flows through to `ModelContract.provider`, `AgentReport.model.provider`, and logs. Set it to relabel a gateway upstream.
+- Every other upstream `ClientOptions` value (`timeout`, `maxRetries`, `defaultHeaders`, `fetch`, …) is forwarded verbatim to the wrapped client.
+
+`XaiSDK` is a class (not a factory) — it holds a long-lived wrapped `OpenAISDK` (which holds a long-lived `OpenAI` client). Construct one per account and reuse it.
+
+## Producing a model
+
+```ts
+xai.model({ name: "grok-4" })                       // vision + reasoning auto-true
+xai.model({ name: "grok-3-mini" })                  // reasoning auto-true, vision false
+xai.model({ name: "grok-2-vision" })                // vision auto-true
+xai.model({ name: "grok-4", temperature: 0.2 })     // sampling controls
+xai.model({ name: "grok-3", vision: true })         // explicit capability override
+```
+
+Returns a `ModelContract` you pass straight into `ai.agent({ model })`.
+
+## Models & capabilities — what's auto-set
+
+This adapter ships xAI's OWN name lists (Grok ids don't match OpenAI's `gpt-*` / `o*` prefixes). Capabilities are injected per model before delegating; an explicit value always wins over inference.
+
+| Model | `vision` | `reasoning` |
+| --- | --- | --- |
+| `grok-4` | true | true (reasoning-first) |
+| `grok-3` | false | false |
+| `grok-3-mini` | false | true (the "think" variant) |
+| `grok-2-vision` | true | false |
+| `grok-2` | false | false |
+
+- `vision` — inferred `true` for the `grok-4` and `grok-2-vision` prefixes; `false` otherwise.
+- `reasoning` — inferred `true` for `grok-4` and `grok-3-mini`; drives whether `reasoning.effort` is forwarded as `reasoning_effort` on the wire.
+- `structuredOutput` / `promptCaching` and the image/PDF/audio wire mapping all come from the wrapped OpenAI adapter unchanged — see [`setup-openai`](../../../ai-openai/skills/setup-openai/SKILL.md).
+
+**Override `vision`, `reasoning`, or `structuredOutput` explicitly** via `.model({ name, vision?, reasoning?, structuredOutput? })`.
+
+> Model availability changes over time — pass any current Grok id through `.model({ name })`; the prefix inference covers dated / `-latest` / `-fast` / `-beta` variants. Don't assume a model exists; check xAI's docs.
+
+## Reasoning (grok-4 / grok-3-mini)
+
+```ts
+const model = xai.model({ name: "grok-4" });   // reasoning auto-true
+await model.complete(messages, { reasoning: { effort: "high" } });  // → reasoning_effort: "high"
+```
+
+`reasoning.effort` (`"low" | "medium" | "high"`) maps verbatim to the OpenAI-compatible `reasoning_effort` param. When `capabilities.reasoning` is `false` (e.g. `grok-3`), the option is dropped — the adapter never forwards it. Pin `reasoning: true` to force it for a custom/gateway id.
+
+## Multipart messages (image input)
+
+Image attachments reach the wire only on a vision-capable model (`grok-4`, `grok-2-vision`); the agent's modality gate throws otherwise. Mapping to OpenAI `image_url` parts is identical to the OpenAI adapter — see [`setup-openai`](../../../ai-openai/skills/setup-openai/SKILL.md).
+
+## Uses the OpenAI-compatible endpoint
+
+All wire work — request/response mapping, streaming, tool-call accumulation, structured output, usage extraction — is the wrapped `OpenAISDK`'s, unchanged. The wrapper only: (1) sets the xAI `baseURL` + `provider` defaults, and (2) injects xAI's vision/reasoning inference per model. For streaming, structured output, and the full multipart surface, read [`@warlock.js/ai-openai/skills/setup-openai/SKILL.md`](../../../ai-openai/skills/setup-openai/SKILL.md).
+
+## Embeddings — not available on xAI
+
+```ts
+xai.embedder({ name: "text-embedding-3-small" }); // delegates, but xAI has no embeddings API yet
+```
+
+xAI does **not** currently expose a public embeddings endpoint. `embedder()` is wired for protocol parity, but a call to `embed()` / `embedMany()` fails upstream. Point an embedder at a dedicated provider (e.g. `@warlock.js/ai-openai`) for vectors.
+
+## Image generation — delegated guard
+
+`image()` delegates to the wrapped OpenAI Images adapter, which only recognizes `gpt-image-*` / `dall-e-*` ids and rejects anything else at construction. xAI's image generation ("Grok Imagine") is a separate, non-OpenAI-Images-compatible surface, so use `@warlock.js/ai-openai`'s `image()` for OpenAI-Images generation.
+
+## Pricing — per-model registry
+
+`pricing` is a registry keyed by model name, rates in **USD per 1,000,000 tokens** (`ModelPricing`: `input`, `output`, optional `cachedInput` / `cachedOutput`). Resolution is delegated: per-model `pricing` > SDK registry > `undefined` (no cost computed).
+
+```ts
+const xai = new XaiSDK({
+  apiKey,
+  pricing: {
+    "grok-4":      { input: 3, output: 15 },
+    "grok-3-mini": { input: 0.3, output: 0.5 },
+  },
+});
+
+const { usage } = await ai.agent({ model: xai.model({ name: "grok-4" }) }).execute("hi");
+usage.cost; // per-channel USD breakdown of THIS run, or undefined when unpriced
+```
+
+> Pricing numbers above are illustrative placeholders — set the current xAI rates yourself.
+
+## Errors
+
+Raw xAI / OpenAI-SDK errors are wrapped into the typed `@warlock.js/ai` `AIError` hierarchy by the wrapped adapter's error wrapper (dispatch keys on `APIError.status + code`). See [`@warlock.js/ai/handle-ai-errors/SKILL.md`](@warlock.js/ai/handle-ai-errors/SKILL.md).
+
+## When NOT to use this skill
+
+- Direct calls to the `openai` SDK pointed at `api.x.ai` by hand — without going through `@warlock.js/ai` agents.
+- Non-Grok models — OpenAI: `@warlock.js/ai-openai`. Anthropic: `@warlock.js/ai-anthropic`. Gemini: `@warlock.js/ai-google`. Ollama: `@warlock.js/ai-ollama`.
+
+## See also
+
+- [`@warlock.js/ai-openai/skills/setup-openai/SKILL.md`](../../../ai-openai/skills/setup-openai/SKILL.md) — the wrapped adapter; full wire / streaming / structured-output / multipart surface
+- [`@warlock.js/ai/run-ai-agent/SKILL.md`](@warlock.js/ai/run-ai-agent/SKILL.md) — passing the model into `ai.agent({...})`
+- [`@warlock.js/ai/pick-ai-provider/SKILL.md`](@warlock.js/ai/pick-ai-provider/SKILL.md) — adapter comparison
+```
+
+

package/llms.txt

@@ -0,0 +1,9 @@
+# Warlock AI Xai
+
+> Package: `@warlock.js/ai-xai`
+
+> xAI Grok adapter for @warlock.js/ai
+
+## Skills
+
+- [setup-xai](@warlock.js/ai-xai/setup-xai/SKILL.md): Wire @warlock.js/ai-xai — new XaiSDK({apiKey, baseURL?, provider?, pricing?}) for xAI Grok, .model({name, vision?, reasoning?, structuredOutput?}) for a ModelContract, .embedder({name, dimensions?}) and .image({name, pricing?}) delegated to the OpenAI-compatible adapter. Thin wrapper over OpenAISDK: uses the xAI OpenAI-compatible endpoint (https://api.x.ai/v1) and injects xAI's own vision/reasoning inference so Grok names resolve to the right capabilities. Triggers: `XaiSDK`, `grok`, `grok-4`, `grok-3`, `grok-3-mini`, `grok-2-vision`, `.model`, `x.ai`, `api.x.ai`, `XAI_API_KEY`, `reasoning_effort` on Grok, "wire xai/grok into a warlock agent", "configure grok-4", "use grok reasoning effort", "send an image to grok-4 / grok-2-vision"; typical import `import { XaiSDK } from "@warlock.js/ai-xai"`. Skip: agent wiring — `@warlock.js/ai/run-ai-agent/SKILL.md`; the underlying OpenAI-compatible adapter and its full capability/streaming/error surface — `@warlock.js/ai-openai/skills/setup-openai/SKILL.md`; adapter comparison — `@warlock.js/ai/pick-ai-provider/SKILL.md`; competing adapters `@warlock.js/ai-anthropic`, `@warlock.js/ai-google`, `@warlock.js/ai-ollama`; raw `openai` SDK pointed at x.ai by hand.

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@warlock.js/ai-xai",
+  "description": "xAI Grok adapter for @warlock.js/ai",
+  "keywords": [
+    "warlock",
+    "ai",
+    "xai",
+    "grok"
+  ],
+  "author": "Hasan Zohdy",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/warlockjs/ai-xai"
+  },
+  "dependencies": {
+    "@warlock.js/ai-openai": "4.6.0",
+    "@warlock.js/logger": "4.6.0"
+  },
+  "peerDependencies": {
+    "@warlock.js/ai": "4.6.0"
+  },
+  "version": "4.6.0",
+  "main": "./cjs/index.cjs",
+  "module": "./esm/index.mjs",
+  "types": "./esm/index.d.mts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./esm/index.d.mts",
+        "default": "./esm/index.mjs"
+      },
+      "require": {
+        "types": "./esm/index.d.mts",
+        "default": "./cjs/index.cjs"
+      }
+    }
+  }
+}