@sprucelabs/sprucebot-llm 8.5.1 → 8.6.1

package/build/bots/SprucebotLlmFactory.d.ts

@@ -1,7 +1,7 @@
 import { BotOptions, LlmAdapter, SkillOptions, SprucebotLlmBot, SprucebotLLmSkill } from '../llm.types';
 export default class SprucebotLlmFactory {
-    private instance?;
     protected adapter: LlmAdapter;
+    private instance?;
     static FactoryClass?: typeof SprucebotLlmFactory;
     static BotClass?: new (options: any) => SprucebotLlmBot;
     static SkillClass?: new (options: any) => SprucebotLLmSkill;

package/build/bots/SprucebotLlmSkillImpl.d.ts

@@ -2,9 +2,9 @@ import { AbstractEventEmitter } from '@sprucelabs/mercury-event-emitter';
 import { Schema, SchemaValues } from '@sprucelabs/schema';
 import { LlmEventContract, SerializedSkill, SkillOptions, SprucebotLLmSkill } from '../llm.types';
 export default class SprucebotLlmSkillImpl<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends AbstractEventEmitter<LlmEventContract> implements SprucebotLLmSkill<StateSchema, State> {
-    private options;
+    protected options: SkillOptions;
     private state?;
-    private stateSchema?;
+    protected stateSchema?: StateSchema;
     constructor(options: SkillOptions<StateSchema, State>);
     updateState(updates: Partial<State>): Promise<void>;
     getState(): Partial<State> | undefined;

package/build/bots/SprucebotLlmSkillImpl.js

@@ -7,7 +7,7 @@ class SprucebotLlmSkillImpl extends mercury_event_emitter_1.AbstractEventEmitter
     constructor(options) {
         super(llm_types_1.llmEventContract);
         this.state = {};
-        const { state, stateSchema, ...rest } = options;
+        const { state, stateSchema, ...rest } = options ?? {};
         this.options = { ...rest, stateSchema };
         this.stateSchema = stateSchema;
         this.state = stateSchema

package/build/esm/bots/SprucebotLlmFactory.d.ts

@@ -1,7 +1,7 @@
 import { BotOptions, LlmAdapter, SkillOptions, SprucebotLlmBot, SprucebotLLmSkill } from '../llm.types';
 export default class SprucebotLlmFactory {
-    private instance?;
     protected adapter: LlmAdapter;
+    private instance?;
     static FactoryClass?: typeof SprucebotLlmFactory;
     static BotClass?: new (options: any) => SprucebotLlmBot;
     static SkillClass?: new (options: any) => SprucebotLLmSkill;

package/build/esm/bots/SprucebotLlmSkillImpl.d.ts

@@ -2,9 +2,9 @@ import { AbstractEventEmitter } from '@sprucelabs/mercury-event-emitter';
 import { Schema, SchemaValues } from '@sprucelabs/schema';
 import { LlmEventContract, SerializedSkill, SkillOptions, SprucebotLLmSkill } from '../llm.types';
 export default class SprucebotLlmSkillImpl<StateSchema extends Schema = Schema, State extends SchemaValues<StateSchema> = SchemaValues<StateSchema>> extends AbstractEventEmitter<LlmEventContract> implements SprucebotLLmSkill<StateSchema, State> {
-    private options;
+    protected options: SkillOptions;
     private state?;
-    private stateSchema?;
+    protected stateSchema?: StateSchema;
     constructor(options: SkillOptions<StateSchema, State>);
     updateState(updates: Partial<State>): Promise<void>;
     getState(): Partial<State> | undefined;

package/build/esm/bots/SprucebotLlmSkillImpl.js

@@ -25,7 +25,7 @@ export default class SprucebotLlmSkillImpl extends AbstractEventEmitter {
     constructor(options) {
         super(llmEventContract);
         this.state = {};
-        const { state, stateSchema } = options, rest = __rest(options, ["state", "stateSchema"]);
+        const _a = options !== null && options !== void 0 ? options : {}, { state, stateSchema } = _a, rest = __rest(_a, ["state", "stateSchema"]);
         this.options = Object.assign(Object.assign({}, rest), { stateSchema });
         this.stateSchema = stateSchema;
         this.state = stateSchema

package/build/esm/index.d.ts

@@ -4,3 +4,6 @@ export { default as SprucebotLlmSkillImpl } from './bots/SprucebotLlmSkillImpl';
 export { OpenAiAdapter } from './bots/adapters/OpenAi';
 export * from './llm.types';
 export { default as SprucebotLlmError } from './errors/SpruceError';
+export { default as MockLlmSkill } from './tests/MockLlmSkill';
+export { default as SpyLllmBot } from './tests/SpyLlmBot';
+export { default as SpyLlmAdapter } from './tests/SpyAdapter';

package/build/esm/index.js

@@ -4,3 +4,6 @@ export { default as SprucebotLlmSkillImpl } from './bots/SprucebotLlmSkillImpl.j
 export { OpenAiAdapter } from './bots/adapters/OpenAi.js';
 export * from './llm.types.js';
 export { default as SprucebotLlmError } from './errors/SpruceError.js';
+export { default as MockLlmSkill } from './tests/MockLlmSkill.js';
+export { default as SpyLllmBot } from './tests/SpyLlmBot.js';
+export { default as SpyLlmAdapter } from './tests/SpyAdapter.js';

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

@@ -0,0 +1,13 @@
+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'>): void;
+}

package/build/esm/tests/MockLlmSkill.js

@@ -0,0 +1,44 @@
+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`);
+        }
+    }
+}

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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,21 @@
+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

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

package/build/esm/tests/SpyLlmBot.js

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

package/build/index.d.ts

@@ -4,3 +4,6 @@ export { default as SprucebotLlmSkillImpl } from './bots/SprucebotLlmSkillImpl';
 export { OpenAiAdapter } from './bots/adapters/OpenAi';
 export * from './llm.types';
 export { default as SprucebotLlmError } from './errors/SpruceError';
+export { default as MockLlmSkill } from './tests/MockLlmSkill';
+export { default as SpyLllmBot } from './tests/SpyLlmBot';
+export { default as SpyLlmAdapter } from './tests/SpyAdapter';

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SprucebotLlmError = exports.OpenAiAdapter = exports.SprucebotLlmSkillImpl = exports.SprucebotLlmBotImpl = exports.SprucebotLlmFactory = void 0;
+exports.SpyLlmAdapter = exports.SpyLllmBot = exports.MockLlmSkill = exports.SprucebotLlmError = exports.OpenAiAdapter = exports.SprucebotLlmSkillImpl = exports.SprucebotLlmBotImpl = exports.SprucebotLlmFactory = void 0;
 var SprucebotLlmFactory_1 = require("./bots/SprucebotLlmFactory");
 Object.defineProperty(exports, "SprucebotLlmFactory", { enumerable: true, get: function () { return __importDefault(SprucebotLlmFactory_1).default; } });
 var SprucebotLlmBotImpl_1 = require("./bots/SprucebotLlmBotImpl");
@@ -29,3 +29,9 @@ Object.defineProperty(exports, "OpenAiAdapter", { enumerable: true, get: functio
 __exportStar(require("./llm.types"), exports);
 var SpruceError_1 = require("./errors/SpruceError");
 Object.defineProperty(exports, "SprucebotLlmError", { enumerable: true, get: function () { return __importDefault(SpruceError_1).default; } });
+var MockLlmSkill_1 = require("./tests/MockLlmSkill");
+Object.defineProperty(exports, "MockLlmSkill", { enumerable: true, get: function () { return __importDefault(MockLlmSkill_1).default; } });
+var SpyLlmBot_1 = require("./tests/SpyLlmBot");
+Object.defineProperty(exports, "SpyLllmBot", { enumerable: true, get: function () { return __importDefault(SpyLlmBot_1).default; } });
+var SpyAdapter_1 = require("./tests/SpyAdapter");
+Object.defineProperty(exports, "SpyLlmAdapter", { enumerable: true, get: function () { return __importDefault(SpyAdapter_1).default; } });

package/build/tests/MockLlmSkill.d.ts

@@ -0,0 +1,13 @@
+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'>): void;
+}

package/build/tests/MockLlmSkill.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+const test_utils_1 = require("@sprucelabs/test-utils");
+const SprucebotLlmSkillImpl_1 = __importDefault(require("../bots/SprucebotLlmSkillImpl"));
+class MockLlmSkill extends SprucebotLlmSkillImpl_1.default {
+    constructor(options) {
+        super(options);
+        (0, schema_1.assertOptions)(options, ['yourJobIfYouChooseToAcceptItIs']);
+        MockLlmSkill.instance = this;
+    }
+    assertYourJobEquals(expected) {
+        test_utils_1.assert.isEqual(this.options.yourJobIfYouChooseToAcceptItIs, expected, 'yourJobIfYouChooseToAcceptItIs passed to constructor does not equal expected');
+    }
+    assertWeAreDoneWhenEquals(expected) {
+        test_utils_1.assert.isEqual(this.options.weAreDoneWhen, expected, 'weAreDoneWhen passed to constructor does not equal expected');
+    }
+    assertPleaseKeepInMindEquals(expected) {
+        test_utils_1.assert.isEqualDeep(this.options.pleaseKeepInMindThat, expected, 'pleaseKeepInMindThat passed to constructor does not equal expected');
+    }
+    assertModelEquals(model) {
+        test_utils_1.assert.isEqual(this.options.model, model, 'model passed to constructor does not equal expected');
+    }
+    assertStateSchemaEquals(expected) {
+        test_utils_1.assert.isEqualDeep(this.stateSchema, expected, 'stateSchema passed to constructor does not equal expected');
+    }
+    assertHasCallback(name, expectedOptions) {
+        const { cb, ...options } = this.options.callbacks?.[name] ?? {};
+        test_utils_1.assert.isTruthy(cb, 'Could not find callback with name: ' + name);
+        if (expectedOptions) {
+            test_utils_1.assert.isEqualDeep(options, expectedOptions, `the options for the '${name}' callback don\`t match`);
+        }
+    }
+}
+exports.default = MockLlmSkill;

package/build/tests/SpyAdapter.d.ts

@@ -0,0 +1,8 @@
+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/tests/SpyAdapter.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class SpyLlmAdapter {
+    constructor() {
+        this.messageResponse = '';
+    }
+    async sendMessage(bot, options) {
+        this.lastBot = bot;
+        this.lastSendOptions = options;
+        return this.messageResponse;
+    }
+}
+exports.default = SpyLlmAdapter;

package/build/tests/SpyLlmBot.d.ts

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

package/build/tests/SpyLlmBot.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const SprucebotLlmBotImpl_1 = __importDefault(require("../bots/SprucebotLlmBotImpl"));
+class SpyLlmBot extends SprucebotLlmBotImpl_1.default {
+    getState() {
+        return this.state;
+    }
+    getSkill() {
+        return this.skill;
+    }
+    setMessages(messages) {
+        this.messages = messages;
+    }
+    getMessages() {
+        return this.messages;
+    }
+}
+exports.default = SpyLlmBot;

package/package.json

@@ -9,7 +9,7 @@
       "@sprucelabs/spruce-test-fixtures"
     ]
   },
-  "version": "8.5.1",
+  "version": "8.6.1",
   "files": [
     "build"
   ],