The open-source agent harness - the runtime layer that turns an LLM into a working agent.
feat: include user API key in TypeScript agent code snippets for OIDC and TrueFoundry auth (#693)
Bhavesh Patel502699b2a0d5
diff --git a/.changeset/agent-snippet-token.md b/.changeset/agent-snippet-token.mdnew file mode 100644index 000000000..d627d3acd--- /dev/null+++ b/.changeset/agent-snippet-token.md@@ -0,0 +1,5 @@+---+'@truefoundry/trueforge': patch+---++Include `token: "USER_API_KEY"` in TypeScript agent code snippets when OIDC or TrueFoundry auth is enabled.diff --git a/packages/trueforge/src/apis/agentCodeSnippets.ts b/packages/trueforge/src/apis/agentCodeSnippets.tsindex 316fbe941..eabc9ab1c 100644--- a/packages/trueforge/src/apis/agentCodeSnippets.ts+++ b/packages/trueforge/src/apis/agentCodeSnippets.ts@@ -1,12 +1,20 @@+import { getTrueForgeAuthMode, TrueForgeAuthMode } from '../config';import type { AgentCodeSnippets } from '../schemas/agent';import { typescriptNonStreamTemplate, typescriptStreamTemplate } from './codesnippet-templates/typescript';const TYPESCRIPT_ICON = 'https://assets.production.truefoundry.com/typescript.svg';-function renderSnippetTemplate(template: string, vars: { agentName: string; baseUrl: string }): string {+/** Bearer `token` for OIDC / TrueFoundry; omitted in standalone where login is off. */+const TOKEN_LINE = '\n token: "USER_API_KEY",';++function renderSnippetTemplate(+ template: string,+ vars: { agentName: string; baseUrl: string; includeToken: boolean },+): string {const literals: Record<string, string> = {agentName: JSON.stringify(vars.agentName),baseUrl: JSON.stringify(vars.baseUrl),+ tokenLine: vars.includeToken ? TOKEN_LINE : '',};return template.replaceAll(/\{\{(\w+)\}\}/g, (match, key: string) => {const value = literals[key];@@ -18,6 +26,8 @@ function renderSnippetTemplate(template: string, vars: { agentName: string; base}export function buildAgentCodeSnippets(input: { agentName: string; baseUrl: string }): AgentCodeSnippets {+ const includeToken = getTrueForgeAuthMode() !== TrueForgeAuthMode.Standalone;+ const vars = { ...input, includeToken };return {base_url: input.baseUrl,snippets: [@@ -26,8 +36,8 @@ export function buildAgentCodeSnippets(input: { agentName: string; baseUrl: strilanguage: 'typescript',icon: TYPESCRIPT_ICON,sample_code: {- stream: renderSnippetTemplate(typescriptStreamTemplate, input),- non_stream: renderSnippetTemplate(typescriptNonStreamTemplate, input),+ stream: renderSnippetTemplate(typescriptStreamTemplate, vars),+ non_stream: renderSnippetTemplate(typescriptNonStreamTemplate, vars),},},],diff --git a/packages/trueforge/src/apis/codesnippet-templates/typescript.ts b/packages/trueforge/src/apis/codesnippet-templates/typescript.tsindex 4f106d854..1d86c44b0 100644--- a/packages/trueforge/src/apis/codesnippet-templates/typescript.ts+++ b/packages/trueforge/src/apis/codesnippet-templates/typescript.ts@@ -2,7 +2,7 @@ export const typescriptStreamTemplate = `// npm install @truefoundry/trueforge-simport { TrueForge, TrueForgeApi, isEventDelta, mergeEventDelta } from "@truefoundry/trueforge-sdk";const client = new TrueForge({- baseUrl: {{baseUrl}},+ baseUrl: {{baseUrl}},{{tokenLine}}});const { data: session } = await client.sessions.create({@@ -30,7 +30,7 @@ export const typescriptNonStreamTemplate = `// npm install @truefoundry/trueforgimport { TrueForge } from "@truefoundry/trueforge-sdk";const client = new TrueForge({- baseUrl: {{baseUrl}},+ baseUrl: {{baseUrl}},{{tokenLine}}});const { data: session } = await client.sessions.create({diff --git a/packages/trueforge/tests/unit/apis/agents.test.ts b/packages/trueforge/tests/unit/apis/agents.test.tsindex 1c0f3b4cc..d527d4ca3 100644--- a/packages/trueforge/tests/unit/apis/agents.test.ts+++ b/packages/trueforge/tests/unit/apis/agents.test.ts@@ -171,13 +171,20 @@ describe('agents router', () => {const response = await router.request(`/${createdJson.data.id}/code-snippets`);expect(response.status).toBe(200);- const body = (await response.json()) as { data: { base_url: string; snippets: unknown[] } };+ const body = (await response.json()) as {+ data: {+ base_url: string;+ snippets: Array<{ sample_code: { stream: string; non_stream: string } }>;+ };+ };expect(body.data.base_url).toBe(configuration.PUBLIC_BASE_URL? new URL(new URL(configuration.PUBLIC_BASE_URL).pathname, 'http://localhost').href: 'http://localhost',);expect(body.data.snippets.length).toBeGreaterThan(0);+ expect(body.data.snippets[0]?.sample_code.stream).not.toContain('USER_API_KEY');+ expect(body.data.snippets[0]?.sample_code.non_stream).not.toContain('USER_API_KEY');const overridden = await router.request(`/${createdJson.data.id}/code-snippets?base_url=${encodeURIComponent('https://sample.com/trueforge')}`,