@sprucelabs/spruce-conversation-plugin 56.0.37 → 56.1.0

package/build/__tests__/behavioral/RegisteringConversationsOnBoot.test.d.ts

@@ -6,6 +6,8 @@ export default class RegisteringConversationsOnBootTest extends AbstractConversa
     protected static skillShutsDownWhenConvosFailToRegister(): Promise<void>;
     protected static canBootASecondTime(): Promise<void>;
     protected static skillCanBootASecondTime(): Promise<void>;
+    protected static coordinaterGetsSkillContext(): Promise<void>;
+    private static registerBootAndConnect;
     private static assertExpectedTopics;
     private static registerAndBoot;
 }

package/build/__tests__/behavioral/RegisteringConversationsOnBoot.test.js

@@ -24,12 +24,12 @@ class RegisteringConversationsOnBootTest extends AbstractConversationTest_1.defa
     }
     static async noConvosToStart() {
         this.cwd = this.resolveTestPath('empty-skill');
-        const topics = await this.registerAndBoot();
+        const { topics } = await this.registerAndBoot();
         test_utils_1.assert.isLength(topics, 0);
     }
     static async registersConvosOnBoot() {
         this.cwd = this.resolveTestPath('skill');
-        const topics = await this.registerAndBoot();
+        const { topics } = await this.registerAndBoot();
         this.assertExpectedTopics(topics);
     }
     static async skillShutsDownWhenConvosFailToRegister() {
@@ -39,9 +39,9 @@ class RegisteringConversationsOnBootTest extends AbstractConversationTest_1.defa
     }
     static async canBootASecondTime() {
         this.cwd = this.resolveTestPath('skill');
-        const topics = await this.registerAndBoot();
+        const { topics } = await this.registerAndBoot();
         this.assertExpectedTopics(topics);
-        const topics2 = await this.registerAndBoot({
+        const { topics: topics2 } = await this.registerAndBoot({
             skillId: process.env.SKILL_ID,
             apiKey: process.env.SKILL_API_KEY,
         });
@@ -55,6 +55,40 @@ class RegisteringConversationsOnBootTest extends AbstractConversationTest_1.defa
             apiKey: process.env.SKILL_API_KEY,
         });
     }
+    static async coordinaterGetsSkillContext() {
+        this.cwd = this.resolveTestPath('skill');
+        const { skill, client } = await this.registerBootAndConnect();
+        const id = (0, test_utils_1.generateId)();
+        await client.emitAndFlattenResponses('did-message::v2020_12_25', {
+            payload: {
+                message: this.buildMessage({
+                    body: (0, test_utils_1.generateId)(),
+                    source: {
+                        personId: id,
+                    },
+                }),
+            },
+        });
+        const conversations = skill.getFeatureByCode('conversation');
+        //@ts-ignore
+        const coordinator = await conversations.coordinatorsBySource[id];
+        test_utils_1.assert.isTruthy(coordinator);
+        //@ts-ignore
+        skill.updateContext('hello', 'world');
+        test_utils_1.assert.isEqualDeep(coordinator.getContext(), { hello: 'world' });
+        //@ts-ignore
+        skill.updateContext('hello2', 'world2');
+        test_utils_1.assert.isEqualDeep(coordinator.getContext(), {
+            hello: 'world',
+            hello2: 'world2',
+        });
+    }
+    static async registerBootAndConnect() {
+        const { skill } = await this.registerAndBoot();
+        const events = skill.getFeatureByCode('event');
+        const client = await events.connectToApi();
+        return { skill, client };
+    }
     static assertExpectedTopics(topics) {
         test_utils_1.assert.isLength(topics, 5);
         test_utils_1.assert.doesInclude(topics, { key: 'bookAppointment' });
@@ -82,7 +116,7 @@ class RegisteringConversationsOnBootTest extends AbstractConversationTest_1.defa
         const results = await client.emit('get-conversation-topics::v2020_12_25');
         const payload = spruce_event_utils_1.eventResponseUtil.getFirstResponseOrThrow(results);
         topics = payload.topics;
-        return topics;
+        return { topics, skill };
     }
 }
 __decorate([
@@ -103,4 +137,7 @@ __decorate([
 __decorate([
     (0, test_utils_1.test)()
 ], RegisteringConversationsOnBootTest, "skillCanBootASecondTime", null);
+__decorate([
+    (0, test_utils_1.test)()
+], RegisteringConversationsOnBootTest, "coordinaterGetsSkillContext", null);
 exports.default = RegisteringConversationsOnBootTest;

package/build/__tests__/implementation/ConversationCoordinator.test.d.ts

@@ -2,6 +2,7 @@ import AbstractConversationTest from '../../tests/AbstractConversationTest';
 export default class TopicCoordinatorTest extends AbstractConversationTest {
     private static coordinator;
     private static sentMessages;
+    private static skillContext;
     protected static beforeEach(): Promise<void>;
     protected static canCreateTopicCoordinator(): Promise<void>;
     protected static hasHandleMessage(): Promise<void>;
@@ -12,4 +13,5 @@ export default class TopicCoordinatorTest extends AbstractConversationTest {
     protected static playsScriptWhenTopicIsSelected(): Promise<void>;
     protected static canHandlePromptsInScript(): Promise<void>;
     protected static canPlaceMixedScriptsUntilTheEndAndStartsOver(): Promise<void>;
+    protected static passesThroughContextGetter(context: Record<string, any>): Promise<void>;
 }

package/build/__tests__/implementation/ConversationCoordinator.test.js

@@ -17,13 +17,15 @@ class TopicCoordinatorTest extends AbstractConversationTest_1.default {
     static async beforeEach() {
         await super.beforeEach();
         this.sentMessages = [];
-        this.coordinator = await ConversationCoordinator_1.ConversationCoordinator.Coordinator({
+        this.coordinator = (await ConversationCoordinator_1.ConversationCoordinator.Coordinator({
             lineDelay: 0,
             sendMessageHandler: async (message) => {
                 this.sentMessages.push(message);
             },
             topicLookupPath: this.resolveTestPath('skill', 'build'),
-        });
+            getContext: () => this.skillContext,
+            Class: SpyCoordinator,
+        }));
     }
     static async canCreateTopicCoordinator() {
         test_utils_1.assert.isTruthy(this.coordinator);
@@ -46,6 +48,7 @@ class TopicCoordinatorTest extends AbstractConversationTest_1.default {
         const coordinator = await ConversationCoordinator_1.ConversationCoordinator.Coordinator({
             topicLookupPath: this.cwd,
             sendMessageHandler: async () => { },
+            getContext: () => this.skillContext,
         });
         const results = await coordinator.handleMessage(this.buildMessage({ body: 'help me book!', source: { personId: '1234' } }));
         test_utils_1.assert.isArray(results.suggestedTopics);
@@ -110,8 +113,18 @@ class TopicCoordinatorTest extends AbstractConversationTest_1.default {
         test_utils_1.assert.isEqual((_h = this.sentMessages[0]) === null || _h === void 0 ? void 0 : _h.body, 'string 1');
         test_utils_1.assert.isEqual((_j = this.sentMessages[1]) === null || _j === void 0 ? void 0 : _j.body, 'prompt 1');
     }
+    static async passesThroughContextGetter(context) {
+        await this.coordinator.handleMessage(this.buildMessage({ body: 'answer 2', source: { personId: '1234' } }), 'bookAppointment');
+        this.skillContext = context;
+        const player = this.coordinator.getPlayer();
+        test_utils_1.assert.isTruthy(player);
+        //@ts-ignore
+        const actual = player.getContext();
+        test_utils_1.assert.isEqualDeep(actual, this.skillContext);
+    }
 }
 TopicCoordinatorTest.sentMessages = [];
+TopicCoordinatorTest.skillContext = {};
 __decorate([
     (0, test_utils_1.test)()
 ], TopicCoordinatorTest, "canCreateTopicCoordinator", null);
@@ -139,4 +152,13 @@ __decorate([
 __decorate([
     (0, test_utils_1.test)()
 ], TopicCoordinatorTest, "canPlaceMixedScriptsUntilTheEndAndStartsOver", null);
+__decorate([
+    (0, test_utils_1.test)('can passthrough context 1', { hello: 'world' }),
+    (0, test_utils_1.test)('can passthrough context 2', { go: 'team' })
+], TopicCoordinatorTest, "passesThroughContextGetter", null);
 exports.default = TopicCoordinatorTest;
+class SpyCoordinator extends ConversationCoordinator_1.ConversationCoordinator {
+    getPlayer() {
+        return this.player;
+    }
+}

package/build/__tests__/implementation/TopicScriptPlayer.test.d.ts

@@ -16,6 +16,7 @@ export default class TopicScriptPlayerTest extends AbstractConversationTest {
     protected static retainsStateBetweenScriptLines(): Promise<void>;
     protected static retainsStateBetweenMessages(): Promise<void>;
     protected static alwaysEndsWithRedirectToDiscovery(): Promise<void>;
+    protected static skillContextAvailableOnScriptLine(context: Record<string, any>): Promise<void>;
     private static Player;
     private static sendMessage;
 }

package/build/__tests__/implementation/TopicScriptPlayer.test.js

@@ -18,7 +18,12 @@ class TopicScriptPlayerTest extends AbstractConversationTest_1.default {
         //@ts-ignore
         const err = test_utils_1.assert.doesThrow(() => new TopicScriptPlayer_1.TopicScriptPlayer());
         test_utils_2.errorAssert.assertError(err, 'MISSING_PARAMETERS', {
-            parameters: ['script', 'sendMessageHandler', 'target.personId'],
+            parameters: [
+                'script',
+                'sendMessageHandler',
+                'target.personId',
+                'getContext',
+            ],
         });
     }
     static async respondsToMessageWithOnlyLineInScript() {
@@ -331,14 +336,24 @@ class TopicScriptPlayerTest extends AbstractConversationTest_1.default {
         test_utils_1.assert.isEqual(results === null || results === void 0 ? void 0 : results.transitionConversationTo, 'discovery');
         test_utils_1.assert.isEqual(stateCount, 4);
     }
+    static async skillContextAvailableOnScriptLine(context) {
+        let passedContext;
+        const player = this.Player({
+            getContext: () => context,
+            script: [
+                async (options) => {
+                    passedContext = options.context;
+                },
+            ],
+        });
+        await this.sendMessage(player, {
+            body: (0, test_utils_1.generateId)(),
+        });
+        test_utils_1.assert.isEqualDeep(passedContext, context);
+    }
     static Player(options) {
         var _a, _b;
-        return new TopicScriptPlayer_1.TopicScriptPlayer({
-            target: (_a = options.target) !== null && _a !== void 0 ? _a : { personId: '12345' },
-            script: options.script,
-            lineDelay: 0,
-            sendMessageHandler: (_b = options.sendMessageHandler) !== null && _b !== void 0 ? _b : async function () { },
-        });
+        return new TopicScriptPlayer_1.TopicScriptPlayer(Object.assign({ target: (_a = options.target) !== null && _a !== void 0 ? _a : { personId: '12345' }, lineDelay: 0, sendMessageHandler: (_b = options.sendMessageHandler) !== null && _b !== void 0 ? _b : async function () { }, getContext: () => ({}) }, options));
     }
     static async sendMessage(player, message) {
         return player.handleMessage(this.buildMessage(Object.assign({ source: { personId: '1234' } }, message)));
@@ -410,4 +425,8 @@ __decorate([
 __decorate([
     (0, test_utils_1.test)()
 ], TopicScriptPlayerTest, "alwaysEndsWithRedirectToDiscovery", null);
+__decorate([
+    (0, test_utils_1.test)('can passe context 1', { skill: 'test' }),
+    (0, test_utils_1.test)('can passe context 2', { hello: 'world' })
+], TopicScriptPlayerTest, "skillContextAvailableOnScriptLine", null);
 exports.default = TopicScriptPlayerTest;

package/build/conversations/ConversationCoordinator.d.ts

@@ -1,20 +1,33 @@
 import { SkillEventContract } from '@sprucelabs/mercury-core-events';
 import { SchemaValues } from '@sprucelabs/schema';
-import { Message, SendMessageHandler } from '../types/conversation.types';
+import { SkillContext } from '@sprucelabs/spruce-skill-utils';
+import { TopicScriptPlayer } from '../topics/TopicScriptPlayer';
+import { TopicSuggester } from '../topics/TopicSuggester';
+import { LoadedTopicDefinition, Message, SendMessageHandler } from '../types/conversation.types';
 type MessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
 type MessageResponsePayload = SchemaValues<MessageResponsePayloadSchema>;
+type GetContext = () => SkillContext;
 export declare class ConversationCoordinator {
     private suggester;
     private sendMessageHandler;
     private topics;
-    private player?;
+    protected player?: TopicScriptPlayer;
     private lastTopic?;
     private lineDelay?;
-    private constructor();
+    private getContext;
+    protected constructor(options: {
+        suggester: TopicSuggester;
+        sendMessageHandler: SendMessageHandler;
+        topics: LoadedTopicDefinition[];
+        lineDelay?: number;
+        getContext: GetContext;
+    });
     static Coordinator(options: {
         topicLookupPath: string;
         sendMessageHandler: SendMessageHandler;
         lineDelay?: number;
+        getContext: GetContext;
+        Class?: new (...args: any[]) => ConversationCoordinator;
     }): Promise<ConversationCoordinator>;
     handleMessage(message: Message, topic?: string): Promise<MessageResponsePayload | void>;
 }

package/build/conversations/ConversationCoordinator.js

@@ -26,15 +26,18 @@ class ConversationCoordinator {
         this.sendMessageHandler = options.sendMessageHandler;
         this.topics = options.topics;
         this.lineDelay = options.lineDelay;
+        this.getContext = options.getContext;
     }
     static async Coordinator(options) {
-        const topics = await TopicLoader_1.default.loadTopics(options.topicLookupPath);
+        const { Class, topicLookupPath, sendMessageHandler, lineDelay, getContext, } = options;
+        const topics = await TopicLoader_1.default.loadTopics(topicLookupPath);
         const suggester = await TopicSuggester_1.TopicSuggester.Suggester({ topics });
-        return new ConversationCoordinator({
+        return new (Class !== null && Class !== void 0 ? Class : ConversationCoordinator)({
             suggester,
-            sendMessageHandler: options.sendMessageHandler,
+            sendMessageHandler,
             topics,
-            lineDelay: options.lineDelay,
+            lineDelay,
+            getContext,
         });
     }
     async handleMessage(message, topic) {
@@ -68,6 +71,7 @@ class ConversationCoordinator {
                 sendMessageHandler: this.sendMessageHandler,
                 script: matchedTopic.script,
                 lineDelay: this.lineDelay,
+                getContext: this.getContext,
             });
         }
         const results = await this.player.handleMessage(message);

package/build/esm/__tests__/behavioral/RegisteringConversationsOnBoot.test.d.ts

@@ -6,6 +6,8 @@ export default class RegisteringConversationsOnBootTest extends AbstractConversa
     protected static skillShutsDownWhenConvosFailToRegister(): Promise<void>;
     protected static canBootASecondTime(): Promise<void>;
     protected static skillCanBootASecondTime(): Promise<void>;
+    protected static coordinaterGetsSkillContext(): Promise<void>;
+    private static registerBootAndConnect;
     private static assertExpectedTopics;
     private static registerAndBoot;
 }

package/build/esm/__tests__/behavioral/RegisteringConversationsOnBoot.test.js

@@ -14,7 +14,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { eventResponseUtil } from '@sprucelabs/spruce-event-utils';
-import { test, assert } from '@sprucelabs/test-utils';
+import { test, assert, generateId } from '@sprucelabs/test-utils';
 import { errorAssert } from '@sprucelabs/test-utils';
 import plugin from '../../plugins/conversation.plugin.js';
 import AbstractConversationTest from '../../tests/AbstractConversationTest.js';
@@ -31,14 +31,14 @@ export default class RegisteringConversationsOnBootTest extends AbstractConversa
     static noConvosToStart() {
         return __awaiter(this, void 0, void 0, function* () {
             this.cwd = this.resolveTestPath('empty-skill');
-            const topics = yield this.registerAndBoot();
+            const { topics } = yield this.registerAndBoot();
             assert.isLength(topics, 0);
         });
     }
     static registersConvosOnBoot() {
         return __awaiter(this, void 0, void 0, function* () {
             this.cwd = this.resolveTestPath('skill');
-            const topics = yield this.registerAndBoot();
+            const { topics } = yield this.registerAndBoot();
             this.assertExpectedTopics(topics);
         });
     }
@@ -55,9 +55,9 @@ export default class RegisteringConversationsOnBootTest extends AbstractConversa
     static canBootASecondTime() {
         return __awaiter(this, void 0, void 0, function* () {
             this.cwd = this.resolveTestPath('skill');
-            const topics = yield this.registerAndBoot();
+            const { topics } = yield this.registerAndBoot();
             this.assertExpectedTopics(topics);
-            const topics2 = yield this.registerAndBoot({
+            const { topics: topics2 } = yield this.registerAndBoot({
                 skillId: process.env.SKILL_ID,
                 apiKey: process.env.SKILL_API_KEY,
             });
@@ -74,6 +74,44 @@ export default class RegisteringConversationsOnBootTest extends AbstractConversa
             });
         });
     }
+    static coordinaterGetsSkillContext() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.cwd = this.resolveTestPath('skill');
+            const { skill, client } = yield this.registerBootAndConnect();
+            const id = generateId();
+            yield client.emitAndFlattenResponses('did-message::v2020_12_25', {
+                payload: {
+                    message: this.buildMessage({
+                        body: generateId(),
+                        source: {
+                            personId: id,
+                        },
+                    }),
+                },
+            });
+            const conversations = skill.getFeatureByCode('conversation');
+            //@ts-ignore
+            const coordinator = yield conversations.coordinatorsBySource[id];
+            assert.isTruthy(coordinator);
+            //@ts-ignore
+            skill.updateContext('hello', 'world');
+            assert.isEqualDeep(coordinator.getContext(), { hello: 'world' });
+            //@ts-ignore
+            skill.updateContext('hello2', 'world2');
+            assert.isEqualDeep(coordinator.getContext(), {
+                hello: 'world',
+                hello2: 'world2',
+            });
+        });
+    }
+    static registerBootAndConnect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { skill } = yield this.registerAndBoot();
+            const events = skill.getFeatureByCode('event');
+            const client = yield events.connectToApi();
+            return { skill, client };
+        });
+    }
     static assertExpectedTopics(topics) {
         assert.isLength(topics, 5);
         assert.doesInclude(topics, { key: 'bookAppointment' });
@@ -102,7 +140,7 @@ export default class RegisteringConversationsOnBootTest extends AbstractConversa
             const results = yield client.emit('get-conversation-topics::v2020_12_25');
             const payload = eventResponseUtil.getFirstResponseOrThrow(results);
             topics = payload.topics;
-            return topics;
+            return { topics, skill };
         });
     }
 }
@@ -124,3 +162,6 @@ __decorate([
 __decorate([
     test()
 ], RegisteringConversationsOnBootTest, "skillCanBootASecondTime", null);
+__decorate([
+    test()
+], RegisteringConversationsOnBootTest, "coordinaterGetsSkillContext", null);

package/build/esm/__tests__/implementation/ConversationCoordinator.test.d.ts

@@ -2,6 +2,7 @@ import AbstractConversationTest from '../../tests/AbstractConversationTest';
 export default class TopicCoordinatorTest extends AbstractConversationTest {
     private static coordinator;
     private static sentMessages;
+    private static skillContext;
     protected static beforeEach(): Promise<void>;
     protected static canCreateTopicCoordinator(): Promise<void>;
     protected static hasHandleMessage(): Promise<void>;
@@ -12,4 +13,5 @@ export default class TopicCoordinatorTest extends AbstractConversationTest {
     protected static playsScriptWhenTopicIsSelected(): Promise<void>;
     protected static canHandlePromptsInScript(): Promise<void>;
     protected static canPlaceMixedScriptsUntilTheEndAndStartsOver(): Promise<void>;
+    protected static passesThroughContextGetter(context: Record<string, any>): Promise<void>;
 }

package/build/esm/__tests__/implementation/ConversationCoordinator.test.js

@@ -25,13 +25,15 @@ class TopicCoordinatorTest extends AbstractConversationTest {
         return __awaiter(this, void 0, void 0, function* () {
             yield _super.beforeEach.call(this);
             this.sentMessages = [];
-            this.coordinator = yield ConversationCoordinator.Coordinator({
+            this.coordinator = (yield ConversationCoordinator.Coordinator({
                 lineDelay: 0,
                 sendMessageHandler: (message) => __awaiter(this, void 0, void 0, function* () {
                     this.sentMessages.push(message);
                 }),
                 topicLookupPath: this.resolveTestPath('skill', 'build'),
-            });
+                getContext: () => this.skillContext,
+                Class: SpyCoordinator,
+            }));
         });
     }
     static canCreateTopicCoordinator() {
@@ -64,6 +66,7 @@ class TopicCoordinatorTest extends AbstractConversationTest {
             const coordinator = yield ConversationCoordinator.Coordinator({
                 topicLookupPath: this.cwd,
                 sendMessageHandler: () => __awaiter(this, void 0, void 0, function* () { }),
+                getContext: () => this.skillContext,
             });
             const results = yield coordinator.handleMessage(this.buildMessage({ body: 'help me book!', source: { personId: '1234' } }));
             assert.isArray(results.suggestedTopics);
@@ -137,8 +140,20 @@ class TopicCoordinatorTest extends AbstractConversationTest {
             assert.isEqual((_j = this.sentMessages[1]) === null || _j === void 0 ? void 0 : _j.body, 'prompt 1');
         });
     }
+    static passesThroughContextGetter(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.coordinator.handleMessage(this.buildMessage({ body: 'answer 2', source: { personId: '1234' } }), 'bookAppointment');
+            this.skillContext = context;
+            const player = this.coordinator.getPlayer();
+            assert.isTruthy(player);
+            //@ts-ignore
+            const actual = player.getContext();
+            assert.isEqualDeep(actual, this.skillContext);
+        });
+    }
 }
 TopicCoordinatorTest.sentMessages = [];
+TopicCoordinatorTest.skillContext = {};
 __decorate([
     test()
 ], TopicCoordinatorTest, "canCreateTopicCoordinator", null);
@@ -166,4 +181,13 @@ __decorate([
 __decorate([
     test()
 ], TopicCoordinatorTest, "canPlaceMixedScriptsUntilTheEndAndStartsOver", null);
+__decorate([
+    test('can passthrough context 1', { hello: 'world' }),
+    test('can passthrough context 2', { go: 'team' })
+], TopicCoordinatorTest, "passesThroughContextGetter", null);
 export default TopicCoordinatorTest;
+class SpyCoordinator extends ConversationCoordinator {
+    getPlayer() {
+        return this.player;
+    }
+}

package/build/esm/__tests__/implementation/TopicScriptPlayer.test.d.ts

@@ -16,6 +16,7 @@ export default class TopicScriptPlayerTest extends AbstractConversationTest {
     protected static retainsStateBetweenScriptLines(): Promise<void>;
     protected static retainsStateBetweenMessages(): Promise<void>;
     protected static alwaysEndsWithRedirectToDiscovery(): Promise<void>;
+    protected static skillContextAvailableOnScriptLine(context: Record<string, any>): Promise<void>;
     private static Player;
     private static sendMessage;
 }

package/build/esm/__tests__/implementation/TopicScriptPlayer.test.js

@@ -13,7 +13,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { test, assert } from '@sprucelabs/test-utils';
+import { test, assert, generateId } from '@sprucelabs/test-utils';
 import { errorAssert } from '@sprucelabs/test-utils';
 import AbstractConversationTest from '../../tests/AbstractConversationTest.js';
 import { TopicScriptPlayer } from '../../topics/TopicScriptPlayer.js';
@@ -23,7 +23,12 @@ export default class TopicScriptPlayerTest extends AbstractConversationTest {
             //@ts-ignore
             const err = assert.doesThrow(() => new TopicScriptPlayer());
             errorAssert.assertError(err, 'MISSING_PARAMETERS', {
-                parameters: ['script', 'sendMessageHandler', 'target.personId'],
+                parameters: [
+                    'script',
+                    'sendMessageHandler',
+                    'target.personId',
+                    'getContext',
+                ],
             });
         });
     }
@@ -367,16 +372,28 @@ export default class TopicScriptPlayerTest extends AbstractConversationTest {
             assert.isEqual(stateCount, 4);
         });
     }
+    static skillContextAvailableOnScriptLine(context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let passedContext;
+            const player = this.Player({
+                getContext: () => context,
+                script: [
+                    (options) => __awaiter(this, void 0, void 0, function* () {
+                        passedContext = options.context;
+                    }),
+                ],
+            });
+            yield this.sendMessage(player, {
+                body: generateId(),
+            });
+            assert.isEqualDeep(passedContext, context);
+        });
+    }
     static Player(options) {
         var _a, _b;
-        return new TopicScriptPlayer({
-            target: (_a = options.target) !== null && _a !== void 0 ? _a : { personId: '12345' },
-            script: options.script,
-            lineDelay: 0,
-            sendMessageHandler: (_b = options.sendMessageHandler) !== null && _b !== void 0 ? _b : function () {
+        return new TopicScriptPlayer(Object.assign({ target: (_a = options.target) !== null && _a !== void 0 ? _a : { personId: '12345' }, lineDelay: 0, sendMessageHandler: (_b = options.sendMessageHandler) !== null && _b !== void 0 ? _b : function () {
                 return __awaiter(this, void 0, void 0, function* () { });
-            },
-        });
+            }, getContext: () => ({}) }, options));
     }
     static sendMessage(player, message) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -450,3 +467,7 @@ __decorate([
 __decorate([
     test()
 ], TopicScriptPlayerTest, "alwaysEndsWithRedirectToDiscovery", null);
+__decorate([
+    test('can passe context 1', { skill: 'test' }),
+    test('can passe context 2', { hello: 'world' })
+], TopicScriptPlayerTest, "skillContextAvailableOnScriptLine", null);

package/build/esm/conversations/ConversationCoordinator.d.ts

@@ -1,20 +1,33 @@
 import { SkillEventContract } from '@sprucelabs/mercury-core-events';
 import { SchemaValues } from '@sprucelabs/schema';
-import { Message, SendMessageHandler } from '../types/conversation.types';
+import { SkillContext } from '@sprucelabs/spruce-skill-utils';
+import { TopicScriptPlayer } from '../topics/TopicScriptPlayer';
+import { TopicSuggester } from '../topics/TopicSuggester';
+import { LoadedTopicDefinition, Message, SendMessageHandler } from '../types/conversation.types';
 type MessageResponsePayloadSchema = SkillEventContract['eventSignatures']['did-message::v2020_12_25']['responsePayloadSchema'];
 type MessageResponsePayload = SchemaValues<MessageResponsePayloadSchema>;
+type GetContext = () => SkillContext;
 export declare class ConversationCoordinator {
     private suggester;
     private sendMessageHandler;
     private topics;
-    private player?;
+    protected player?: TopicScriptPlayer;
     private lastTopic?;
     private lineDelay?;
-    private constructor();
+    private getContext;
+    protected constructor(options: {
+        suggester: TopicSuggester;
+        sendMessageHandler: SendMessageHandler;
+        topics: LoadedTopicDefinition[];
+        lineDelay?: number;
+        getContext: GetContext;
+    });
     static Coordinator(options: {
         topicLookupPath: string;
         sendMessageHandler: SendMessageHandler;
         lineDelay?: number;
+        getContext: GetContext;
+        Class?: new (...args: any[]) => ConversationCoordinator;
     }): Promise<ConversationCoordinator>;
     handleMessage(message: Message, topic?: string): Promise<MessageResponsePayload | void>;
 }

package/build/esm/conversations/ConversationCoordinator.js

@@ -29,16 +29,19 @@ export class ConversationCoordinator {
         this.sendMessageHandler = options.sendMessageHandler;
         this.topics = options.topics;
         this.lineDelay = options.lineDelay;
+        this.getContext = options.getContext;
     }
     static Coordinator(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const topics = yield TopicLoader.loadTopics(options.topicLookupPath);
+            const { Class, topicLookupPath, sendMessageHandler, lineDelay, getContext, } = options;
+            const topics = yield TopicLoader.loadTopics(topicLookupPath);
             const suggester = yield TopicSuggester.Suggester({ topics });
-            return new ConversationCoordinator({
+            return new (Class !== null && Class !== void 0 ? Class : ConversationCoordinator)({
                 suggester,
-                sendMessageHandler: options.sendMessageHandler,
+                sendMessageHandler,
                 topics,
-                lineDelay: options.lineDelay,
+                lineDelay,
+                getContext,
             });
         });
     }
@@ -74,6 +77,7 @@ export class ConversationCoordinator {
                     sendMessageHandler: this.sendMessageHandler,
                     script: matchedTopic.script,
                     lineDelay: this.lineDelay,
+                    getContext: this.getContext,
                 });
             }
             const results = yield this.player.handleMessage(message);

package/build/esm/plugins/conversation.plugin.js

@@ -123,6 +123,7 @@ export class ConversationFeature {
             }
             this.coordinatorsBySource[sourceId] = ConversationCoordinator.Coordinator({
                 topicLookupPath: this.skill.activeDir,
+                getContext: () => this.skill.getContext(),
                 sendMessageHandler: (message) => __awaiter(this, void 0, void 0, function* () {
                     try {
                         const { target } = message, values = __rest(message, ["target"]);

package/build/esm/tests/ScriptTester.js

@@ -46,6 +46,7 @@ export default class ScriptTester {
                 sendMessageHandler: (message) => __awaiter(this, void 0, void 0, function* () {
                     return this.writeHandler(message);
                 }),
+                getContext: () => ({}),
             });
             let msg = firstMessage;
             if (!msg) {

package/build/esm/topics/TopicScriptPlayer.d.ts

@@ -10,6 +10,7 @@ export declare class TopicScriptPlayer {
     private scriptState;
     private runningLine;
     private scriptLineIndex;
+    private getContext;
     constructor(options: ScriptPlayerOptions);
     handleMessage(message: Message): Promise<DidMessageResponsePayload | null>;
     private play;

package/build/esm/topics/TopicScriptPlayer.js

@@ -7,36 +7,27 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { SchemaError } from '@sprucelabs/schema';
+import { assertOptions } from '@sprucelabs/schema';
 import MessageGraphicsInterface from '../interfaces/MessageGraphicsInterface.js';
 import randomUtil from '../utilities/random.utility.js';
 export class TopicScriptPlayer {
     constructor(options) {
-        var _a, _b;
+        var _a;
         this.scriptState = {};
         this.scriptLineIndex = -1;
-        const missing = [];
-        if (!(options === null || options === void 0 ? void 0 : options.script)) {
-            missing.push('script');
-        }
-        if (!(options === null || options === void 0 ? void 0 : options.sendMessageHandler)) {
-            missing.push('sendMessageHandler');
-        }
-        if (!(options === null || options === void 0 ? void 0 : options.target.personId)) {
-            missing.push('target.personId');
-        }
-        if (missing.length > 0) {
-            throw new SchemaError({
-                code: 'MISSING_PARAMETERS',
-                parameters: missing,
-            });
-        }
-        this.script = options.script;
-        this.target = options.target;
-        this.sendMessageHandler = options.sendMessageHandler;
-        this.lineDelay = (_a = options.lineDelay) !== null && _a !== void 0 ? _a : 2000;
+        const { script, target, sendMessageHandler, lineDelay, getContext } = assertOptions(options, [
+            'script',
+            'sendMessageHandler',
+            'target.personId',
+            'getContext',
+        ]);
+        this.script = script;
+        this.target = target;
+        this.sendMessageHandler = sendMessageHandler;
+        this.lineDelay = lineDelay !== null && lineDelay !== void 0 ? lineDelay : 2000;
+        this.getContext = getContext;
         this.graphicsInterface =
-            (_b = options.graphicsInterface) !== null && _b !== void 0 ? _b : new MessageGraphicsInterface({
+            (_a = options.graphicsInterface) !== null && _a !== void 0 ? _a : new MessageGraphicsInterface({
                 sendMessageHandler: this.sendMessage.bind(this),
             });
     }
@@ -101,10 +92,10 @@ export class TopicScriptPlayer {
             return null;
         });
     }
-    handleLineCallback(normalizedLine, message) {
+    handleLineCallback(line, message) {
         return __awaiter(this, void 0, void 0, function* () {
             this.runningLine = {
-                promise: normalizedLine(this.buildCallbackOptions(message))
+                promise: line(this.buildCallbackOptions(message))
                     .then((results) => {
                     this.runningLine.isDone = true;
                     return results;
@@ -143,6 +134,7 @@ export class TopicScriptPlayer {
             state: this.scriptState,
             rand: randomUtil.rand,
             message,
+            context: this.getContext(),
         };
     }
     pickRandomLine(line) {

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

@@ -3,7 +3,7 @@ import { SchemaValues } from '@sprucelabs/schema';
 import { FieldDefinitions } from '@sprucelabs/schema';
 import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
 import { EventTarget } from '@sprucelabs/spruce-event-utils';
-import { GraphicsInterface, HealthCheckItem } from '@sprucelabs/spruce-skill-utils';
+import { GraphicsInterface, HealthCheckItem, SkillContext } from '@sprucelabs/spruce-skill-utils';
 import MessageGraphicsInterface from '../interfaces/MessageGraphicsInterface';
 export type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
 export type SendMessage = SpruceSchemas.Spruce.v2020_07_22.SendMessage;
@@ -15,6 +15,7 @@ export type ScriptLineCallbackOptions = {
     state: Record<string, any>;
     rand<T>(possibilities: T[]): T;
     message: Message;
+    context: SkillContext;
 };
 export type ScriptLine = string | ScriptLineCallback | string[];
 export interface ScriptLineCallback {
@@ -27,6 +28,7 @@ export interface ScriptPlayerOptions {
     target: EventTarget;
     lineDelay?: number;
     graphicsInterface?: MessageGraphicsInterface;
+    getContext: () => SkillContext;
 }
 export type ScriptPlayerSendMessage = {
     body: string;

package/build/plugins/conversation.plugin.js

@@ -109,6 +109,7 @@ class ConversationFeature {
         }
         this.coordinatorsBySource[sourceId] = ConversationCoordinator_1.ConversationCoordinator.Coordinator({
             topicLookupPath: this.skill.activeDir,
+            getContext: () => this.skill.getContext(),
             sendMessageHandler: async (message) => {
                 try {
                     const { target } = message, values = __rest(message, ["target"]);

package/build/tests/ScriptTester.js

@@ -42,6 +42,7 @@ class ScriptTester {
             sendMessageHandler: async (message) => {
                 return this.writeHandler(message);
             },
+            getContext: () => ({}),
         });
         let msg = firstMessage;
         if (!msg) {

package/build/topics/TopicScriptPlayer.d.ts

@@ -10,6 +10,7 @@ export declare class TopicScriptPlayer {
     private scriptState;
     private runningLine;
     private scriptLineIndex;
+    private getContext;
     constructor(options: ScriptPlayerOptions);
     handleMessage(message: Message): Promise<DidMessageResponsePayload | null>;
     private play;

package/build/topics/TopicScriptPlayer.js

@@ -9,31 +9,22 @@ const MessageGraphicsInterface_1 = __importDefault(require("../interfaces/Messag
 const random_utility_1 = __importDefault(require("../utilities/random.utility"));
 class TopicScriptPlayer {
     constructor(options) {
-        var _a, _b;
+        var _a;
         this.scriptState = {};
         this.scriptLineIndex = -1;
-        const missing = [];
-        if (!(options === null || options === void 0 ? void 0 : options.script)) {
-            missing.push('script');
-        }
-        if (!(options === null || options === void 0 ? void 0 : options.sendMessageHandler)) {
-            missing.push('sendMessageHandler');
-        }
-        if (!(options === null || options === void 0 ? void 0 : options.target.personId)) {
-            missing.push('target.personId');
-        }
-        if (missing.length > 0) {
-            throw new schema_1.SchemaError({
-                code: 'MISSING_PARAMETERS',
-                parameters: missing,
-            });
-        }
-        this.script = options.script;
-        this.target = options.target;
-        this.sendMessageHandler = options.sendMessageHandler;
-        this.lineDelay = (_a = options.lineDelay) !== null && _a !== void 0 ? _a : 2000;
+        const { script, target, sendMessageHandler, lineDelay, getContext } = (0, schema_1.assertOptions)(options, [
+            'script',
+            'sendMessageHandler',
+            'target.personId',
+            'getContext',
+        ]);
+        this.script = script;
+        this.target = target;
+        this.sendMessageHandler = sendMessageHandler;
+        this.lineDelay = lineDelay !== null && lineDelay !== void 0 ? lineDelay : 2000;
+        this.getContext = getContext;
         this.graphicsInterface =
-            (_b = options.graphicsInterface) !== null && _b !== void 0 ? _b : new MessageGraphicsInterface_1.default({
+            (_a = options.graphicsInterface) !== null && _a !== void 0 ? _a : new MessageGraphicsInterface_1.default({
                 sendMessageHandler: this.sendMessage.bind(this),
             });
     }
@@ -92,9 +83,9 @@ class TopicScriptPlayer {
         }
         return null;
     }
-    async handleLineCallback(normalizedLine, message) {
+    async handleLineCallback(line, message) {
         this.runningLine = {
-            promise: normalizedLine(this.buildCallbackOptions(message))
+            promise: line(this.buildCallbackOptions(message))
                 .then((results) => {
                 this.runningLine.isDone = true;
                 return results;
@@ -130,6 +121,7 @@ class TopicScriptPlayer {
             state: this.scriptState,
             rand: random_utility_1.default.rand,
             message,
+            context: this.getContext(),
         };
     }
     pickRandomLine(line) {

package/build/types/conversation.types.d.ts

@@ -3,7 +3,7 @@ import { SchemaValues } from '@sprucelabs/schema';
 import { FieldDefinitions } from '@sprucelabs/schema';
 import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
 import { EventTarget } from '@sprucelabs/spruce-event-utils';
-import { GraphicsInterface, HealthCheckItem } from '@sprucelabs/spruce-skill-utils';
+import { GraphicsInterface, HealthCheckItem, SkillContext } from '@sprucelabs/spruce-skill-utils';
 import MessageGraphicsInterface from '../interfaces/MessageGraphicsInterface';
 export type Message = SpruceSchemas.Spruce.v2020_07_22.Message;
 export type SendMessage = SpruceSchemas.Spruce.v2020_07_22.SendMessage;
@@ -15,6 +15,7 @@ export type ScriptLineCallbackOptions = {
     state: Record<string, any>;
     rand<T>(possibilities: T[]): T;
     message: Message;
+    context: SkillContext;
 };
 export type ScriptLine = string | ScriptLineCallback | string[];
 export interface ScriptLineCallback {
@@ -27,6 +28,7 @@ export interface ScriptPlayerOptions {
     target: EventTarget;
     lineDelay?: number;
     graphicsInterface?: MessageGraphicsInterface;
+    getContext: () => SkillContext;
 }
 export type ScriptPlayerSendMessage = {
     body: string;

package/package.json

@@ -12,7 +12,7 @@
       "@types/inquirer"
     ]
   },
-  "version": "56.0.37",
+  "version": "56.1.0",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -65,14 +65,14 @@
     "@nlpjs/nlu": "^4.26.1",
     "@sprucelabs/error": "^5.0.591",
     "@sprucelabs/globby": "^0.0.7",
-    "@sprucelabs/mercury-core-events": "^18.0.31",
+    "@sprucelabs/mercury-core-events": "^18.0.32",
     "@sprucelabs/schema": "^28.5.153",
     "@sprucelabs/spruce-core-schemas": "^37.2.17",
-    "@sprucelabs/spruce-event-plugin": "^56.0.37",
+    "@sprucelabs/spruce-event-plugin": "^56.1.0",
     "@sprucelabs/spruce-event-utils": "^34.0.29",
-    "@sprucelabs/spruce-skill-booter": "^56.0.37",
+    "@sprucelabs/spruce-skill-booter": "^56.1.0",
     "@sprucelabs/spruce-skill-utils": "^28.1.109",
-    "@sprucelabs/spruce-test-fixtures": "^56.0.37",
+    "@sprucelabs/spruce-test-fixtures": "^56.1.0",
     "fuzzyset": "^1.0.7",
     "inquirer": "^8.2.4",
     "node-nlp": "^4.26.1",
@@ -81,7 +81,7 @@
   "devDependencies": {
     "@sprucelabs/esm-postbuild": "^3.0.12",
     "@sprucelabs/jest-json-reporter": "^7.0.11",
-    "@sprucelabs/mercury-client": "^38.0.29",
+    "@sprucelabs/mercury-client": "^38.0.30",
     "@sprucelabs/resolve-path-aliases": "^1.1.198",
     "@sprucelabs/semantic-release": "^4.0.8",
     "@sprucelabs/test": "^7.7.430",
@@ -118,5 +118,5 @@
       "^#spruce/(.*)$": "<rootDir>/build/.spruce/$1"
     }
   },
-  "gitHead": "e6f580b76faeb0f7c88b5776c050643c62b310e6"
+  "gitHead": "24c52c19b2a6a25f3822497bbf038934cf243938"
 }