@tstdl/base 0.93.149 → 0.93.150

package/ai/prompts/prompt-builder.d.ts

@@ -1,4 +1,5 @@
 import type { Part } from 'genkit';
+import type { SchemaTestable } from '../../schema/schema.js';
 import type { ObjectLiteral } from '../../types/index.js';
 import { type Instructions } from './instructions-formatter.js';
 export type PromptBuilderInstructions = Record<string, Instructions>;
@@ -10,6 +11,8 @@ export declare class PromptBuilder {
     setRole(role: string): this;
     setSystemTask(task: string): this;
     setTask(task: string): this;
+    setSystemOutputSchema(schema: SchemaTestable): this;
+    setOutputSchema(schema: SchemaTestable): this;
     addSystemMedia(content: Uint8Array, mimeType: string): this;
     addMedia(content: Uint8Array, mimeType: string): this;
     addSystemInstructions(instructions: Record<string, Instructions>): this;

package/ai/prompts/prompt-builder.js

@@ -1,3 +1,4 @@
+import { convertToOpenApiSchema } from '../../schema/converters/open-api-converter.js';
 import { encodeBase64 } from '../../utils/base64.js';
 import { fromEntries, objectEntries, objectKeys } from '../../utils/object/index.js';
 import { assertObjectPass, isDefined, isString, isUndefined } from '../../utils/type-guards.js';
@@ -10,6 +11,8 @@ export class PromptBuilder {
     #role;
     #systemTask;
     #task;
+    #systemOutputSchema;
+    #outputSchema;
     #systemInstructions = {};
     #instructions = {};
     #systemContextParts = {};
@@ -30,6 +33,14 @@ export class PromptBuilder {
         this.#task = task;
         return this;
     }
+    setSystemOutputSchema(schema) {
+        this.#systemOutputSchema = schema;
+        return this;
+    }
+    setOutputSchema(schema) {
+        this.#outputSchema = schema;
+        return this;
+    }
     addSystemMedia(content, mimeType) {
         addMedia(content, mimeType, this.#systemMedia);
         return this;
@@ -67,6 +78,7 @@ export class PromptBuilder {
             role: this.#systemRole,
             context: this.#systemContextParts,
             instructions: this.#systemInstructions,
+            outputSchema: this.#systemOutputSchema,
             task: this.#systemTask,
             media: this.#systemMedia,
         });
@@ -76,6 +88,7 @@ export class PromptBuilder {
             role: this.#role,
             context: this.#contextParts,
             instructions: this.#instructions,
+            outputSchema: this.#outputSchema,
             task: this.#task,
             media: this.#media,
         });
@@ -104,6 +117,10 @@ function buildPrompt(data) {
     if (isDefined(data.instructions) && (objectKeys(data.instructions).length > 0)) {
         instructions['**Instructions**'] = data.instructions;
     }
+    if (isDefined(data.outputSchema)) {
+        const schema = convertToOpenApiSchema(data.outputSchema);
+        instructions['**Output Schema**'] = `\`\`\`json\n${JSON.stringify(schema, null, 2)}\n\`\`\``;
+    }
     if (isDefined(data.task)) {
         instructions['**Task**'] = data.task;
     }

package/ai/prompts/tests/prompt-builder.test.d.ts

@@ -0,0 +1 @@
+export {};

package/ai/prompts/tests/prompt-builder.test.js

@@ -0,0 +1,22 @@
+import { describe, expect, it } from 'vitest';
+import { StringSchema } from '../../../schema/schemas/string.js';
+import { promptBuilder } from '../prompt-builder.js';
+describe('PromptBuilder', () => {
+    it('should add output schema to the prompt', () => {
+        const builder = promptBuilder()
+            .setRole('Test Role')
+            .setOutputSchema(new StringSchema({ description: 'Test Description' }))
+            .setTask('Test Task');
+        const prompt = builder.buildUserPrompt();
+        const text = prompt[0].text;
+        expect(text).toContain('# **Output Schema**');
+        expect(text).toContain('"type": "string"');
+        expect(text).toContain('"description": "Test Description"');
+        // Check order: Role -> Output Schema -> Task
+        const roleIndex = text.indexOf('# **Role**');
+        const schemaIndex = text.indexOf('# **Output Schema**');
+        const taskIndex = text.indexOf('# **Task**');
+        expect(roleIndex).toBeLessThan(schemaIndex);
+        expect(schemaIndex).toBeLessThan(taskIndex);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.93.149",
+  "version": "0.93.150",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"