@tstdl/base 0.93.133 → 0.93.134

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

@@ -1,21 +1,24 @@
 import type { Part } from 'genkit';
-import type { ObjectLiteral, OneOrMany } from '../../types/index.js';
+import type { ObjectLiteral } from '../../types/index.js';
 import { type Instructions } from './instructions-formatter.js';
-export type PromptInstructionItem = string | Instructions;
+export type PromptBuilderInstructions = Record<string, Instructions>;
+export type PromptBuilderContext = Record<string, PromptBuilderContextItem>;
+export type PromptBuilderContextItem = ObjectLiteral;
 export declare class PromptBuilder {
     #private;
     setSystemRole(role: string): this;
     setRole(role: string): this;
     setSystemTask(task: string): this;
     setTask(task: string): this;
+    addSystemMedia(content: Uint8Array, mimeType: string): this;
     addMedia(content: Uint8Array, mimeType: string): this;
     addSystemInstructions(instructions: Record<string, Instructions>): this;
     addInstructions(instructions: Record<string, Instructions>): this;
-    addSystemContext(title: string, context: string | OneOrMany<ObjectLiteral | Record<string, ObjectLiteral | null>>): this;
-    addSystemContext(context: Record<string, OneOrMany<ObjectLiteral | Record<string, ObjectLiteral | null>>>): this;
-    addContext(title: string, context: string | OneOrMany<ObjectLiteral | Record<string, ObjectLiteral | null>>): this;
-    addContext(context: Record<string, OneOrMany<ObjectLiteral | Record<string, ObjectLiteral | null>>>): this;
-    buildSystem(): Part[];
-    buildPrompt(): Part[];
+    addSystemContext(title: string, context: PromptBuilderContextItem): this;
+    addSystemContext(context: PromptBuilderContext): this;
+    addContext(title: string, context: PromptBuilderContextItem): this;
+    addContext(context: PromptBuilderContext): this;
+    buildSystemPrompt(): Part[];
+    buildUserPrompt(): Part[];
 }
 export declare function promptBuilder(): PromptBuilder;

package/ai/prompts/prompt-builder.js

@@ -12,6 +12,7 @@ export class PromptBuilder {
     #instructions = {};
     #systemContextParts = {};
     #contextParts = {};
+    #systemMedia = [];
     #media = [];
     setSystemRole(role) {
         this.#systemRole = role;
@@ -29,10 +30,12 @@ export class PromptBuilder {
         this.#task = task;
         return this;
     }
+    addSystemMedia(content, mimeType) {
+        addMedia(content, mimeType, this.#systemMedia);
+        return this;
+    }
     addMedia(content, mimeType) {
-        const base64Data = encodeBase64(content);
-        const dataUrl = `data:${mimeType};base64,${base64Data}`;
-        this.#media.push({ media: { url: dataUrl } });
+        addMedia(content, mimeType, this.#media);
         return this;
     }
     addSystemInstructions(instructions) {
@@ -59,51 +62,54 @@ export class PromptBuilder {
         this.#contextParts[titleOrContext] = contextOrNothing;
         return this;
     }
-    buildSystem() {
-        const instructions = {};
-        if (isDefined(this.#systemRole)) {
-            instructions['**Role**'] = this.#systemRole;
-        }
-        if (objectKeys(this.#systemContextParts).length > 0) {
-            const contextEntries = objectEntries(this.#systemContextParts).map(([key, contextPart]) => {
-                const string = isString(contextPart) ? contextPart : `\`\`\`toon\n${formatData(contextPart)}\n\`\`\``;
-                return [key, string];
-            });
-            instructions['**Context**'] = sections(fromEntries(contextEntries));
-        }
-        if (objectKeys(this.#systemInstructions).length > 0) {
-            instructions['**Instructions**'] = this.#systemInstructions;
-        }
-        if (isDefined(this.#systemTask)) {
-            instructions['**Task**'] = this.#systemTask;
-        }
-        return [{ text: formatInstructions(instructions) }];
+    buildSystemPrompt() {
+        return buildPrompt({
+            role: this.#systemRole,
+            context: this.#systemContextParts,
+            instructions: this.#systemInstructions,
+            task: this.#systemTask,
+            media: this.#systemMedia,
+        });
     }
-    buildPrompt() {
-        const instructions = {};
-        if (isDefined(this.#role)) {
-            instructions['**Role**'] = this.#role;
-        }
-        if (objectKeys(this.#contextParts).length > 0) {
-            const contextEntries = objectEntries(this.#contextParts).map(([key, contextPart]) => {
-                const string = isString(contextPart) ? contextPart : `\`\`\`toon\n${formatData(contextPart)}\n\`\`\``;
-                return [key, string];
-            });
-            instructions['**Context**'] = sections(fromEntries(contextEntries));
-        }
-        if (objectKeys(this.#instructions).length > 0) {
-            instructions['**Instructions**'] = this.#instructions;
-        }
-        if (isDefined(this.#task)) {
-            instructions['**Task**'] = this.#task;
-        }
-        const formatted = formatInstructions(instructions);
-        return [
-            ...this.#media,
-            { text: formatted },
-        ];
+    buildUserPrompt() {
+        return buildPrompt({
+            role: this.#role,
+            context: this.#contextParts,
+            instructions: this.#instructions,
+            task: this.#task,
+            media: this.#media,
+        });
     }
 }
 export function promptBuilder() {
     return new PromptBuilder();
 }
+function addMedia(content, mimeType, targetArray) {
+    const base64Data = encodeBase64(content);
+    const dataUrl = `data:${mimeType};base64,${base64Data}`;
+    targetArray.push({ media: { url: dataUrl } });
+}
+function buildPrompt(data) {
+    const instructions = {};
+    if (isDefined(data.role)) {
+        instructions['**Role**'] = data.role;
+    }
+    if (isDefined(data.context) && objectKeys(data.context).length > 0) {
+        const contextEntries = objectEntries(data.context).map(([key, contextPart]) => {
+            const string = isString(contextPart) ? contextPart : `\`\`\`toon\n${formatData(contextPart)}\n\`\`\``;
+            return [key, string];
+        });
+        instructions['**Context**'] = sections(fromEntries(contextEntries));
+    }
+    if (isDefined(data.instructions) && (objectKeys(data.instructions).length > 0)) {
+        instructions['**Instructions**'] = data.instructions;
+    }
+    if (isDefined(data.task)) {
+        instructions['**Task**'] = data.task;
+    }
+    const formattedInstructions = formatInstructions(instructions);
+    return [
+        ...(data.media ?? []),
+        { text: formattedInstructions },
+    ];
+}

package/examples/ai/prompt-builder.js

@@ -79,8 +79,8 @@ async function main() {
     const dummyImage = new Uint8Array([0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A]);
     builder.addMedia(dummyImage, 'image/png');
     // 4. Build and Display
-    const systemMessage = builder.buildSystem();
-    const userMessage = builder.buildPrompt();
+    const systemMessage = builder.buildSystemPrompt();
+    const userMessage = builder.buildUserPrompt();
     console.log('--- SYSTEM MESSAGE ---');
     for (const part of systemMessage) {
         if (part.text) {

package/package.json

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

package/test5.js

@@ -6,9 +6,9 @@ import { PrettyPrintLogFormatter } from './logger/index.js';
 import { provideConsoleLogTransport } from './logger/transports/console.js';
 async function main(_cancellationSignal) {
     const x = promptBuilder();
-    console.log(x.buildSystem()[0].text);
+    console.log(x.buildSystemPrompt()[0].text);
     console.log('\n\n---\n\n');
-    console.log(x.buildPrompt()[0].text);
+    console.log(x.buildUserPrompt()[0].text);
 }
 Application.run('Test', [
     provideConsoleLogTransport(PrettyPrintLogFormatter),