@outputai/llm 0.7.0 → 0.7.1-next.306c136.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@outputai/llm",
3
- "version": "0.7.0",
3
+ "version": "0.7.1-next.306c136.0",
4
4
  "description": "Framework abstraction to interact with LLM models",
5
5
  "type": "module",
6
6
  "main": "src/index.js",
@@ -13,7 +13,7 @@
13
13
  "gray-matter": "4.0.3",
14
14
  "liquidjs": "10.25.7",
15
15
  "undici": "8.1.0",
16
- "@outputai/core": "0.7.0"
16
+ "@outputai/core": "0.7.1-next.306c136.0"
17
17
  },
18
18
  "devDependencies": {
19
19
  "ai": "6.0.168",
package/src/agent.js CHANGED
@@ -5,7 +5,7 @@ import { loadAiSdkTextOptions } from './ai_sdk_options.js';
5
5
  import { prepareTextPrompt } from './prompt/prepare_text.js';
6
6
  import { startTrace, endTraceWithError } from './utils/trace.js';
7
7
  import { wrapTextResponse, wrapStreamOnFinishResponse } from './utils/response_wrappers.js';
8
- import { ROLE, isRole, getContent } from './utils/message.js';
8
+ import { ROLE, isRole } from './utils/message.js';
9
9
  export { skill } from './prompt/skill.js';
10
10
 
11
11
  export const createMemoryConversationStore = () => {
@@ -47,12 +47,13 @@ export class Agent extends AIToolLoopAgent {
47
47
 
48
48
  // Extract system messages as `instructions` for the ToolLoopAgent constructor
49
49
  // and keep user messages for generate() calls — avoids provider errors
50
- // with multiple system messages during multi-step tool loops
51
- const systemContent = allMessages.filter( isRole( ROLE.SYSTEM ) ).map( getContent ).join( '\n\n' );
50
+ // with multiple system messages during multi-step tool loops.
51
+ // Pass message objects (not a string) so per-message providerOptions are preserved.
52
+ const systemMessages = allMessages.filter( isRole( ROLE.SYSTEM ) );
52
53
 
53
54
  super( {
54
55
  ...constructorOptions,
55
- ...( systemContent ? { instructions: systemContent } : {} ),
56
+ ...( systemMessages.length > 0 ? { instructions: systemMessages } : {} ),
56
57
  ...( tools ? { tools } : {} ),
57
58
  stopWhen: stopWhen ?? stepCountIs( maxSteps ),
58
59
  ...rest
package/src/agent.spec.js CHANGED
@@ -86,7 +86,8 @@ vi.mock( './utils/trace.js', () => ( {
86
86
 
87
87
  vi.mock( './utils/response_wrappers.js', () => ( {
88
88
  wrapTextResponse: ( ...args ) => wrapMocks.wrapTextResponse( ...args ),
89
- wrapStreamOnFinishResponse: ( ...args ) => wrapMocks.wrapStreamOnFinishResponse( ...args )
89
+ wrapStreamOnFinishResponse: ( ...args ) =>
90
+ wrapMocks.wrapStreamOnFinishResponse( ...args )
90
91
  } ) );
91
92
 
92
93
  vi.mock( './prompt/skill.js', () => ( {
@@ -131,7 +132,9 @@ describe( 'Agent', () => {
131
132
  aiMocks.superConstructor.mockReset();
132
133
  aiMocks.superGenerate.mockReset().mockResolvedValue( aiResponse );
133
134
  aiMocks.superStream.mockReset().mockReturnValue( { textStream: 'stream' } );
134
- aiMocks.stepCountIs.mockReset().mockImplementation( count => ( { type: 'step-count', count } ) );
135
+ aiMocks.stepCountIs
136
+ .mockReset()
137
+ .mockImplementation( count => ( { type: 'step-count', count } ) );
135
138
 
136
139
  promptMocks.prepareTextPrompt.mockReset().mockReturnValue( {
137
140
  loadedPrompt,
@@ -143,7 +146,9 @@ describe( 'Agent', () => {
143
146
  traceMocks.startTrace.mockReset().mockReturnValue( 'trace-id' );
144
147
  traceMocks.endTraceWithError.mockReset();
145
148
 
146
- wrapMocks.wrapTextResponse.mockReset().mockImplementation( async ( { response } ) => response );
149
+ wrapMocks.wrapTextResponse
150
+ .mockReset()
151
+ .mockImplementation( async ( { response } ) => response );
147
152
  wrapMocks.wrapStreamOnFinishResponse.mockReset().mockReturnValue( {
148
153
  onFinish: vi.fn()
149
154
  } );
@@ -175,7 +180,9 @@ describe( 'Agent', () => {
175
180
 
176
181
  it( 'prepares the prompt using the resolved invocation dir', async () => {
177
182
  const { Agent } = await importSut();
178
- const skills = [ { name: 'style', description: 'Style', instructions: '# Style' } ];
183
+ const skills = [
184
+ { name: 'style', description: 'Style', instructions: '# Style' }
185
+ ];
179
186
  const tools = { search: { description: 'Search' } };
180
187
 
181
188
  new Agent( {
@@ -199,9 +206,11 @@ describe( 'Agent', () => {
199
206
 
200
207
  new Agent( { prompt: 'test@v1', promptDir: '/explicit/prompts' } );
201
208
 
202
- expect( promptMocks.prepareTextPrompt ).toHaveBeenCalledWith( expect.objectContaining( {
203
- promptDir: '/explicit/prompts'
204
- } ) );
209
+ expect( promptMocks.prepareTextPrompt ).toHaveBeenCalledWith(
210
+ expect.objectContaining( {
211
+ promptDir: '/explicit/prompts'
212
+ } )
213
+ );
205
214
  } );
206
215
 
207
216
  it( 'constructs ToolLoopAgent with text options, instructions, tools, and default stopWhen', async () => {
@@ -215,12 +224,33 @@ describe( 'Agent', () => {
215
224
  model,
216
225
  providerOptions: { test: true },
217
226
  temperature: 0.3,
218
- instructions: 'You are concise.',
227
+ instructions: [ { role: 'system', content: 'You are concise.' } ],
219
228
  tools: preparedTools,
220
229
  stopWhen: { type: 'step-count', count: 10 }
221
230
  } );
222
231
  } );
223
232
 
233
+ it( 'preserves per-message providerOptions on system messages passed as instructions', async () => {
234
+ const { Agent } = await importSut();
235
+ const systemMessage = {
236
+ role: 'system',
237
+ content: 'You are concise.',
238
+ providerOptions: { anthropic: { cacheControl: { type: 'ephemeral' } } }
239
+ };
240
+ optionMocks.loadAiSdkTextOptions.mockReturnValueOnce( {
241
+ model,
242
+ messages: [ systemMessage, { role: 'user', content: 'Hello' } ]
243
+ } );
244
+
245
+ new Agent( { prompt: 'test@v1' } );
246
+
247
+ expect( aiMocks.superConstructor ).toHaveBeenCalledWith(
248
+ expect.objectContaining( {
249
+ instructions: [ systemMessage ]
250
+ } )
251
+ );
252
+ } );
253
+
224
254
  it( 'omits tools when prompt preparation returns null tools', async () => {
225
255
  const { Agent } = await importSut();
226
256
  promptMocks.prepareTextPrompt.mockReturnValueOnce( {
@@ -234,7 +264,7 @@ describe( 'Agent', () => {
234
264
  model,
235
265
  providerOptions: { test: true },
236
266
  temperature: 0.3,
237
- instructions: 'You are concise.',
267
+ instructions: [ { role: 'system', content: 'You are concise.' } ],
238
268
  stopWhen: { type: 'step-count', count: 10 }
239
269
  } );
240
270
  } );
@@ -246,9 +276,11 @@ describe( 'Agent', () => {
246
276
  new Agent( { prompt: 'test@v1', stopWhen } );
247
277
 
248
278
  expect( aiMocks.stepCountIs ).not.toHaveBeenCalled();
249
- expect( aiMocks.superConstructor ).toHaveBeenCalledWith( expect.objectContaining( {
250
- stopWhen
251
- } ) );
279
+ expect( aiMocks.superConstructor ).toHaveBeenCalledWith(
280
+ expect.objectContaining( {
281
+ stopWhen
282
+ } )
283
+ );
252
284
  } );
253
285
 
254
286
  it( 'passes custom constructor options through', async () => {
@@ -256,10 +288,12 @@ describe( 'Agent', () => {
256
288
 
257
289
  new Agent( { prompt: 'test@v1', temperature: 0.8, seed: 42 } );
258
290
 
259
- expect( aiMocks.superConstructor ).toHaveBeenCalledWith( expect.objectContaining( {
260
- temperature: 0.8,
261
- seed: 42
262
- } ) );
291
+ expect( aiMocks.superConstructor ).toHaveBeenCalledWith(
292
+ expect.objectContaining( {
293
+ temperature: 0.8,
294
+ seed: 42
295
+ } )
296
+ );
263
297
  } );
264
298
 
265
299
  it( 'keeps only user prompt messages as initial generate messages', async () => {
@@ -275,7 +309,9 @@ describe( 'Agent', () => {
275
309
 
276
310
  it( 'combines initial, stored, and caller messages for generate', async () => {
277
311
  const store = {
278
- getMessages: vi.fn( () => [ { role: 'assistant', content: 'Stored reply' } ] ),
312
+ getMessages: vi.fn( () => [
313
+ { role: 'assistant', content: 'Stored reply' }
314
+ ] ),
279
315
  addMessages: vi.fn()
280
316
  };
281
317
  const callerMessage = { role: 'user', content: 'New question' };
@@ -336,7 +372,9 @@ describe( 'Agent', () => {
336
372
 
337
373
  it( 'streams with initial, stored, and caller messages', async () => {
338
374
  const store = {
339
- getMessages: vi.fn( () => [ { role: 'assistant', content: 'Stored reply' } ] ),
375
+ getMessages: vi.fn( () => [
376
+ { role: 'assistant', content: 'Stored reply' }
377
+ ] ),
340
378
  addMessages: vi.fn()
341
379
  };
342
380
  const onFinish = vi.fn();
@@ -345,7 +383,12 @@ describe( 'Agent', () => {
345
383
  const { Agent } = await importSut();
346
384
  const agent = new Agent( { prompt: 'test@v1', conversationStore: store } );
347
385
 
348
- const result = await agent.stream( { messages: [ callerMessage ], onFinish, onError, maxRetries: 1 } );
386
+ const result = await agent.stream( {
387
+ messages: [ callerMessage ],
388
+ onFinish,
389
+ onError,
390
+ maxRetries: 1
391
+ } );
349
392
 
350
393
  expect( traceMocks.startTrace ).toHaveBeenCalledWith( {
351
394
  name: 'Agent.stream',
@@ -1,4 +1,5 @@
1
1
  import { loadImageModel, loadTextModel, loadTools } from './ai_model.js';
2
+ import { resolveMessageProviderOptions } from './prompt/block_options.js';
2
3
  import { FatalError } from '@outputai/core';
3
4
 
4
5
  /**
@@ -13,7 +14,7 @@ export const loadAiSdkTextOptions = prompt => {
13
14
  }
14
15
  const options = {
15
16
  model: loadTextModel( prompt ),
16
- messages: prompt.messages,
17
+ messages: resolveMessageProviderOptions( prompt ),
17
18
  providerOptions: prompt.config.providerOptions
18
19
  };
19
20
 
@@ -161,4 +161,32 @@ describe( 'ai_sdk_options', () => {
161
161
  );
162
162
  expect( loadImageModelImpl ).not.toHaveBeenCalled();
163
163
  } );
164
+
165
+ it( 'resolves block attributes into per-message providerOptions', async () => {
166
+ const prompt = {
167
+ name: 'cache@v1',
168
+ config: {
169
+ provider: 'anthropic',
170
+ model: 'claude-sonnet-4-5',
171
+ messageOptions: { cached: { anthropic: { cacheControl: { type: 'ephemeral', ttl: '1h' } } } }
172
+ },
173
+ messages: [
174
+ { role: 'system', content: 'Static', attributes: { options: 'cached' } },
175
+ { role: 'user', content: 'Hello' }
176
+ ],
177
+ instructions: null
178
+ };
179
+
180
+ const { loadAiSdkTextOptions } = await importSut();
181
+ const result = loadAiSdkTextOptions( prompt );
182
+
183
+ expect( result.messages ).toEqual( [
184
+ {
185
+ role: 'system',
186
+ content: 'Static',
187
+ providerOptions: { anthropic: { cacheControl: { type: 'ephemeral', ttl: '1h' } } }
188
+ },
189
+ { role: 'user', content: 'Hello' }
190
+ ] );
191
+ } );
164
192
  } );
package/src/cost/index.js CHANGED
@@ -32,8 +32,13 @@ export const calculateLLMCallCost = async ( { modelId, usage } ) => {
32
32
  if ( Number.isFinite( pricing.input ) && Number.isFinite( nonCachedTokens ) ) {
33
33
  llmUsage.addUsage( { type: 'input', ppm: pricing.input, amount: nonCachedTokens } );
34
34
  }
35
- if ( Number.isFinite( pricing.cache_read ) && Number.isFinite( cachedInputTokens ) ) {
36
- llmUsage.addUsage( { type: 'input_cached', ppm: pricing.cache_read, amount: cachedInputTokens } );
35
+ // Surface cached input tokens whenever the provider reports them, even if the model's
36
+ // pricing lacks a cache_read rate otherwise caching savings vanish from the token
37
+ // aggregation (these tokens are already excluded from the input line above). Price at
38
+ // cache_read when available, otherwise at 0.
39
+ if ( Number.isFinite( cachedInputTokens ) ) {
40
+ const cacheReadPpm = Number.isFinite( pricing.cache_read ) ? pricing.cache_read : 0;
41
+ llmUsage.addUsage( { type: 'input_cached', ppm: cacheReadPpm, amount: cachedInputTokens } );
37
42
  }
38
43
  if ( Number.isFinite( pricing.output ) && Number.isFinite( outputTokens ) ) {
39
44
  llmUsage.addUsage( { type: 'output', ppm: pricing.output, amount: outputTokens } );
@@ -132,7 +132,7 @@ describe( 'calculateLLMCallCost', () => {
132
132
  } );
133
133
  } );
134
134
 
135
- it( 'omits cached usage when model has no cache_read rate', async () => {
135
+ it( 'still counts cached tokens when the model has no cache_read rate', async () => {
136
136
  mockFetchModelsPricing.mockResolvedValue( new Map( [ [ 'no-cache', { input: 2, output: 10 } ] ] ) );
137
137
 
138
138
  const result = await calculateLLMCallCost( {
@@ -140,14 +140,17 @@ describe( 'calculateLLMCallCost', () => {
140
140
  usage: { inputTokens: 1_000_000, cachedInputTokens: 200_000, outputTokens: 0 }
141
141
  } );
142
142
 
143
+ // Cached tokens are surfaced (priced at 0 without a cache_read rate) so caching is
144
+ // visible in the aggregation; cost is unchanged since they are excluded from `input`.
143
145
  expectLLMUsage( result, {
144
146
  modelId: 'no-cache',
145
147
  usage: [
146
148
  { type: 'input', ppm: 2, amount: 800_000, total: 1.6 },
149
+ { type: 'input_cached', ppm: 0, amount: 200_000, total: 0 },
147
150
  { type: 'output', ppm: 10, amount: 0, total: 0 }
148
151
  ],
149
152
  total: 1.6,
150
- tokensUsed: 800_000
153
+ tokensUsed: 1_000_000
151
154
  } );
152
155
  } );
153
156
 
package/src/index.d.ts CHANGED
@@ -57,6 +57,12 @@ export type PromptMessage = {
57
57
  role: string;
58
58
  /** The content of the message */
59
59
  content: string;
60
+ /**
61
+ * Parsed opening-tag attributes for the block. Currently `options` — a space-separated list of
62
+ * frontmatter `messageOptions` set names — which is resolved into per-message `providerOptions`
63
+ * at call time and stripped before the request is sent. Authored as `<system options="set_a set_b">`.
64
+ */
65
+ attributes?: Record<string, string | true>;
60
66
  };
61
67
 
62
68
  /**
@@ -139,6 +145,13 @@ export type Prompt = {
139
145
 
140
146
  /** Provider-specific options */
141
147
  providerOptions?: Record<string, unknown>;
148
+
149
+ /**
150
+ * Named, reusable per-message `providerOptions` sets, referenced from message blocks via the
151
+ * `options="<name>"` attribute. Each value is a provider-namespaced options object, e.g.
152
+ * `{ anthropic: { cacheControl: { type: 'ephemeral' } } }`.
153
+ */
154
+ messageOptions?: Record<string, Record<string, Record<string, unknown>>>;
142
155
  };
143
156
 
144
157
  /** Array of messages in the conversation */
@@ -0,0 +1,58 @@
1
+ import { FatalError, z } from '@outputai/core';
2
+
3
+ /** Shallow-merge two providerOptions objects, combining keys within each provider namespace. */
4
+ const mergeProviderOptions = ( base = {}, extra = {} ) => {
5
+ const merged = { ...base };
6
+ for ( const [ namespace, options ] of Object.entries( extra ) ) {
7
+ merged[namespace] = { ...merged[namespace], ...options };
8
+ }
9
+ return merged;
10
+ };
11
+
12
+ /** Merge the named `messageOptions` sets referenced by a block's `options` attribute. */
13
+ const resolveOptions = ( value, { name, config } ) => {
14
+ const sets = config.messageOptions ?? {};
15
+ return value.trim().split( /\s+/ ).reduce( ( acc, setName ) => {
16
+ if ( !sets[setName] ) {
17
+ throw new FatalError( `Prompt "${name}" references unknown messageOptions set "${setName}"` );
18
+ }
19
+ return mergeProviderOptions( acc, sets[setName] );
20
+ }, {} );
21
+ };
22
+
23
+ /**
24
+ * Registry of supported block attributes. Each entry declares how the attribute is validated
25
+ * (`schema`) and how it contributes to a message's per-message `providerOptions` (`resolve`).
26
+ * Add an entry to support a new block option — validation ({@link attributesSchema}) and
27
+ * resolution ({@link resolveMessageProviderOptions}) both derive from this table.
28
+ */
29
+ const BLOCK_OPTIONS = {
30
+ options: {
31
+ schema: z.string().min( 1 ),
32
+ resolve: resolveOptions
33
+ }
34
+ };
35
+
36
+ /** Zod schema for a block's `attributes` object, derived from the option registry. */
37
+ export const attributesSchema = z.object(
38
+ Object.fromEntries(
39
+ Object.entries( BLOCK_OPTIONS ).map( ( [ name, def ] ) => [ name, def.schema.optional() ] )
40
+ )
41
+ ).strict();
42
+
43
+ /**
44
+ * Resolve each message's authoring `attributes` into AI SDK per-message `providerOptions`,
45
+ * returning clean messages with the `attributes` helper stripped.
46
+ *
47
+ * @param {object} prompt - Loaded prompt object (`{ name, config, messages }`)
48
+ * @returns {Array<object>} Messages with resolved `providerOptions`
49
+ */
50
+ export const resolveMessageProviderOptions = ( { name, config, messages } ) =>
51
+ messages.map( ( { attributes, providerOptions, ...message } ) => {
52
+ const resolved = Object.entries( attributes ?? {} ).reduce( ( acc, [ key, value ] ) => {
53
+ const option = BLOCK_OPTIONS[key];
54
+ return option ? mergeProviderOptions( acc, option.resolve( value, { name, config } ) ) : acc;
55
+ }, providerOptions ?? {} );
56
+
57
+ return Object.keys( resolved ).length > 0 ? { ...message, providerOptions: resolved } : message;
58
+ } );
@@ -0,0 +1,71 @@
1
+ import { describe, it, expect } from 'vitest';
2
+ import { FatalError } from '@outputai/core';
3
+ import { attributesSchema, resolveMessageProviderOptions } from './block_options.js';
4
+
5
+ const textPrompt = ( { config = {}, messages } ) => ( {
6
+ name: 'test@v1',
7
+ config: { provider: 'anthropic', model: 'claude-sonnet-4-5', ...config },
8
+ messages
9
+ } );
10
+
11
+ describe( 'attributesSchema', () => {
12
+ it( 'accepts the options attribute', () => {
13
+ expect( attributesSchema.safeParse( { options: 'cached' } ).success ).toBe( true );
14
+ expect( attributesSchema.safeParse( { options: 'cached fast' } ).success ).toBe( true );
15
+ expect( attributesSchema.safeParse( {} ).success ).toBe( true );
16
+ } );
17
+
18
+ it( 'rejects unknown attributes, including the removed cache shorthand', () => {
19
+ expect( attributesSchema.safeParse( { cache: true } ).success ).toBe( false );
20
+ expect( attributesSchema.safeParse( { unknown: 'x' } ).success ).toBe( false );
21
+ } );
22
+ } );
23
+
24
+ describe( 'resolveMessageProviderOptions', () => {
25
+ it( 'merges a referenced messageOptions set into per-message providerOptions', () => {
26
+ const result = resolveMessageProviderOptions( textPrompt( {
27
+ config: { messageOptions: { cached: { anthropic: { cacheControl: { type: 'ephemeral' } } } } },
28
+ messages: [
29
+ { role: 'system', content: 'Docs', attributes: { options: 'cached' } },
30
+ { role: 'user', content: 'Hello' }
31
+ ]
32
+ } ) );
33
+
34
+ expect( result ).toEqual( [
35
+ {
36
+ role: 'system',
37
+ content: 'Docs',
38
+ providerOptions: { anthropic: { cacheControl: { type: 'ephemeral' } } }
39
+ },
40
+ { role: 'user', content: 'Hello' }
41
+ ] );
42
+ } );
43
+
44
+ it( 'merges multiple referenced sets onto one block', () => {
45
+ const [ system ] = resolveMessageProviderOptions( textPrompt( {
46
+ config: {
47
+ messageOptions: {
48
+ cached: { anthropic: { cacheControl: { type: 'ephemeral', ttl: '1h' } } },
49
+ openaiKey: { openai: { promptCacheKey: 'enrich-v1' } }
50
+ }
51
+ },
52
+ messages: [ { role: 'system', content: 'Docs', attributes: { options: 'cached openaiKey' } } ]
53
+ } ) );
54
+
55
+ expect( system.providerOptions ).toEqual( {
56
+ anthropic: { cacheControl: { type: 'ephemeral', ttl: '1h' } },
57
+ openai: { promptCacheKey: 'enrich-v1' }
58
+ } );
59
+ } );
60
+
61
+ it( 'throws when the options attribute references an unknown set', () => {
62
+ expect( () => resolveMessageProviderOptions( textPrompt( {
63
+ messages: [ { role: 'user', content: 'Hello', attributes: { options: 'missing' } } ]
64
+ } ) ) ).toThrow( FatalError );
65
+ } );
66
+
67
+ it( 'leaves messages without attributes unchanged', () => {
68
+ const messages = [ { role: 'user', content: 'Hello' } ];
69
+ expect( resolveMessageProviderOptions( textPrompt( { messages } ) ) ).toEqual( messages );
70
+ } );
71
+ } );
@@ -0,0 +1,47 @@
1
+ /**
2
+ * Roles that introduce a message block. Add a role here to support a new
3
+ * `<role>...</role>` block — the tokenizer pattern is derived from this set,
4
+ * so no other parser change is required.
5
+ */
6
+ export const BLOCK_ROLES = new Set( [ 'system', 'user', 'assistant', 'tool' ] );
7
+
8
+ const BLOCK_PATTERN = new RegExp(
9
+ `<(${[ ...BLOCK_ROLES ].join( '|' )})((?:\\s[^>]*)?)>([\\s\\S]*?)<\\/\\1>`,
10
+ 'gm'
11
+ );
12
+
13
+ const ATTRIBUTE_PATTERN = /([a-zA-Z][\w-]*)(?:=(?:"([^"]*)"|'([^']*)'|(\S+)))?/g;
14
+
15
+ /**
16
+ * Parse a raw opening-tag attribute string into a plain object. Supports bare booleans
17
+ * (`cache`), double/single-quoted values, and unquoted values:
18
+ * `cache options="a b" ttl='1h'` → `{ cache: true, options: 'a b', ttl: '1h' }`.
19
+ *
20
+ * @param {string} [raw] - Raw attribute text between the role and the closing `>`
21
+ * @returns {Record<string, string | true>} Parsed attributes
22
+ */
23
+ export const parseAttributes = ( raw = '' ) =>
24
+ Object.fromEntries(
25
+ [ ...raw.matchAll( ATTRIBUTE_PATTERN ) ].map(
26
+ ( [ _, key, doubleQuoted, singleQuoted, bare ] ) =>
27
+ [ key, doubleQuoted ?? singleQuoted ?? bare ?? true ]
28
+ )
29
+ );
30
+
31
+ /**
32
+ * Tokenize a rendered prompt body into message blocks. Each block is `{ role, content }`,
33
+ * plus `attributes` when the opening tag carried any. Content between role tags is treated
34
+ * as opaque text, so prompt bodies may freely contain other angle-bracket markup.
35
+ *
36
+ * @param {string} content - Rendered prompt body (after frontmatter is stripped)
37
+ * @returns {Array<{ role: string, content: string, attributes?: Record<string, string | true> }>}
38
+ */
39
+ export const tokenizeBlocks = content =>
40
+ [ ...content.matchAll( BLOCK_PATTERN ) ].map( ( [ _, role, rawAttributes, text ] ) => {
41
+ const attributes = parseAttributes( rawAttributes.trim() );
42
+ return {
43
+ role,
44
+ content: text.trim(),
45
+ ...( Object.keys( attributes ).length > 0 && { attributes } )
46
+ };
47
+ } );
@@ -0,0 +1,63 @@
1
+ import { describe, it, expect } from 'vitest';
2
+ import { parseAttributes, tokenizeBlocks, BLOCK_ROLES } from './blocks.js';
3
+
4
+ describe( 'parseAttributes', () => {
5
+ it( 'parses a bare attribute as boolean true', () => {
6
+ expect( parseAttributes( 'pinned' ) ).toEqual( { pinned: true } );
7
+ } );
8
+
9
+ it( 'parses double- and single-quoted values', () => {
10
+ expect( parseAttributes( 'ttl="1h" mode=\'fast\'' ) ).toEqual( { ttl: '1h', mode: 'fast' } );
11
+ } );
12
+
13
+ it( 'parses unquoted values', () => {
14
+ expect( parseAttributes( 'ttl=1h' ) ).toEqual( { ttl: '1h' } );
15
+ } );
16
+
17
+ it( 'parses multiple attributes and preserves spaces inside quotes', () => {
18
+ expect( parseAttributes( 'pinned options="cached fast"' ) ).toEqual( {
19
+ pinned: true,
20
+ options: 'cached fast'
21
+ } );
22
+ } );
23
+
24
+ it( 'returns an empty object for blank input', () => {
25
+ expect( parseAttributes( '' ) ).toEqual( {} );
26
+ expect( parseAttributes() ).toEqual( {} );
27
+ } );
28
+ } );
29
+
30
+ describe( 'tokenizeBlocks', () => {
31
+ it( 'tokenizes plain blocks without an attributes key', () => {
32
+ const blocks = tokenizeBlocks( '<system>Hi</system>\n<user>Yo</user>' );
33
+ expect( blocks ).toEqual( [
34
+ { role: 'system', content: 'Hi' },
35
+ { role: 'user', content: 'Yo' }
36
+ ] );
37
+ } );
38
+
39
+ it( 'attaches parsed attributes to the block', () => {
40
+ const blocks = tokenizeBlocks( '<system options="a b" pinned>Hi</system>' );
41
+ expect( blocks[0] ).toEqual( {
42
+ role: 'system',
43
+ content: 'Hi',
44
+ attributes: { options: 'a b', pinned: true }
45
+ } );
46
+ } );
47
+
48
+ it( 'captures unknown attributes generically (validation rejects them later)', () => {
49
+ const blocks = tokenizeBlocks( '<user data="x">Hi</user>' );
50
+ expect( blocks[0].attributes ).toEqual( { data: 'x' } );
51
+ } );
52
+
53
+ it( 'treats angle-bracket markup inside a block as opaque content', () => {
54
+ const blocks = tokenizeBlocks( '<user>Compare <div> and <span> tags</user>' );
55
+ expect( blocks[0] ).toEqual( { role: 'user', content: 'Compare <div> and <span> tags' } );
56
+ } );
57
+
58
+ it( 'tokenizes every registered role', () => {
59
+ const body = [ ...BLOCK_ROLES ].map( role => `<${role}>${role} body</${role}>` ).join( '\n' );
60
+ const blocks = tokenizeBlocks( body );
61
+ expect( blocks.map( block => block.role ) ).toEqual( [ ...BLOCK_ROLES ] );
62
+ } );
63
+ } );
@@ -1,5 +1,6 @@
1
1
  import matter from 'gray-matter';
2
2
  import { FatalError } from '@outputai/core';
3
+ import { tokenizeBlocks } from './blocks.js';
3
4
 
4
5
  export function parsePrompt( { name, raw } ) {
5
6
  const { data: config, content } = matter( raw );
@@ -8,11 +9,7 @@ export function parsePrompt( { name, raw } ) {
8
9
  throw new FatalError( `Prompt "${name}" has no content after frontmatter` );
9
10
  }
10
11
 
11
- const infoExtractor = /<(system|user|assistant|tool)>([\s\S]*?)<\/\1>/gm;
12
- const messages = [ ...content.matchAll( infoExtractor ) ].map(
13
- ( [ _, role, text ] ) => ( { role, content: text.trim() } )
14
- );
15
-
12
+ const messages = tokenizeBlocks( content );
16
13
  const instructions = messages.length === 0 ? content.trim() : null;
17
14
 
18
15
  return { config, messages, instructions };
@@ -164,4 +164,23 @@ model: claude-3-5-sonnet-20241022
164
164
  ] );
165
165
  expect( result.instructions ).toBeNull();
166
166
  } );
167
+
168
+ it( 'surfaces block opening-tag attributes as an attributes object', () => {
169
+ const raw = `---
170
+ provider: anthropic
171
+ model: claude-sonnet-4-5
172
+ ---
173
+
174
+ <system options="cached">Static.</system>
175
+ <user>Question</user>`;
176
+
177
+ const result = parsePrompt( { name: 'test', raw } );
178
+
179
+ expect( result.messages[0] ).toEqual( {
180
+ role: 'system',
181
+ content: 'Static.',
182
+ attributes: { options: 'cached' }
183
+ } );
184
+ expect( result.messages[1] ).toEqual( { role: 'user', content: 'Question' } );
185
+ } );
167
186
  } );
@@ -1,8 +1,12 @@
1
1
  import { ValidationError, z } from '@outputai/core';
2
+ import { attributesSchema } from './block_options.js';
2
3
 
3
4
  const toolConfigSchema = z.record( z.string(), z.unknown() );
4
5
  const toolsConfigSchema = z.record( z.string(), toolConfigSchema );
5
6
 
7
+ // A provider-namespaced options object, e.g. { anthropic: { cacheControl: { type: 'ephemeral' } } }
8
+ const providerOptionsSchema = z.record( z.string(), z.record( z.string(), z.unknown() ) );
9
+
6
10
  export const promptSchema = z.object( {
7
11
  name: z.string(),
8
12
  config: z.object( {
@@ -22,12 +26,14 @@ export const promptSchema = z.object( {
22
26
  type: z.enum( [ 'enabled', 'disabled' ] ),
23
27
  budgetTokens: z.number().optional()
24
28
  } ).loose().optional()
25
- } ).loose().optional()
29
+ } ).loose().optional(),
30
+ messageOptions: z.record( z.string(), providerOptionsSchema ).optional()
26
31
  } ).loose(),
27
32
  messages: z.array(
28
33
  z.object( {
29
34
  role: z.string(),
30
- content: z.string()
35
+ content: z.string(),
36
+ attributes: attributesSchema.optional()
31
37
  } ).strict()
32
38
  ),
33
39
  instructions: z.string().trim().min( 1 ).nullable().optional()
@@ -596,4 +596,53 @@ describe( 'validatePrompt', () => {
596
596
 
597
597
  expect( () => validatePrompt( maxTokensSnakeCase ) ).not.toThrow();
598
598
  } );
599
+
600
+ it( 'should validate the options attribute referencing messageOptions sets', () => {
601
+ const promptWithMessageOptions = {
602
+ name: 'message-options-prompt',
603
+ config: {
604
+ provider: 'anthropic',
605
+ model: 'claude-sonnet-4-5',
606
+ messageOptions: {
607
+ cached: { anthropic: { cacheControl: { type: 'ephemeral' } } }
608
+ }
609
+ },
610
+ messages: [
611
+ { role: 'system', content: 'Docs.', attributes: { options: 'cached' } },
612
+ { role: 'user', content: 'Question' }
613
+ ]
614
+ };
615
+
616
+ expect( () => validatePrompt( promptWithMessageOptions ) ).not.toThrow();
617
+ } );
618
+
619
+ it( 'should reject the removed cache shorthand as an unknown block attribute', () => {
620
+ const cacheShorthandPrompt = {
621
+ name: 'cache-shorthand-prompt',
622
+ config: {
623
+ provider: 'anthropic',
624
+ model: 'claude-sonnet-4-5'
625
+ },
626
+ messages: [
627
+ { role: 'system', content: 'Static.', attributes: { cache: true } }
628
+ ]
629
+ };
630
+
631
+ expect( () => validatePrompt( cacheShorthandPrompt ) ).toThrow( ValidationError );
632
+ } );
633
+
634
+ it( 'should throw ValidationError for unknown top-level message fields', () => {
635
+ const unknownFieldPrompt = {
636
+ name: 'unknown-field-prompt',
637
+ config: {
638
+ provider: 'anthropic',
639
+ model: 'claude-sonnet-4-5'
640
+ },
641
+ messages: [
642
+ { role: 'user', content: 'Hi', options: 'cached' }
643
+ ]
644
+ };
645
+
646
+ expect( () => validatePrompt( unknownFieldPrompt ) ).toThrow( ValidationError );
647
+ } );
599
648
  } );