@sprucelabs/sprucebot-llm 0.0.1

package/build/esm/bots/templates.js

@@ -0,0 +1,68 @@
+import renderPlaceholder from '../parsingResponses/renderPlaceholder.js';
+export const STATE_BOUNDARY = '*****';
+export const DONE_TOKEN = `____ DONE ____`;
+export const CALLBACK_BOUNDARY = 'xxxxx';
+export const PROMPT_TEMPLATE = `You are <%= it.youAre %>
+
+
+For this interaction, every message I send will start with "__Me__:" and I'll prompt you for your response by starting with "__You__:".
+
+__Me__: Do you understand?
+__You__: Yes
+
+<% if (it.stateSchemaJson) { %>
+
+Here is the schema that defines the state for this conversation:
+
+<%= it.stateSchemaJson %>
+
+
+Here is the current state, which is based on the schema above:
+
+<%= it.stateJson %>
+
+
+After each message, send the state in the form:
+
+${STATE_BOUNDARY} <%= it.stateJson %> ${STATE_BOUNDARY}
+
+__Me__: Sound good?
+__You__: Yup!
+
+${STATE_BOUNDARY} <%= it.stateJson %> ${STATE_BOUNDARY}
+
+When asking me about a "select" field, make sure I only pick a valid choice by showing me their labels!<% } %>
+
+<% if (it.skill) { %>
+	
+Your primary objective for this conversation is <%= it.skill.yourJobIfYouChooseToAcceptItIs %>
+<% if (it.skill.callbacks) { %>
+While we are talking, there are going to be things I don't want you to answer, but instead to respond with a placeholder in the form of ${renderPlaceholder('example')}.
+
+Here are the placeholders we will be using:
+
+<% Object.keys(it.skill.callbacks).forEach((key) => { %>
+Whenever <%= it.skill.callbacks[key].useThisWhenever %>, respond with ${CALLBACK_BOUNDARY} <%= key %> ${CALLBACK_BOUNDARY}
+
+<% }) %>
+<% } %>
+<% if (!it.stateSchemaJson && it.skill.weAreDoneWhen) { %>
+We are done when <%= it.skill.weAreDoneWhen %> At that point, send me the following message so I know we are done:
+
+${DONE_TOKEN}
+<% } %>
+<% } %>
+<% if (it.stateSchemaJson) { %>
+
+Once you have asked about every field in the schema, send me the following message so I know we're done:
+
+${DONE_TOKEN}
+<% } %>
+
+Let's get started:
+
+<% it.messages.forEach((message) => { %>
+__<%= message.from %>__: <%= message.message %>
+
+<% }) %>
+__You__:`;

package/build/esm/chat.d.ts

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

package/build/esm/chat.js

@@ -0,0 +1,41 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { stdin as input, stdout as output } from 'node:process';
+import * as readline from 'node:readline/promises.js';
+import dotenv from 'dotenv';
+import { OpenAi } from './bots/adapters/OpenAi.js';
+import SprucebotLlmFactory from './bots/SprucebotLlmFactory.js';
+import buildCallbackSkill from './examples/buildCallbackSkill.js';
+import buildJokeSkill from './examples/buildJokeSkill.js';
+import buildProfileSkill from './examples/buildProfileSkill.js';
+dotenv.config();
+const rl = readline.createInterface({ input, output });
+(() => __awaiter(void 0, void 0, void 0, function* () {
+    console.clear();
+    const adapter = new OpenAi(process.env.OPEN_AI_API_KEY);
+    const bots = SprucebotLlmFactory.Factory();
+    const skills = {
+        jokes: buildJokeSkill(bots),
+        profile: buildProfileSkill(bots),
+        callbacks: buildCallbackSkill(bots),
+    };
+    const bot = bots.Bot({
+        adapter,
+        skill: skills.callbacks,
+        youAre: "a bot named Sprucebot that is in test mode. At the start of every conversation, you introduce yourself and announce that you are in test mode so I don't get confused! You are both hip and adorable. You say things like, 'Jeepers' and 'Golly' or even 'Jeezey peezy'!",
+    });
+    do {
+        const input = yield rl.question('Message > ');
+        const response = yield bot.sendMessage(input);
+        console.log('>', response);
+    } while (!bot.getIsDone());
+    console.log('Signing off...');
+    rl.close();
+}))();

package/build/esm/errors/SpruceError.d.ts

@@ -0,0 +1,6 @@
+import BaseSpruceError from '@sprucelabs/error';
+import ErrorOptions from "./../.spruce/errors/options.types";
+export default class SpruceError extends BaseSpruceError<ErrorOptions> {
+    /** an easy to understand version of the errors */
+    friendlyMessage(): string;
+}

package/build/esm/errors/SpruceError.js

@@ -0,0 +1,19 @@
+import BaseSpruceError from '@sprucelabs/error';
+export default class SpruceError extends BaseSpruceError {
+    /** an easy to understand version of the errors */
+    friendlyMessage() {
+        const { options } = this;
+        let message;
+        switch (options === null || options === void 0 ? void 0 : options.code) {
+            case 'NO_BOT_INSTANCE_SET':
+                message = `You must create a bot and set it using 'SprucebotLlmFactory.setInstance(bot)' before you can get an instance of it.`;
+                break;
+            default:
+                message = super.friendlyMessage();
+        }
+        const fullMessage = options.friendlyMessage
+            ? options.friendlyMessage
+            : message;
+        return fullMessage;
+    }
+}

package/build/esm/errors/noBotInstanceSet.builder.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    id: string;
+    name: string;
+    fields: {};
+};
+export default _default;

package/build/esm/errors/noBotInstanceSet.builder.js

@@ -0,0 +1,6 @@
+import { buildErrorSchema } from '@sprucelabs/schema';
+export default buildErrorSchema({
+    id: 'noBotInstanceSet',
+    name: 'No bot instance set',
+    fields: {},
+});

package/build/esm/examples/buildCallbackSkill.d.ts

@@ -0,0 +1,2 @@
+import SprucebotLlmFactory from '../bots/SprucebotLlmFactory';
+export default function buildCallbackSkill(bots: SprucebotLlmFactory): import("../llm.types").SprucebotLLmSkill<import("@sprucelabs/schema").Schema, import("@sprucelabs/schema").SchemaStaticValues<import("@sprucelabs/schema").Schema, false, never, import("@sprucelabs/schema").StaticSchemaAllValues<import("@sprucelabs/schema").Schema, false>>>;

package/build/esm/examples/buildCallbackSkill.js

@@ -0,0 +1,28 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export default function buildCallbackSkill(bots) {
+    return bots.Skill({
+        yourJobIfYouChooseToAcceptItIs: "to be be the best appointment taker on the planet. You have a many years of experience. You are going to ask me only 2 questions for this practice run. First, you'll ask me to pick an available time. Then, you'll ask me to pick my favorite color:",
+        callbacks: {
+            availableTimes: {
+                cb: () => __awaiter(this, void 0, void 0, function* () {
+                    return ['9am', '10am', '11am', '1pm', '4pm', '5pm', '12am.'].join('\n');
+                }),
+                useThisWhenever: 'your are showing what times i can pick from.',
+            },
+            favoriteColor: {
+                cb: () => __awaiter(this, void 0, void 0, function* () {
+                    return ['red', 'blue', 'green', 'purple'].join('\n');
+                }),
+                useThisWhenever: 'your are showing what colors i can pick from.',
+            },
+        },
+    });
+}

package/build/esm/examples/buildJokeSkill.d.ts

@@ -0,0 +1,2 @@
+import SprucebotLlmFactory from '../bots/SprucebotLlmFactory';
+export default function buildJokeSkill(bots: SprucebotLlmFactory): import("../llm.types").SprucebotLLmSkill<import("@sprucelabs/schema").Schema, import("@sprucelabs/schema").SchemaStaticValues<import("@sprucelabs/schema").Schema, false, never, import("@sprucelabs/schema").StaticSchemaAllValues<import("@sprucelabs/schema").Schema, false>>>;

package/build/esm/examples/buildJokeSkill.js

@@ -0,0 +1,12 @@
+export default function buildJokeSkill(bots) {
+    return bots.Skill({
+        yourJobIfYouChooseToAcceptItIs: 'to tell knock knock jokes!',
+        pleaseKeepInMindThat: [
+            'our audience is younger, so keep it PG!',
+            'you should never laugh when someone does not get the joke.',
+            "after each joke, you should tell me how many jokes you have left to tell before we're done.",
+            'you should acknowledge if someone laughs at your joke by saying "Thanks!" or "Glad you thought that was funny"!',
+        ],
+        weAreDoneWhen: 'you have told 3 jokes!',
+    });
+}

package/build/esm/examples/buildProfileSkill.d.ts

@@ -0,0 +1,2 @@
+import SprucebotLlmFactory from '../bots/SprucebotLlmFactory';
+export default function buildProfileSkill(bots: SprucebotLlmFactory): import("../llm.types").SprucebotLLmSkill<import("@sprucelabs/schema").Schema, import("@sprucelabs/schema").SchemaStaticValues<import("@sprucelabs/schema").Schema, false, never, import("@sprucelabs/schema").StaticSchemaAllValues<import("@sprucelabs/schema").Schema, false>>>;

package/build/esm/examples/buildProfileSkill.js

@@ -0,0 +1,29 @@
+import { buildSchema } from '@sprucelabs/schema';
+export default function buildProfileSkill(bots) {
+    return bots.Skill({
+        yourJobIfYouChooseToAcceptItIs: 'to collect some information from me! You are a receptionist with 20 years experience and are very focused on getting answers needed to complete my profile',
+        stateSchema: buildSchema({
+            id: 'profile',
+            fields: {
+                firstName: {
+                    type: 'text',
+                    label: 'First name',
+                },
+                lastName: {
+                    type: 'text',
+                    label: 'Last name',
+                },
+                favoriteColor: {
+                    type: 'select',
+                    options: {
+                        choices: [
+                            { label: 'Red', value: 'red' },
+                            { label: 'Blue', value: 'blue' },
+                            { label: 'Green', value: 'green' },
+                        ],
+                    },
+                },
+            },
+        }),
+    });
+}

package/build/esm/index.js

@@ -0,0 +1,2 @@
+"use strict";
+//exports go here

package/build/esm/llm.types.d.ts

@@ -0,0 +1,61 @@
+import { MercuryEventEmitter } from '@sprucelabs/mercury-types';
+import { Schema, SchemaValues } from '@sprucelabs/schema';
+export interface BotOptions<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends Omit<PromptOptions<StateSchema, State>, 'skill'> {
+    adapter: LlmAdapter;
+    Class?: new (...opts: any[]) => SprucebotLlmBot<Schema, State>;
+    skill?: SprucebotLLmSkill<Schema>;
+}
+export interface SprucebotLlmBot<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends MercuryEventEmitter<LlmEventContract> {
+    markAsDone(): void;
+    getIsDone(): boolean;
+    sendMessage(message: string): Promise<string>;
+    serialize(): SerializedBot<StateSchema, State>;
+    updateState(state: Partial<State>): Promise<void>;
+}
+export interface LlmAdapter {
+    sendMessage(bot: SprucebotLlmBot<Schema>): Promise<string>;
+}
+export interface PromptOptions<StateSchema extends Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> {
+    /**
+     * Tell the bot who/what it is. Example: youAre: "a super funny comedian. You absolutely love dad jokes!"
+     */
+    youAre: string;
+    stateSchema?: StateSchema;
+    state?: Partial<State>;
+    skill?: SerializedSkill<Schema>;
+}
+export interface SerializedBot<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends PromptOptions<Schema, State> {
+    messages: LlmMessage[];
+}
+export declare const llmEventContract: {
+    eventSignatures: {
+        'did-update-state': {};
+    };
+};
+export type LlmEventContract = typeof llmEventContract;
+export interface LlmMessage {
+    from: 'Me' | 'You';
+    message: string;
+}
+export interface SkillOptions<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> {
+    yourJobIfYouChooseToAcceptItIs: string;
+    weAreDoneWhen?: string;
+    pleaseKeepInMindThat?: string[];
+    stateSchema?: StateSchema;
+    state?: Partial<State>;
+    callbacks?: LlmCallbackMap;
+}
+export interface SprucebotLLmSkill<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends MercuryEventEmitter<LlmEventContract> {
+    getState(): Partial<State> | undefined;
+    serialize(): SerializedSkill<StateSchema, State>;
+    updateState(state: Partial<State>): Promise<void>;
+}
+export interface SerializedSkill<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends SkillOptions<StateSchema, State> {
+}
+export interface LlmCallbackMap {
+    [key: string]: LlmCallback;
+}
+export interface LlmCallback {
+    cb: () => string | Promise<string>;
+    useThisWhenever: string;
+}

package/build/esm/llm.types.js

@@ -0,0 +1,6 @@
+import { buildEventContract, } from '@sprucelabs/mercury-types';
+export const llmEventContract = buildEventContract({
+    eventSignatures: {
+        'did-update-state': {},
+    },
+});

package/build/esm/parsingResponses/ResponseParser.d.ts

@@ -0,0 +1,15 @@
+import { LlmCallbackMap } from '../llm.types';
+export default class ResponseParser {
+    private static instance;
+    static setInstance(parser: ResponseParser): void;
+    static getInstance(): ResponseParser;
+    parse(response: string, callbacks?: LlmCallbackMap): Promise<ParsedResponse>;
+    private invokeCallback;
+    private doesIncludeDoneToken;
+    private parseState;
+}
+export interface ParsedResponse {
+    isDone: boolean;
+    state?: Record<string, any>;
+    message: string;
+}

package/build/esm/parsingResponses/ResponseParser.js

@@ -0,0 +1,60 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { DONE_TOKEN, STATE_BOUNDARY } from '../bots/templates.js';
+import renderPlaceholder from './renderPlaceholder.js';
+export default class ResponseParser {
+    static setInstance(parser) {
+        this.instance = parser;
+    }
+    static getInstance() {
+        return this.instance;
+    }
+    parse(response, callbacks) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let message = response.replace(DONE_TOKEN, '').trim();
+            let state;
+            for (const key of Object.keys(callbacks || {})) {
+                const match = message.match(renderPlaceholder(key));
+                if (match) {
+                    message = yield this.invokeCallback(callbacks, key, message);
+                }
+            }
+            const { match, fullMatch } = this.parseState(message);
+            if (match && fullMatch) {
+                message = message.replace(fullMatch, '').trim();
+                state = JSON.parse(match);
+            }
+            return {
+                isDone: this.doesIncludeDoneToken(response),
+                state,
+                message,
+            };
+        });
+    }
+    invokeCallback(callbacks, key, message) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const v = yield ((_a = callbacks === null || callbacks === void 0 ? void 0 : callbacks[key]) === null || _a === void 0 ? void 0 : _a.cb());
+            message = message.replace(renderPlaceholder(key), v !== null && v !== void 0 ? v : '').trim();
+            return message;
+        });
+    }
+    doesIncludeDoneToken(response) {
+        return response.includes(DONE_TOKEN);
+    }
+    parseState(message) {
+        const ESCAPED_BOUNDARY = STATE_BOUNDARY.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
+        const searchRegex = new RegExp(`${ESCAPED_BOUNDARY}(.*?)${ESCAPED_BOUNDARY}`);
+        const stateMatches = message.match(searchRegex);
+        const match = stateMatches === null || stateMatches === void 0 ? void 0 : stateMatches[1];
+        return { match, fullMatch: stateMatches === null || stateMatches === void 0 ? void 0 : stateMatches[0] };
+    }
+}
+ResponseParser.instance = new ResponseParser();

package/build/esm/parsingResponses/renderPlaceholder.d.ts

@@ -0,0 +1 @@
+export default function renderPlaceholder(key: string): string;

package/build/esm/parsingResponses/renderPlaceholder.js

@@ -0,0 +1,4 @@
+import { CALLBACK_BOUNDARY } from '../bots/templates.js';
+export default function renderPlaceholder(key) {
+    return `${CALLBACK_BOUNDARY} ${key} ${CALLBACK_BOUNDARY}`;
+}

package/build/examples/buildCallbackSkill.d.ts

@@ -0,0 +1,2 @@
+import SprucebotLlmFactory from '../bots/SprucebotLlmFactory';
+export default function buildCallbackSkill(bots: SprucebotLlmFactory): import("../llm.types").SprucebotLLmSkill<import("@sprucelabs/schema").Schema, import("@sprucelabs/schema").SchemaStaticValues<import("@sprucelabs/schema").Schema, false, never, import("@sprucelabs/schema").StaticSchemaAllValues<import("@sprucelabs/schema").Schema, false>>>;

package/build/examples/buildCallbackSkill.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function buildCallbackSkill(bots) {
+    return bots.Skill({
+        yourJobIfYouChooseToAcceptItIs: "to be be the best appointment taker on the planet. You have a many years of experience. You are going to ask me only 2 questions for this practice run. First, you'll ask me to pick an available time. Then, you'll ask me to pick my favorite color:",
+        callbacks: {
+            availableTimes: {
+                cb: async () => {
+                    return ['9am', '10am', '11am', '1pm', '4pm', '5pm', '12am.'].join('\n');
+                },
+                useThisWhenever: 'your are showing what times i can pick from.',
+            },
+            favoriteColor: {
+                cb: async () => {
+                    return ['red', 'blue', 'green', 'purple'].join('\n');
+                },
+                useThisWhenever: 'your are showing what colors i can pick from.',
+            },
+        },
+    });
+}
+exports.default = buildCallbackSkill;

package/build/examples/buildJokeSkill.d.ts

@@ -0,0 +1,2 @@
+import SprucebotLlmFactory from '../bots/SprucebotLlmFactory';
+export default function buildJokeSkill(bots: SprucebotLlmFactory): import("../llm.types").SprucebotLLmSkill<import("@sprucelabs/schema").Schema, import("@sprucelabs/schema").SchemaStaticValues<import("@sprucelabs/schema").Schema, false, never, import("@sprucelabs/schema").StaticSchemaAllValues<import("@sprucelabs/schema").Schema, false>>>;

package/build/examples/buildJokeSkill.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function buildJokeSkill(bots) {
+    return bots.Skill({
+        yourJobIfYouChooseToAcceptItIs: 'to tell knock knock jokes!',
+        pleaseKeepInMindThat: [
+            'our audience is younger, so keep it PG!',
+            'you should never laugh when someone does not get the joke.',
+            "after each joke, you should tell me how many jokes you have left to tell before we're done.",
+            'you should acknowledge if someone laughs at your joke by saying "Thanks!" or "Glad you thought that was funny"!',
+        ],
+        weAreDoneWhen: 'you have told 3 jokes!',
+    });
+}
+exports.default = buildJokeSkill;

package/build/examples/buildProfileSkill.d.ts

@@ -0,0 +1,2 @@
+import SprucebotLlmFactory from '../bots/SprucebotLlmFactory';
+export default function buildProfileSkill(bots: SprucebotLlmFactory): import("../llm.types").SprucebotLLmSkill<import("@sprucelabs/schema").Schema, import("@sprucelabs/schema").SchemaStaticValues<import("@sprucelabs/schema").Schema, false, never, import("@sprucelabs/schema").StaticSchemaAllValues<import("@sprucelabs/schema").Schema, false>>>;

package/build/examples/buildProfileSkill.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+function buildProfileSkill(bots) {
+    return bots.Skill({
+        yourJobIfYouChooseToAcceptItIs: 'to collect some information from me! You are a receptionist with 20 years experience and are very focused on getting answers needed to complete my profile',
+        stateSchema: (0, schema_1.buildSchema)({
+            id: 'profile',
+            fields: {
+                firstName: {
+                    type: 'text',
+                    label: 'First name',
+                },
+                lastName: {
+                    type: 'text',
+                    label: 'Last name',
+                },
+                favoriteColor: {
+                    type: 'select',
+                    options: {
+                        choices: [
+                            { label: 'Red', value: 'red' },
+                            { label: 'Blue', value: 'blue' },
+                            { label: 'Green', value: 'green' },
+                        ],
+                    },
+                },
+            },
+        }),
+    });
+}
+exports.default = buildProfileSkill;

package/build/index.js

@@ -0,0 +1,2 @@
+"use strict";
+//exports go here

package/build/llm.types.d.ts

@@ -0,0 +1,61 @@
+import { MercuryEventEmitter } from '@sprucelabs/mercury-types';
+import { Schema, SchemaValues } from '@sprucelabs/schema';
+export interface BotOptions<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends Omit<PromptOptions<StateSchema, State>, 'skill'> {
+    adapter: LlmAdapter;
+    Class?: new (...opts: any[]) => SprucebotLlmBot<Schema, State>;
+    skill?: SprucebotLLmSkill<Schema>;
+}
+export interface SprucebotLlmBot<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends MercuryEventEmitter<LlmEventContract> {
+    markAsDone(): void;
+    getIsDone(): boolean;
+    sendMessage(message: string): Promise<string>;
+    serialize(): SerializedBot<StateSchema, State>;
+    updateState(state: Partial<State>): Promise<void>;
+}
+export interface LlmAdapter {
+    sendMessage(bot: SprucebotLlmBot<Schema>): Promise<string>;
+}
+export interface PromptOptions<StateSchema extends Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> {
+    /**
+     * Tell the bot who/what it is. Example: youAre: "a super funny comedian. You absolutely love dad jokes!"
+     */
+    youAre: string;
+    stateSchema?: StateSchema;
+    state?: Partial<State>;
+    skill?: SerializedSkill<Schema>;
+}
+export interface SerializedBot<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends PromptOptions<Schema, State> {
+    messages: LlmMessage[];
+}
+export declare const llmEventContract: {
+    eventSignatures: {
+        'did-update-state': {};
+    };
+};
+export type LlmEventContract = typeof llmEventContract;
+export interface LlmMessage {
+    from: 'Me' | 'You';
+    message: string;
+}
+export interface SkillOptions<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> {
+    yourJobIfYouChooseToAcceptItIs: string;
+    weAreDoneWhen?: string;
+    pleaseKeepInMindThat?: string[];
+    stateSchema?: StateSchema;
+    state?: Partial<State>;
+    callbacks?: LlmCallbackMap;
+}
+export interface SprucebotLLmSkill<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends MercuryEventEmitter<LlmEventContract> {
+    getState(): Partial<State> | undefined;
+    serialize(): SerializedSkill<StateSchema, State>;
+    updateState(state: Partial<State>): Promise<void>;
+}
+export interface SerializedSkill<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends SkillOptions<StateSchema, State> {
+}
+export interface LlmCallbackMap {
+    [key: string]: LlmCallback;
+}
+export interface LlmCallback {
+    cb: () => string | Promise<string>;
+    useThisWhenever: string;
+}

package/build/llm.types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.llmEventContract = void 0;
+const mercury_types_1 = require("@sprucelabs/mercury-types");
+exports.llmEventContract = (0, mercury_types_1.buildEventContract)({
+    eventSignatures: {
+        'did-update-state': {},
+    },
+});

package/build/parsingResponses/ResponseParser.d.ts

@@ -0,0 +1,15 @@
+import { LlmCallbackMap } from '../llm.types';
+export default class ResponseParser {
+    private static instance;
+    static setInstance(parser: ResponseParser): void;
+    static getInstance(): ResponseParser;
+    parse(response: string, callbacks?: LlmCallbackMap): Promise<ParsedResponse>;
+    private invokeCallback;
+    private doesIncludeDoneToken;
+    private parseState;
+}
+export interface ParsedResponse {
+    isDone: boolean;
+    state?: Record<string, any>;
+    message: string;
+}

package/build/parsingResponses/ResponseParser.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const templates_1 = require("../bots/templates");
+const renderPlaceholder_1 = __importDefault(require("./renderPlaceholder"));
+class ResponseParser {
+    static setInstance(parser) {
+        this.instance = parser;
+    }
+    static getInstance() {
+        return this.instance;
+    }
+    async parse(response, callbacks) {
+        let message = response.replace(templates_1.DONE_TOKEN, '').trim();
+        let state;
+        for (const key of Object.keys(callbacks || {})) {
+            const match = message.match((0, renderPlaceholder_1.default)(key));
+            if (match) {
+                message = await this.invokeCallback(callbacks, key, message);
+            }
+        }
+        const { match, fullMatch } = this.parseState(message);
+        if (match && fullMatch) {
+            message = message.replace(fullMatch, '').trim();
+            state = JSON.parse(match);
+        }
+        return {
+            isDone: this.doesIncludeDoneToken(response),
+            state,
+            message,
+        };
+    }
+    async invokeCallback(callbacks, key, message) {
+        var _a;
+        const v = await ((_a = callbacks === null || callbacks === void 0 ? void 0 : callbacks[key]) === null || _a === void 0 ? void 0 : _a.cb());
+        message = message.replace((0, renderPlaceholder_1.default)(key), v !== null && v !== void 0 ? v : '').trim();
+        return message;
+    }
+    doesIncludeDoneToken(response) {
+        return response.includes(templates_1.DONE_TOKEN);
+    }
+    parseState(message) {
+        const ESCAPED_BOUNDARY = templates_1.STATE_BOUNDARY.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
+        const searchRegex = new RegExp(`${ESCAPED_BOUNDARY}(.*?)${ESCAPED_BOUNDARY}`);
+        const stateMatches = message.match(searchRegex);
+        const match = stateMatches === null || stateMatches === void 0 ? void 0 : stateMatches[1];
+        return { match, fullMatch: stateMatches === null || stateMatches === void 0 ? void 0 : stateMatches[0] };
+    }
+}
+exports.default = ResponseParser;
+ResponseParser.instance = new ResponseParser();

package/build/parsingResponses/renderPlaceholder.d.ts

@@ -0,0 +1 @@
+export default function renderPlaceholder(key: string): string;