@gitlab/gitlab-ai-provider 3.3.1 → 3.4.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 3.4.0 (2026-02-02)
+
+- Merge branch 'feat/ai-gateway-headers' into 'main' ([f2d4c79](https://gitlab.com/gitlab-org/editor-extensions/gitlab-ai-provider/commit/f2d4c79))
+- feat: add custom AI Gateway headers support ([2ef662d](https://gitlab.com/gitlab-org/editor-extensions/gitlab-ai-provider/commit/2ef662d))
+- chore: added models testing script ([85dd9ba](https://gitlab.com/gitlab-org/editor-extensions/gitlab-ai-provider/commit/85dd9ba))
+- chore: bump version to 3.3.1 to fix package-lock.json sync ([6e6e9e2](https://gitlab.com/gitlab-org/editor-extensions/gitlab-ai-provider/commit/6e6e9e2))
+
 ## 3.3.0 (2026-01-23)
 
 - feat: add GPT-5.2 model support (duo-chat-gpt-5-2) ([fba8c4c](https://gitlab.com/gitlab-org/editor-extensions/gitlab-ai-provider/commit/fba8c4c))

package/README.md

@@ -272,6 +272,33 @@ const gitlab = createGitLab({
 });
 ```
 
+### AI Gateway Headers
+
+Custom headers can be sent to GitLab's AI Gateway (Anthropic/OpenAI proxy) for traffic identification and routing. By default, the provider sends `User-Agent: gitlab-ai-provider/{version}`.
+
+```typescript
+// Provider-level headers (apply to all agentic models)
+const gitlab = createGitLab({
+  apiKey: process.env.GITLAB_TOKEN,
+  aiGatewayHeaders: {
+    'X-Custom-Routing': 'premium-tier',
+  },
+});
+
+// Model-level headers (override provider-level)
+const model = gitlab.agenticChat('duo-chat-opus-4-5', {
+  aiGatewayHeaders: {
+    'X-Request-Priority': 'high',
+  },
+});
+```
+
+**Header Precedence (lowest to highest):**
+
+1. Default headers (`User-Agent: gitlab-ai-provider/{version}`)
+2. Provider-level `aiGatewayHeaders`
+3. Model-level `aiGatewayHeaders`
+
 ## 🏗️ Architecture
 
 ### Core Components
@@ -374,7 +401,8 @@ interface GitLabProviderSettings {
   apiKey?: string; // PAT or OAuth access token
   refreshToken?: string; // OAuth refresh token
   name?: string; // Provider name prefix
-  headers?: Record<string, string>; // Custom headers
+  headers?: Record<string, string>; // Custom headers for GitLab API
+  aiGatewayHeaders?: Record<string, string>; // Custom headers for AI Gateway proxy
   fetch?: typeof fetch; // Custom fetch implementation
   aiGatewayUrl?: string; // AI Gateway URL (default: 'https://cloud.gitlab.com')
 }
@@ -394,6 +422,7 @@ interface GitLabAgenticOptions {
   providerModel?: string; // Override the backend model (e.g., 'claude-sonnet-4-5-20250929' or 'gpt-5.1-2025-11-13')
   maxTokens?: number; // Default: 8192
   featureFlags?: Record<string, boolean>; // GitLab feature flags
+  aiGatewayHeaders?: Record<string, string>; // Custom headers for AI Gateway proxy (per-model)
 }
 ```
 

package/dist/index.d.mts

@@ -34,6 +34,11 @@ interface GitLabAnthropicConfig {
      * @default 'https://cloud.gitlab.com'
      */
     aiGatewayUrl?: string;
+    /**
+     * Custom headers for AI Gateway Anthropic proxy requests.
+     * Merged with headers from direct_access token response.
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 /**
  * GitLab Anthropic Language Model
@@ -154,6 +159,12 @@ interface GitLabAgenticOptions {
      * Feature flags to pass to the GitLab API
      */
     featureFlags?: Record<string, boolean>;
+    /**
+     * Custom headers for AI Gateway requests (per-model override).
+     * These headers are sent to the Anthropic/OpenAI proxy endpoints.
+     * Merged with provider-level aiGatewayHeaders (model-level takes precedence).
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 interface GitLabProviderSettings {
     /**
@@ -200,6 +211,12 @@ interface GitLabProviderSettings {
      * @default 'https://cloud.gitlab.com'
      */
     aiGatewayUrl?: string;
+    /**
+     * Custom headers to include in AI Gateway requests (Anthropic/OpenAI proxy).
+     * These headers are merged with the default headers from direct_access response.
+     * Default User-Agent: gitlab-ai-provider/{version}
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 declare function createGitLab(options?: GitLabProviderSettings): GitLabProvider;
 /**
@@ -214,6 +231,8 @@ declare function createGitLab(options?: GitLabProviderSettings): GitLabProvider;
  */
 declare const gitlab: GitLabProvider;
 
+declare const VERSION: string;
+
 interface GitLabOpenAIConfig {
     provider: string;
     instanceUrl: string;
@@ -228,6 +247,11 @@ interface GitLabOpenAIConfig {
     aiGatewayUrl?: string;
     /** Whether to use the Responses API instead of Chat Completions API */
     useResponsesApi?: boolean;
+    /**
+     * Custom headers for AI Gateway OpenAI proxy requests.
+     * Merged with headers from direct_access token response.
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 declare class GitLabOpenAILanguageModel implements LanguageModelV2 {
     readonly specificationVersion: "v2";
@@ -641,4 +665,4 @@ declare class GitLabDirectAccessClient {
     invalidateToken(): void;
 }
 
-export { BUNDLED_CLIENT_ID, DEFAULT_AI_GATEWAY_URL, type DirectAccessToken, GITLAB_COM_URL, type GitLabAgenticOptions, type GitLabAnthropicConfig, GitLabAnthropicLanguageModel, GitLabDirectAccessClient, type GitLabDirectAccessConfig, GitLabError, type GitLabErrorOptions, GitLabOAuthManager, type GitLabOAuthTokenResponse, type GitLabOAuthTokens, type GitLabOpenAIConfig, GitLabOpenAILanguageModel, type GitLabProject, GitLabProjectCache, GitLabProjectDetector, type GitLabProjectDetectorConfig, type GitLabProvider, type GitLabProviderSettings, MODEL_ID_TO_ANTHROPIC_MODEL, MODEL_MAPPINGS, type ModelMapping, type ModelProvider, OAUTH_SCOPES, type OpenAIApiType, type OpenCodeAuth, type OpenCodeAuthApi, type OpenCodeAuthOAuth, TOKEN_EXPIRY_SKEW_MS, createGitLab, getAnthropicModelForModelId, getModelMapping, getOpenAIApiType, getOpenAIModelForModelId, getProviderForModelId, getValidModelsForProvider, gitlab, isResponsesApiModel };
+export { BUNDLED_CLIENT_ID, DEFAULT_AI_GATEWAY_URL, type DirectAccessToken, GITLAB_COM_URL, type GitLabAgenticOptions, type GitLabAnthropicConfig, GitLabAnthropicLanguageModel, GitLabDirectAccessClient, type GitLabDirectAccessConfig, GitLabError, type GitLabErrorOptions, GitLabOAuthManager, type GitLabOAuthTokenResponse, type GitLabOAuthTokens, type GitLabOpenAIConfig, GitLabOpenAILanguageModel, type GitLabProject, GitLabProjectCache, GitLabProjectDetector, type GitLabProjectDetectorConfig, type GitLabProvider, type GitLabProviderSettings, MODEL_ID_TO_ANTHROPIC_MODEL, MODEL_MAPPINGS, type ModelMapping, type ModelProvider, OAUTH_SCOPES, type OpenAIApiType, type OpenCodeAuth, type OpenCodeAuthApi, type OpenCodeAuthOAuth, TOKEN_EXPIRY_SKEW_MS, VERSION, createGitLab, getAnthropicModelForModelId, getModelMapping, getOpenAIApiType, getOpenAIModelForModelId, getProviderForModelId, getValidModelsForProvider, gitlab, isResponsesApiModel };

package/dist/index.d.ts

@@ -34,6 +34,11 @@ interface GitLabAnthropicConfig {
      * @default 'https://cloud.gitlab.com'
      */
     aiGatewayUrl?: string;
+    /**
+     * Custom headers for AI Gateway Anthropic proxy requests.
+     * Merged with headers from direct_access token response.
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 /**
  * GitLab Anthropic Language Model
@@ -154,6 +159,12 @@ interface GitLabAgenticOptions {
      * Feature flags to pass to the GitLab API
      */
     featureFlags?: Record<string, boolean>;
+    /**
+     * Custom headers for AI Gateway requests (per-model override).
+     * These headers are sent to the Anthropic/OpenAI proxy endpoints.
+     * Merged with provider-level aiGatewayHeaders (model-level takes precedence).
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 interface GitLabProviderSettings {
     /**
@@ -200,6 +211,12 @@ interface GitLabProviderSettings {
      * @default 'https://cloud.gitlab.com'
      */
     aiGatewayUrl?: string;
+    /**
+     * Custom headers to include in AI Gateway requests (Anthropic/OpenAI proxy).
+     * These headers are merged with the default headers from direct_access response.
+     * Default User-Agent: gitlab-ai-provider/{version}
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 declare function createGitLab(options?: GitLabProviderSettings): GitLabProvider;
 /**
@@ -214,6 +231,8 @@ declare function createGitLab(options?: GitLabProviderSettings): GitLabProvider;
  */
 declare const gitlab: GitLabProvider;
 
+declare const VERSION: string;
+
 interface GitLabOpenAIConfig {
     provider: string;
     instanceUrl: string;
@@ -228,6 +247,11 @@ interface GitLabOpenAIConfig {
     aiGatewayUrl?: string;
     /** Whether to use the Responses API instead of Chat Completions API */
     useResponsesApi?: boolean;
+    /**
+     * Custom headers for AI Gateway OpenAI proxy requests.
+     * Merged with headers from direct_access token response.
+     */
+    aiGatewayHeaders?: Record<string, string>;
 }
 declare class GitLabOpenAILanguageModel implements LanguageModelV2 {
     readonly specificationVersion: "v2";
@@ -641,4 +665,4 @@ declare class GitLabDirectAccessClient {
     invalidateToken(): void;
 }
 
-export { BUNDLED_CLIENT_ID, DEFAULT_AI_GATEWAY_URL, type DirectAccessToken, GITLAB_COM_URL, type GitLabAgenticOptions, type GitLabAnthropicConfig, GitLabAnthropicLanguageModel, GitLabDirectAccessClient, type GitLabDirectAccessConfig, GitLabError, type GitLabErrorOptions, GitLabOAuthManager, type GitLabOAuthTokenResponse, type GitLabOAuthTokens, type GitLabOpenAIConfig, GitLabOpenAILanguageModel, type GitLabProject, GitLabProjectCache, GitLabProjectDetector, type GitLabProjectDetectorConfig, type GitLabProvider, type GitLabProviderSettings, MODEL_ID_TO_ANTHROPIC_MODEL, MODEL_MAPPINGS, type ModelMapping, type ModelProvider, OAUTH_SCOPES, type OpenAIApiType, type OpenCodeAuth, type OpenCodeAuthApi, type OpenCodeAuthOAuth, TOKEN_EXPIRY_SKEW_MS, createGitLab, getAnthropicModelForModelId, getModelMapping, getOpenAIApiType, getOpenAIModelForModelId, getProviderForModelId, getValidModelsForProvider, gitlab, isResponsesApiModel };
+export { BUNDLED_CLIENT_ID, DEFAULT_AI_GATEWAY_URL, type DirectAccessToken, GITLAB_COM_URL, type GitLabAgenticOptions, type GitLabAnthropicConfig, GitLabAnthropicLanguageModel, GitLabDirectAccessClient, type GitLabDirectAccessConfig, GitLabError, type GitLabErrorOptions, GitLabOAuthManager, type GitLabOAuthTokenResponse, type GitLabOAuthTokens, type GitLabOpenAIConfig, GitLabOpenAILanguageModel, type GitLabProject, GitLabProjectCache, GitLabProjectDetector, type GitLabProjectDetectorConfig, type GitLabProvider, type GitLabProviderSettings, MODEL_ID_TO_ANTHROPIC_MODEL, MODEL_MAPPINGS, type ModelMapping, type ModelProvider, OAUTH_SCOPES, type OpenAIApiType, type OpenCodeAuth, type OpenCodeAuthApi, type OpenCodeAuthOAuth, TOKEN_EXPIRY_SKEW_MS, VERSION, createGitLab, getAnthropicModelForModelId, getModelMapping, getOpenAIApiType, getOpenAIModelForModelId, getProviderForModelId, getValidModelsForProvider, gitlab, isResponsesApiModel };

package/dist/index.js

@@ -43,6 +43,7 @@ __export(index_exports, {
   MODEL_MAPPINGS: () => MODEL_MAPPINGS,
   OAUTH_SCOPES: () => OAUTH_SCOPES,
   TOKEN_EXPIRY_SKEW_MS: () => TOKEN_EXPIRY_SKEW_MS,
+  VERSION: () => VERSION,
   createGitLab: () => createGitLab,
   getAnthropicModelForModelId: () => getAnthropicModelForModelId,
   getModelMapping: () => getModelMapping,
@@ -238,11 +239,15 @@ var GitLabAnthropicLanguageModel = class {
   async getAnthropicClient(forceRefresh = false) {
     const tokenData = await this.directAccessClient.getDirectAccessToken(forceRefresh);
     const { "x-api-key": _removed, ...filteredHeaders } = tokenData.headers;
+    const mergedHeaders = {
+      ...filteredHeaders,
+      ...this.config.aiGatewayHeaders
+    };
     this.anthropicClient = new import_sdk.default({
       apiKey: null,
       authToken: tokenData.token,
       baseURL: this.directAccessClient.getAnthropicProxyUrl(),
-      defaultHeaders: filteredHeaders
+      defaultHeaders: mergedHeaders
     });
     return this.anthropicClient;
   }
@@ -743,10 +748,14 @@ var GitLabOpenAILanguageModel = class {
   async getOpenAIClient(forceRefresh = false) {
     const tokenData = await this.directAccessClient.getDirectAccessToken(forceRefresh);
     const { "x-api-key": _removed, ...filteredHeaders } = tokenData.headers;
+    const mergedHeaders = {
+      ...filteredHeaders,
+      ...this.config.aiGatewayHeaders
+    };
     this.openaiClient = new import_openai.default({
       apiKey: tokenData.token,
       baseURL: this.directAccessClient.getOpenAIProxyUrl(),
-      defaultHeaders: filteredHeaders
+      defaultHeaders: mergedHeaders
     });
     return this.openaiClient;
   }
@@ -1559,11 +1568,13 @@ var GitLabOAuthManager = class {
   }
 };
 
+// src/version.ts
+var VERSION = true ? "3.3.1" : "0.0.0-dev";
+
 // src/gitlab-provider.ts
 var fs = __toESM(require("fs"));
 var path = __toESM(require("path"));
 var os = __toESM(require("os"));
-var VERSION = "0.0.1";
 function getOpenCodeAuthPath() {
   const homeDir = os.homedir();
   const xdgDataHome = process.env.XDG_DATA_HOME;
@@ -1713,6 +1724,14 @@ function createGitLab(options = {}) {
       ...options.featureFlags,
       ...agenticOptions?.featureFlags
     };
+    const defaultAiGatewayHeaders = {
+      "User-Agent": `gitlab-ai-provider/${VERSION}`
+    };
+    const aiGatewayHeaders = {
+      ...defaultAiGatewayHeaders,
+      ...options.aiGatewayHeaders,
+      ...agenticOptions?.aiGatewayHeaders
+    };
     const baseConfig = {
       provider: `${providerName}.agentic`,
       instanceUrl,
@@ -1721,7 +1740,8 @@ function createGitLab(options = {}) {
       fetch: options.fetch,
       maxTokens: agenticOptions?.maxTokens,
       featureFlags,
-      aiGatewayUrl: options.aiGatewayUrl
+      aiGatewayUrl: options.aiGatewayUrl,
+      aiGatewayHeaders
     };
     if (mapping.provider === "openai") {
       return new GitLabOpenAILanguageModel(modelId, {
@@ -2042,6 +2062,7 @@ var GitLabProjectDetector = class {
   MODEL_MAPPINGS,
   OAUTH_SCOPES,
   TOKEN_EXPIRY_SKEW_MS,
+  VERSION,
   createGitLab,
   getAnthropicModelForModelId,
   getModelMapping,