@sprucelabs/sprucebot-llm 11.1.13 → 11.1.14

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

@@ -1,84 +0,0 @@
-import { MercuryEventEmitter } from '@sprucelabs/mercury-types';
-import { Schema, SchemaValues, SelectFieldDefinition } 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: SendMessage, responseCb?: MessageResponseCallback): Promise<string>;
-    serialize(): SerializedBot<StateSchema, State>;
-    updateState(state: Partial<State>): Promise<void>;
-    setSkill(skill: SprucebotLLmSkill<any>): void;
-    clearMessageHistory(): void;
-}
-export interface LlmAdapter {
-    sendMessage(bot: SprucebotLlmBot<Schema>, options?: SendMessageOptions): 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 SendMessageOptions {
-    model?: string;
-}
-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 type LlmMessageFrom = 'Me' | 'You' | 'Api';
-export interface LlmMessage {
-    from: LlmMessageFrom;
-    message: string;
-    imageBase64?: 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;
-    model?: string;
-}
-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 type LlmCallbackMap = Record<string, LlmCallback>;
-export type LmmCallbackResponse = void | SendMessage;
-export interface LlmCallback {
-    cb: (options?: Record<string, any>) => LmmCallbackResponse | Promise<LmmCallbackResponse>;
-    useThisWhenever: string;
-    parameters?: LlmCallbackParameter[];
-}
-export type LlmCallbackParameter = {
-    name: string;
-    type: ('text' | 'number' | 'boolean' | 'dateMs' | 'dateTimeMs') | (string & {});
-    isRequired?: boolean;
-    description?: string;
-} | (SelectFieldDefinition & {
-    name: string;
-    description?: string;
-});
-export type MessageResponseCallback = (message: string) => any;
-export type SendMessage = string | SendMessageWithImage;
-export interface SendMessageWithImage {
-    imageDescription: string;
-    imageBase64: string;
-}

package/build/esm/llm.types.js

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

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

@@ -1,18 +0,0 @@
-import { LlmCallbackMap, SendMessage } 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 findFirstBadCallback;
-    private invokeCallbackAndDropInLegacyResults;
-    private doesIncludeDoneToken;
-    private parseState;
-    private assertAtMostOneCallback;
-}
-export interface ParsedResponse {
-    isDone: boolean;
-    state?: Record<string, any>;
-    message: string;
-    callbackResults?: SendMessage;
-}

package/build/esm/parsingResponses/ResponseParser.js

@@ -1,115 +0,0 @@
-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 SpruceError from '../errors/SpruceError.js';
-import renderPlaceholder from './renderPlaceholder.js';
-class ResponseParser {
-    static setInstance(parser) {
-        this.instance = parser;
-    }
-    static getInstance() {
-        return this.instance;
-    }
-    parse(response, callbacks) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            let message = response.replace(DONE_TOKEN, '').trim();
-            let state;
-            let callbackResults;
-            let callbacksInvoked = 0;
-            for (const key of Object.keys(callbacks || {})) {
-                const match = message.match(renderPlaceholder(key));
-                if (match) {
-                    message = yield this.invokeCallbackAndDropInLegacyResults(callbacks, key, message);
-                }
-                let xmlCallMatches = message.match(new RegExp(`<<\\s*${key}\\s*\/>>`, 'g'));
-                let data;
-                if (!xmlCallMatches) {
-                    const matchWithJson = message
-                        .matchAll(new RegExp(`<<\\s*${key}\\s*>>(.*?)<<\/\\s*${key}\\s*>>`, 'gs'))
-                        .next().value;
-                    xmlCallMatches = (matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[0])
-                        ? [matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[0]]
-                        : null;
-                    data = (matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[1])
-                        ? JSON.parse(matchWithJson === null || matchWithJson === void 0 ? void 0 : matchWithJson[1])
-                        : undefined;
-                }
-                if (xmlCallMatches) {
-                    this.assertAtMostOneCallback(++callbacksInvoked);
-                    try {
-                        callbackResults = yield ((_a = callbacks === null || callbacks === void 0 ? void 0 : callbacks[key]) === null || _a === void 0 ? void 0 : _a.cb(data));
-                        message = message.replace(xmlCallMatches[0], '').trim();
-                    }
-                    catch (error) {
-                        throw new SpruceError({
-                            code: 'CALLBACK_ERROR',
-                            friendlyMessage: `Error while executing callback (${key}). The error is: ${error.message}`,
-                            originalError: error,
-                        });
-                    }
-                }
-            }
-            const matchedCallback = this.findFirstBadCallback(message);
-            if (matchedCallback) {
-                throw new SpruceError({
-                    code: 'INVALID_CALLBACK',
-                    validCallbacks: Object.keys(callbacks !== null && callbacks !== void 0 ? callbacks : {}),
-                    matchedCallback,
-                });
-            }
-            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,
-                callbackResults: callbackResults !== null && callbackResults !== void 0 ? callbackResults : undefined,
-            };
-        });
-    }
-    findFirstBadCallback(message) {
-        const simpleMatches = message.match(new RegExp(`<<(.*)\/?>>`, 'g'));
-        const extraJsonMatches = message.match(new RegExp(`<<.*?>>(.*?)<<\/.*?>>`, 'gs'));
-        const matchedCallback = (extraJsonMatches === null || extraJsonMatches === void 0 ? void 0 : extraJsonMatches[0]) || (simpleMatches === null || simpleMatches === void 0 ? void 0 : simpleMatches[0]);
-        return matchedCallback;
-    }
-    invokeCallbackAndDropInLegacyResults(callbacks, key, message) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            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] };
-    }
-    assertAtMostOneCallback(invocations) {
-        if (invocations > 1) {
-            throw new SpruceError({
-                code: 'CALLBACK_ERROR',
-                friendlyMessage: 'You can only invoke one callback per message.',
-            });
-        }
-    }
-}
-ResponseParser.instance = new ResponseParser();
-export default ResponseParser;

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

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

package/build/esm/parsingResponses/renderPlaceholder.js

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

package/build/esm/tests/MockLlmSkill.d.ts

@@ -1,14 +0,0 @@
-import { Schema, SchemaValues } from '@sprucelabs/schema';
-import SprucebotLlmSkillImpl from '../bots/SprucebotLlmSkillImpl';
-import { LlmCallback, SkillOptions } from '../llm.types';
-export default class MockLlmSkill<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends SprucebotLlmSkillImpl<StateSchema, State> {
-    static instance: MockLlmSkill;
-    constructor(options: SkillOptions<StateSchema, State>);
-    assertYourJobEquals(expected: string): void;
-    assertWeAreDoneWhenEquals(expected: string | undefined): void;
-    assertPleaseKeepInMindEquals(expected: string[] | undefined): void;
-    assertModelEquals(model: string | undefined): void;
-    assertStateSchemaEquals(expected: Schema | undefined): void;
-    assertHasCallback(name: string, expectedOptions?: Omit<LlmCallback, 'cb'>): (options?: Record<string, any>) => import("../llm.types").LmmCallbackResponse | Promise<import("../llm.types").LmmCallbackResponse>;
-    invokeCallback(cbName: string, options?: Record<string, any>): Promise<import("../llm.types").LmmCallbackResponse>;
-}

package/build/esm/tests/MockLlmSkill.js

@@ -1,60 +0,0 @@
-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());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-import { assertOptions } from '@sprucelabs/schema';
-import { assert } from '@sprucelabs/test-utils';
-import SprucebotLlmSkillImpl from '../bots/SprucebotLlmSkillImpl.js';
-export default class MockLlmSkill extends SprucebotLlmSkillImpl {
-    constructor(options) {
-        super(options);
-        assertOptions(options, ['yourJobIfYouChooseToAcceptItIs']);
-        MockLlmSkill.instance = this;
-    }
-    assertYourJobEquals(expected) {
-        assert.isEqual(this.options.yourJobIfYouChooseToAcceptItIs, expected, 'yourJobIfYouChooseToAcceptItIs passed to constructor does not equal expected');
-    }
-    assertWeAreDoneWhenEquals(expected) {
-        assert.isEqual(this.options.weAreDoneWhen, expected, 'weAreDoneWhen passed to constructor does not equal expected');
-    }
-    assertPleaseKeepInMindEquals(expected) {
-        assert.isEqualDeep(this.options.pleaseKeepInMindThat, expected, 'pleaseKeepInMindThat passed to constructor does not equal expected');
-    }
-    assertModelEquals(model) {
-        assert.isEqual(this.options.model, model, 'model passed to constructor does not equal expected');
-    }
-    assertStateSchemaEquals(expected) {
-        assert.isEqualDeep(this.stateSchema, expected, 'stateSchema passed to constructor does not equal expected');
-    }
-    assertHasCallback(name, expectedOptions) {
-        var _a, _b;
-        const _c = (_b = (_a = this.options.callbacks) === null || _a === void 0 ? void 0 : _a[name]) !== null && _b !== void 0 ? _b : {}, { cb } = _c, options = __rest(_c, ["cb"]);
-        assert.isTruthy(cb, 'Could not find callback with name: ' + name);
-        if (expectedOptions) {
-            assert.isEqualDeep(options, expectedOptions, `the options for the '${name}' callback don\`t match`);
-        }
-        return cb;
-    }
-    invokeCallback(cbName, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const cb = this.assertHasCallback(cbName);
-            return yield cb(options);
-        });
-    }
-}

package/build/esm/tests/SpyAdapter.d.ts

@@ -1,8 +0,0 @@
-import { LlmAdapter, SendMessageOptions, SprucebotLlmBot } from '../llm.types';
-export default class SpyLlmAdapter implements LlmAdapter {
-    lastBot?: SprucebotLlmBot;
-    lastMessage?: string;
-    messageResponse: string;
-    lastSendOptions?: SendMessageOptions;
-    sendMessage(bot: SprucebotLlmBot, options?: SendMessageOptions): Promise<string>;
-}

package/build/esm/tests/SpyAdapter.js

@@ -1,21 +0,0 @@
-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 class SpyLlmAdapter {
-    constructor() {
-        this.messageResponse = '';
-    }
-    sendMessage(bot, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.lastBot = bot;
-            this.lastSendOptions = options;
-            return this.messageResponse;
-        });
-    }
-}

package/build/esm/tests/SpyLlmBot.d.ts

@@ -1,12 +0,0 @@
-import { Schema, SchemaValues } from '@sprucelabs/schema';
-import SprucebotLlmBotImpl from '../bots/SprucebotLlmBotImpl';
-import { BotOptions, LlmMessage, SprucebotLlmBot } from '../llm.types';
-export default class SpyLlmBot<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends SprucebotLlmBotImpl<StateSchema, State> implements SprucebotLlmBot {
-    static instance: SpyLlmBot;
-    constructorOptions: BotOptions<StateSchema, State>;
-    constructor(options: BotOptions<StateSchema, State>);
-    getState(): Partial<State> | undefined;
-    getSkill(): import("../llm.types").SprucebotLLmSkill<Schema, Pick<import("@sprucelabs/schema").SchemaStaticValues<Schema, false, never, import("@sprucelabs/schema").StaticSchemaAllValues<Schema, false>>, never>> | undefined;
-    setMessages(messages: LlmMessage[]): void;
-    getMessages(): LlmMessage[];
-}

package/build/esm/tests/SpyLlmBot.js

@@ -1,20 +0,0 @@
-import SprucebotLlmBotImpl from '../bots/SprucebotLlmBotImpl.js';
-export default class SpyLlmBot extends SprucebotLlmBotImpl {
-    constructor(options) {
-        super(options);
-        SpyLlmBot.instance = this;
-        this.constructorOptions = options;
-    }
-    getState() {
-        return this.state;
-    }
-    getSkill() {
-        return this.skill;
-    }
-    setMessages(messages) {
-        this.messages = messages;
-    }
-    getMessages() {
-        return this.messages;
-    }
-}