@sprucelabs/spruce-conversation-plugin 52.3.24 → 52.4.0

package/build/__tests__/implementation/MessageGraphicsInterface/MockMessageBeforeAndAfterEach.test.d.ts

@@ -0,0 +1,5 @@
+import AbstractSpruceTest from '@sprucelabs/test-utils';
+export default class SpyMessageBeforeAndAfterEachTest extends AbstractSpruceTest {
+    protected static throwsIfInstantiatingTwoWithoutCallingAfterEach(): Promise<void>;
+    protected static throwsIfDanglingPrompt(): Promise<void>;
+}

package/build/__tests__/implementation/MessageGraphicsInterface/MockMessageBeforeAndAfterEach.test.js

@@ -0,0 +1,62 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const spruce_test_fixtures_1 = require("@sprucelabs/spruce-test-fixtures");
+const test_utils_1 = __importStar(require("@sprucelabs/test-utils"));
+const MockMessageInterface_1 = __importDefault(require("../../../interfaces/MockMessageInterface"));
+let SpyMessageBeforeAndAfterEachTest = class SpyMessageBeforeAndAfterEachTest extends test_utils_1.default {
+    static async throwsIfInstantiatingTwoWithoutCallingAfterEach() {
+        MockMessageInterface_1.default.Ui();
+        test_utils_1.assert.doesThrow(() => MockMessageInterface_1.default.Ui());
+        MockMessageInterface_1.default.afterEach();
+        MockMessageInterface_1.default.Ui();
+    }
+    static async throwsIfDanglingPrompt() {
+        MockMessageInterface_1.default.afterEach();
+        const ui = MockMessageInterface_1.default.Ui();
+        void ui.prompt({ type: 'number' });
+        ui.renderLine('Hey there!');
+        test_utils_1.assert.doesThrow(() => MockMessageInterface_1.default.afterEach());
+    }
+};
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageBeforeAndAfterEachTest, "throwsIfInstantiatingTwoWithoutCallingAfterEach", null);
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageBeforeAndAfterEachTest, "throwsIfDanglingPrompt", null);
+SpyMessageBeforeAndAfterEachTest = __decorate([
+    spruce_test_fixtures_1.fake.login()
+], SpyMessageBeforeAndAfterEachTest);
+exports.default = SpyMessageBeforeAndAfterEachTest;

package/build/__tests__/implementation/MessageGraphicsInterface/MockMessageInterface.test.d.ts

@@ -0,0 +1,18 @@
+import AbstractSpruceTest from '@sprucelabs/test-utils';
+export default class SpyMessageInterfaceTest extends AbstractSpruceTest {
+    private static ui;
+    protected static beforeEach(): Promise<void>;
+    protected static afterEach(): Promise<void>;
+    protected static knowsIfDidntPromp(): Promise<void>;
+    protected static holdsUntilPromptIsAnswered(): Promise<void>;
+    protected static tracksPrompts(): Promise<void>;
+    protected static throwsIfRenderedAfterPrompt(): Promise<void>;
+    protected static canAssertSelectChoices(): Promise<void>;
+    protected static canAssertDifferentSelectChoices(): Promise<void>;
+    protected static canAssertIfRequired(): Promise<void>;
+    private static assertPromptedWithChoices;
+    private static promptWithChoices;
+    private static resetUi;
+    private static prompt;
+    private static assertNotJustPromptedFor;
+}

package/build/__tests__/implementation/MessageGraphicsInterface/MockMessageInterface.test.js

@@ -0,0 +1,168 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_utils_1 = __importStar(require("@sprucelabs/test-utils"));
+const MockMessageInterface_1 = __importDefault(require("../../../interfaces/MockMessageInterface"));
+class SpyMessageInterfaceTest extends test_utils_1.default {
+    static async beforeEach() {
+        await super.beforeEach();
+        this.ui = MockMessageInterface_1.default.Ui();
+    }
+    static async afterEach() {
+        await super.afterEach();
+        MockMessageInterface_1.default.afterEach();
+    }
+    static async knowsIfDidntPromp() {
+        this.assertNotJustPromptedFor('number');
+    }
+    static async holdsUntilPromptIsAnswered() {
+        const promise = this.prompt({ type: 'text' });
+        const expected = (0, test_utils_1.generateId)();
+        this.ui.answerPrompt(expected);
+        const answer = await promise;
+        test_utils_1.assert.isEqual(answer, expected);
+    }
+    static async tracksPrompts() {
+        void this.prompt({
+            type: 'number',
+            isRequired: true,
+        });
+        this.ui.assertJustPromptedFor('number');
+        this.assertNotJustPromptedFor('text');
+        this.resetUi();
+    }
+    static async throwsIfRenderedAfterPrompt() {
+        void this.prompt({
+            type: 'number',
+            isRequired: true,
+        });
+        this.ui.renderLine('go dogs go!');
+        this.assertNotJustPromptedFor('number');
+        this.resetUi();
+    }
+    static async canAssertSelectChoices() {
+        this.promptWithChoices([
+            {
+                label: 'Hey',
+                value: 'hello',
+            },
+        ]);
+        test_utils_1.assert.doesThrow(() => this.assertPromptedWithChoices([
+            {
+                value: 'what the!?',
+            },
+        ]));
+        this.assertPromptedWithChoices([
+            {
+                value: 'hello',
+            },
+        ]);
+        this.resetUi();
+    }
+    static async canAssertDifferentSelectChoices() {
+        const value = (0, test_utils_1.generateId)();
+        this.promptWithChoices([
+            {
+                value,
+                label: 'What theee!!!!??',
+            },
+            { value: 'hello', label: 'Hello!' },
+        ]);
+        this.assertPromptedWithChoices([
+            {
+                value,
+            },
+            {
+                value: 'hello',
+            },
+        ]);
+        this.resetUi();
+    }
+    static async canAssertIfRequired() {
+        void this.prompt({
+            type: 'number',
+            options: {
+                min: 0,
+                max: 100,
+            },
+        });
+        test_utils_1.assert.doesThrow(() => this.ui.assertJustPromptedFor('number', { min: 10, max: 20 }));
+        this.ui.assertJustPromptedFor('number', { min: 0, max: 100 });
+        this.resetUi();
+    }
+    static assertPromptedWithChoices(expected) {
+        return this.ui.assertJustPromptedFor('select', {
+            choices: expected,
+        });
+    }
+    static promptWithChoices(choices) {
+        void this.prompt({
+            type: 'select',
+            options: {
+                choices,
+            },
+        });
+    }
+    static resetUi() {
+        this.ui.reset();
+    }
+    static prompt(definition) {
+        return this.ui.prompt(definition);
+    }
+    static assertNotJustPromptedFor(type) {
+        test_utils_1.assert.doesThrow(() => this.ui.assertJustPromptedFor(type));
+    }
+}
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageInterfaceTest, "knowsIfDidntPromp", null);
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageInterfaceTest, "holdsUntilPromptIsAnswered", null);
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageInterfaceTest, "tracksPrompts", null);
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageInterfaceTest, "throwsIfRenderedAfterPrompt", null);
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageInterfaceTest, "canAssertSelectChoices", null);
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageInterfaceTest, "canAssertDifferentSelectChoices", null);
+__decorate([
+    (0, test_utils_1.test)()
+], SpyMessageInterfaceTest, "canAssertIfRequired", null);
+exports.default = SpyMessageInterfaceTest;

package/build/esm/__tests__/implementation/MessageGraphicsInterface/MockMessageBeforeAndAfterEach.test.d.ts

@@ -0,0 +1,5 @@
+import AbstractSpruceTest from '@sprucelabs/test-utils';
+export default class SpyMessageBeforeAndAfterEachTest extends AbstractSpruceTest {
+    protected static throwsIfInstantiatingTwoWithoutCallingAfterEach(): Promise<void>;
+    protected static throwsIfDanglingPrompt(): Promise<void>;
+}

package/build/esm/__tests__/implementation/MessageGraphicsInterface/MockMessageBeforeAndAfterEach.test.js

@@ -0,0 +1,47 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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 { fake } from '@sprucelabs/spruce-test-fixtures';
+import AbstractSpruceTest, { test, assert } from '@sprucelabs/test-utils';
+import MockMessageInterface from '../../../interfaces/MockMessageInterface.js';
+let SpyMessageBeforeAndAfterEachTest = class SpyMessageBeforeAndAfterEachTest extends AbstractSpruceTest {
+    static throwsIfInstantiatingTwoWithoutCallingAfterEach() {
+        return __awaiter(this, void 0, void 0, function* () {
+            MockMessageInterface.Ui();
+            assert.doesThrow(() => MockMessageInterface.Ui());
+            MockMessageInterface.afterEach();
+            MockMessageInterface.Ui();
+        });
+    }
+    static throwsIfDanglingPrompt() {
+        return __awaiter(this, void 0, void 0, function* () {
+            MockMessageInterface.afterEach();
+            const ui = MockMessageInterface.Ui();
+            void ui.prompt({ type: 'number' });
+            ui.renderLine('Hey there!');
+            assert.doesThrow(() => MockMessageInterface.afterEach());
+        });
+    }
+};
+__decorate([
+    test()
+], SpyMessageBeforeAndAfterEachTest, "throwsIfInstantiatingTwoWithoutCallingAfterEach", null);
+__decorate([
+    test()
+], SpyMessageBeforeAndAfterEachTest, "throwsIfDanglingPrompt", null);
+SpyMessageBeforeAndAfterEachTest = __decorate([
+    fake.login()
+], SpyMessageBeforeAndAfterEachTest);
+export default SpyMessageBeforeAndAfterEachTest;

package/build/esm/__tests__/implementation/MessageGraphicsInterface/MockMessageInterface.test.d.ts

@@ -0,0 +1,18 @@
+import AbstractSpruceTest from '@sprucelabs/test-utils';
+export default class SpyMessageInterfaceTest extends AbstractSpruceTest {
+    private static ui;
+    protected static beforeEach(): Promise<void>;
+    protected static afterEach(): Promise<void>;
+    protected static knowsIfDidntPromp(): Promise<void>;
+    protected static holdsUntilPromptIsAnswered(): Promise<void>;
+    protected static tracksPrompts(): Promise<void>;
+    protected static throwsIfRenderedAfterPrompt(): Promise<void>;
+    protected static canAssertSelectChoices(): Promise<void>;
+    protected static canAssertDifferentSelectChoices(): Promise<void>;
+    protected static canAssertIfRequired(): Promise<void>;
+    private static assertPromptedWithChoices;
+    private static promptWithChoices;
+    private static resetUi;
+    private static prompt;
+    private static assertNotJustPromptedFor;
+}

package/build/esm/__tests__/implementation/MessageGraphicsInterface/MockMessageInterface.test.js

@@ -0,0 +1,172 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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 AbstractSpruceTest, { test, assert, generateId, } from '@sprucelabs/test-utils';
+import MockMessageInterface from '../../../interfaces/MockMessageInterface.js';
+export default class SpyMessageInterfaceTest extends AbstractSpruceTest {
+    static beforeEach() {
+        const _super = Object.create(null, {
+            beforeEach: { get: () => super.beforeEach }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            yield _super.beforeEach.call(this);
+            this.ui = MockMessageInterface.Ui();
+        });
+    }
+    static afterEach() {
+        const _super = Object.create(null, {
+            afterEach: { get: () => super.afterEach }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            yield _super.afterEach.call(this);
+            MockMessageInterface.afterEach();
+        });
+    }
+    static knowsIfDidntPromp() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.assertNotJustPromptedFor('number');
+        });
+    }
+    static holdsUntilPromptIsAnswered() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const promise = this.prompt({ type: 'text' });
+            const expected = generateId();
+            this.ui.answerPrompt(expected);
+            const answer = yield promise;
+            assert.isEqual(answer, expected);
+        });
+    }
+    static tracksPrompts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            void this.prompt({
+                type: 'number',
+                isRequired: true,
+            });
+            this.ui.assertJustPromptedFor('number');
+            this.assertNotJustPromptedFor('text');
+            this.resetUi();
+        });
+    }
+    static throwsIfRenderedAfterPrompt() {
+        return __awaiter(this, void 0, void 0, function* () {
+            void this.prompt({
+                type: 'number',
+                isRequired: true,
+            });
+            this.ui.renderLine('go dogs go!');
+            this.assertNotJustPromptedFor('number');
+            this.resetUi();
+        });
+    }
+    static canAssertSelectChoices() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.promptWithChoices([
+                {
+                    label: 'Hey',
+                    value: 'hello',
+                },
+            ]);
+            assert.doesThrow(() => this.assertPromptedWithChoices([
+                {
+                    value: 'what the!?',
+                },
+            ]));
+            this.assertPromptedWithChoices([
+                {
+                    value: 'hello',
+                },
+            ]);
+            this.resetUi();
+        });
+    }
+    static canAssertDifferentSelectChoices() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const value = generateId();
+            this.promptWithChoices([
+                {
+                    value,
+                    label: 'What theee!!!!??',
+                },
+                { value: 'hello', label: 'Hello!' },
+            ]);
+            this.assertPromptedWithChoices([
+                {
+                    value,
+                },
+                {
+                    value: 'hello',
+                },
+            ]);
+            this.resetUi();
+        });
+    }
+    static canAssertIfRequired() {
+        return __awaiter(this, void 0, void 0, function* () {
+            void this.prompt({
+                type: 'number',
+                options: {
+                    min: 0,
+                    max: 100,
+                },
+            });
+            assert.doesThrow(() => this.ui.assertJustPromptedFor('number', { min: 10, max: 20 }));
+            this.ui.assertJustPromptedFor('number', { min: 0, max: 100 });
+            this.resetUi();
+        });
+    }
+    static assertPromptedWithChoices(expected) {
+        return this.ui.assertJustPromptedFor('select', {
+            choices: expected,
+        });
+    }
+    static promptWithChoices(choices) {
+        void this.prompt({
+            type: 'select',
+            options: {
+                choices,
+            },
+        });
+    }
+    static resetUi() {
+        this.ui.reset();
+    }
+    static prompt(definition) {
+        return this.ui.prompt(definition);
+    }
+    static assertNotJustPromptedFor(type) {
+        assert.doesThrow(() => this.ui.assertJustPromptedFor(type));
+    }
+}
+__decorate([
+    test()
+], SpyMessageInterfaceTest, "knowsIfDidntPromp", null);
+__decorate([
+    test()
+], SpyMessageInterfaceTest, "holdsUntilPromptIsAnswered", null);
+__decorate([
+    test()
+], SpyMessageInterfaceTest, "tracksPrompts", null);
+__decorate([
+    test()
+], SpyMessageInterfaceTest, "throwsIfRenderedAfterPrompt", null);
+__decorate([
+    test()
+], SpyMessageInterfaceTest, "canAssertSelectChoices", null);
+__decorate([
+    test()
+], SpyMessageInterfaceTest, "canAssertDifferentSelectChoices", null);
+__decorate([
+    test()
+], SpyMessageInterfaceTest, "canAssertIfRequired", null);

package/build/esm/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types/conversation.types';
 export { default as plugin } from './plugins/conversation.plugin';
 export { default as suggesterUtil } from './utilities/suggester.utility';
+export { default as MockMessageInterface } from './interfaces/MockMessageInterface';
 import '@sprucelabs/mercury-core-events';

package/build/esm/index.js

@@ -1,4 +1,5 @@
 export * from './types/conversation.types.js';
 export { default as plugin } from './plugins/conversation.plugin.js';
 export { default as suggesterUtil } from './utilities/suggester.utility.js';
+export { default as MockMessageInterface } from './interfaces/MockMessageInterface.js';
 import '@sprucelabs/mercury-core-events';

package/build/esm/interfaces/MockMessageInterface.d.ts

@@ -0,0 +1,22 @@
+import { FieldDefinitions, FieldDefinitionValueType } from '@sprucelabs/schema';
+import MessageGraphicsInterface from './MessageGraphicsInterface';
+export default class MockMessageInterface extends MessageGraphicsInterface {
+    private static alreadyExists;
+    private static lastPrompt;
+    private promptResolve?;
+    private static isPrompting;
+    private constructor();
+    static Ui(): MockMessageInterface;
+    static afterEach(): void;
+    reset(): void;
+    private clearLastPrompt;
+    prompt<T extends FieldDefinitions>(definition: T): Promise<FieldDefinitionValueType<T, false>>;
+    answerPrompt(value: string | number | null): void;
+    assertJustPromptedFor<T extends FieldDefinitions>(type: T['type'], options?: T['options']): any;
+    private assertValidChoices;
+    private get lastPrompt();
+    private set lastPrompt(value);
+    private get isPrompting();
+    private set isPrompting(value);
+}
+export type FieldType = FieldDefinitions['type'];

package/build/esm/interfaces/MockMessageInterface.js

@@ -0,0 +1,87 @@
+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 { selectAssert, } from '@sprucelabs/schema';
+import { assert } from '@sprucelabs/test-utils';
+import MessageGraphicsInterface from './MessageGraphicsInterface.js';
+export default class MockMessageInterface extends MessageGraphicsInterface {
+    constructor() {
+        super({
+            sendMessageHandler: () => __awaiter(this, void 0, void 0, function* () {
+                this.clearLastPrompt();
+            }),
+        });
+    }
+    static Ui() {
+        assert.isFalse(this.alreadyExists, `You gotta call Ui.afterEach() after each test!`);
+        this.alreadyExists = true;
+        return new this();
+    }
+    static afterEach() {
+        if (this.isPrompting) {
+            assert.fail('You have a dangling prompt!! Send some input or call ui.reset()');
+        }
+        this.alreadyExists = false;
+    }
+    reset() {
+        this.clearLastPrompt();
+        this.isPrompting = false;
+    }
+    clearLastPrompt() {
+        this.lastPrompt = null;
+    }
+    prompt(definition) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.lastPrompt = definition;
+            this.isPrompting = true;
+            return new Promise((r) => {
+                this.promptResolve = r;
+            });
+        });
+    }
+    answerPrompt(value) {
+        var _a;
+        this.isPrompting = false;
+        this.clearLastPrompt();
+        (_a = this.promptResolve) === null || _a === void 0 ? void 0 : _a.call(this, value);
+    }
+    assertJustPromptedFor(type, options) {
+        var _a, _b;
+        assert.isEqual((_a = this.lastPrompt) === null || _a === void 0 ? void 0 : _a.type, type, `You did not prompt for a '${type}'!`);
+        if (options) {
+            if (!this.assertValidChoices(options)) {
+                assert.doesInclude((_b = this.lastPrompt) === null || _b === void 0 ? void 0 : _b.options, options, `Your prompt options are not what I expected!`);
+            }
+        }
+    }
+    assertValidChoices(options) {
+        var _a, _b;
+        const choices = (_b = (_a = this.lastPrompt) === null || _a === void 0 ? void 0 : _a.options) === null || _b === void 0 ? void 0 : _b.choices;
+        if (choices) {
+            selectAssert.assertSelectChoicesMatch(choices, options.choices.map((c) => c.value));
+            return true;
+        }
+        return false;
+    }
+    get lastPrompt() {
+        return MockMessageInterface.lastPrompt;
+    }
+    set lastPrompt(prompt) {
+        MockMessageInterface.lastPrompt = prompt;
+    }
+    get isPrompting() {
+        return MockMessageInterface.isPrompting;
+    }
+    set isPrompting(prompt) {
+        MockMessageInterface.isPrompting = prompt;
+    }
+}
+MockMessageInterface.alreadyExists = false;
+MockMessageInterface.lastPrompt = null;
+MockMessageInterface.isPrompting = false;

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

@@ -1,9 +1,5 @@
 import { PromptHandler } from '../interfaces/TestGraphicsInterface';
 import { LoadedTopicDefinition, Message } from '../types/conversation.types';
-type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
-type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
-type SimplifiedTopic = LoadedTopicDefinition;
-export declare const END_OF_LINE = "END OF LINE \uD83D\uDC7E";
 export default class ScriptTester {
     private writeHandler;
     private player?;
@@ -28,4 +24,8 @@ export default class ScriptTester {
     }): Promise<ScriptTester>;
 }
 export declare function generateTransitionMessage(transitionConversationTo: string): string;
+type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
+type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
+type SimplifiedTopic = LoadedTopicDefinition;
+export declare const END_OF_LINE = "END OF LINE \uD83D\uDC7E";
 export {};

package/build/esm/tests/ScriptTester.js

@@ -14,25 +14,6 @@ import TestGraphicsInterface from '../interfaces/TestGraphicsInterface.js';
 import { TopicScriptPlayer } from '../topics/TopicScriptPlayer.js';
 import { TopicSuggester } from '../topics/TopicSuggester.js';
 import randomUtil from '../utilities/random.utility.js';
-const inquirerSelectPromptHandler = (message) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
-    const answer = yield inquirer.prompt({
-        type: 'list',
-        name: 'select',
-        message: message.body,
-        choices: (_a = message.choices) === null || _a === void 0 ? void 0 : _a.map((c) => ({ name: c.label, value: c.value })),
-    });
-    return answer.select;
-});
-const inquirerPromptHandler = (message) => __awaiter(void 0, void 0, void 0, function* () {
-    const answer = yield inquirer.prompt({
-        type: 'input',
-        name: 'input',
-        message: message.body,
-    });
-    return answer.input;
-});
-export const END_OF_LINE = 'END OF LINE 👾';
 export default class ScriptTester {
     constructor(topics, writeHandler, selectPromptHandler, promptHandler, lineDelay, shouldPlayReplayAfterFinish) {
         this.writeHandler = writeHandler !== null && writeHandler !== void 0 ? writeHandler : ((message) => console.log(message.body));
@@ -158,3 +139,22 @@ export default class ScriptTester {
 export function generateTransitionMessage(transitionConversationTo) {
     return `Conversation exited. Transitioning to ${transitionConversationTo}.`;
 }
+const inquirerSelectPromptHandler = (message) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const answer = yield inquirer.prompt({
+        type: 'list',
+        name: 'select',
+        message: message.body,
+        choices: (_a = message.choices) === null || _a === void 0 ? void 0 : _a.map((c) => ({ name: c.label, value: c.value })),
+    });
+    return answer.select;
+});
+const inquirerPromptHandler = (message) => __awaiter(void 0, void 0, void 0, function* () {
+    const answer = yield inquirer.prompt({
+        type: 'input',
+        name: 'input',
+        message: message.body,
+    });
+    return answer.input;
+});
+export const END_OF_LINE = 'END OF LINE 👾';

package/build/index.d.ts

@@ -1,4 +1,5 @@
 export * from './types/conversation.types';
 export { default as plugin } from './plugins/conversation.plugin';
 export { default as suggesterUtil } from './utilities/suggester.utility';
+export { default as MockMessageInterface } from './interfaces/MockMessageInterface';
 import '@sprucelabs/mercury-core-events';

package/build/index.js

@@ -17,10 +17,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.suggesterUtil = exports.plugin = void 0;
+exports.MockMessageInterface = exports.suggesterUtil = exports.plugin = void 0;
 __exportStar(require("./types/conversation.types"), exports);
 var conversation_plugin_1 = require("./plugins/conversation.plugin");
 Object.defineProperty(exports, "plugin", { enumerable: true, get: function () { return __importDefault(conversation_plugin_1).default; } });
 var suggester_utility_1 = require("./utilities/suggester.utility");
 Object.defineProperty(exports, "suggesterUtil", { enumerable: true, get: function () { return __importDefault(suggester_utility_1).default; } });
+var MockMessageInterface_1 = require("./interfaces/MockMessageInterface");
+Object.defineProperty(exports, "MockMessageInterface", { enumerable: true, get: function () { return __importDefault(MockMessageInterface_1).default; } });
 require("@sprucelabs/mercury-core-events");

package/build/interfaces/MockMessageInterface.d.ts

@@ -0,0 +1,22 @@
+import { FieldDefinitions, FieldDefinitionValueType } from '@sprucelabs/schema';
+import MessageGraphicsInterface from './MessageGraphicsInterface';
+export default class MockMessageInterface extends MessageGraphicsInterface {
+    private static alreadyExists;
+    private static lastPrompt;
+    private promptResolve?;
+    private static isPrompting;
+    private constructor();
+    static Ui(): MockMessageInterface;
+    static afterEach(): void;
+    reset(): void;
+    private clearLastPrompt;
+    prompt<T extends FieldDefinitions>(definition: T): Promise<FieldDefinitionValueType<T, false>>;
+    answerPrompt(value: string | number | null): void;
+    assertJustPromptedFor<T extends FieldDefinitions>(type: T['type'], options?: T['options']): any;
+    private assertValidChoices;
+    private get lastPrompt();
+    private set lastPrompt(value);
+    private get isPrompting();
+    private set isPrompting(value);
+}
+export type FieldType = FieldDefinitions['type'];

package/build/interfaces/MockMessageInterface.js

@@ -0,0 +1,82 @@
+"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 MessageGraphicsInterface_1 = __importDefault(require("./MessageGraphicsInterface"));
+class MockMessageInterface extends MessageGraphicsInterface_1.default {
+    constructor() {
+        super({
+            sendMessageHandler: async () => {
+                this.clearLastPrompt();
+            },
+        });
+    }
+    static Ui() {
+        test_utils_1.assert.isFalse(this.alreadyExists, `You gotta call Ui.afterEach() after each test!`);
+        this.alreadyExists = true;
+        return new this();
+    }
+    static afterEach() {
+        if (this.isPrompting) {
+            test_utils_1.assert.fail('You have a dangling prompt!! Send some input or call ui.reset()');
+        }
+        this.alreadyExists = false;
+    }
+    reset() {
+        this.clearLastPrompt();
+        this.isPrompting = false;
+    }
+    clearLastPrompt() {
+        this.lastPrompt = null;
+    }
+    async prompt(definition) {
+        this.lastPrompt = definition;
+        this.isPrompting = true;
+        return new Promise((r) => {
+            this.promptResolve = r;
+        });
+    }
+    answerPrompt(value) {
+        var _a;
+        this.isPrompting = false;
+        this.clearLastPrompt();
+        (_a = this.promptResolve) === null || _a === void 0 ? void 0 : _a.call(this, value);
+    }
+    assertJustPromptedFor(type, options) {
+        var _a, _b;
+        test_utils_1.assert.isEqual((_a = this.lastPrompt) === null || _a === void 0 ? void 0 : _a.type, type, `You did not prompt for a '${type}'!`);
+        if (options) {
+            if (!this.assertValidChoices(options)) {
+                test_utils_1.assert.doesInclude((_b = this.lastPrompt) === null || _b === void 0 ? void 0 : _b.options, options, `Your prompt options are not what I expected!`);
+            }
+        }
+    }
+    assertValidChoices(options) {
+        var _a, _b;
+        const choices = (_b = (_a = this.lastPrompt) === null || _a === void 0 ? void 0 : _a.options) === null || _b === void 0 ? void 0 : _b.choices;
+        if (choices) {
+            schema_1.selectAssert.assertSelectChoicesMatch(choices, options.choices.map((c) => c.value));
+            return true;
+        }
+        return false;
+    }
+    get lastPrompt() {
+        return MockMessageInterface.lastPrompt;
+    }
+    set lastPrompt(prompt) {
+        MockMessageInterface.lastPrompt = prompt;
+    }
+    get isPrompting() {
+        return MockMessageInterface.isPrompting;
+    }
+    set isPrompting(prompt) {
+        MockMessageInterface.isPrompting = prompt;
+    }
+}
+exports.default = MockMessageInterface;
+MockMessageInterface.alreadyExists = false;
+MockMessageInterface.lastPrompt = null;
+MockMessageInterface.isPrompting = false;

package/build/tests/ScriptTester.d.ts

@@ -1,9 +1,5 @@
 import { PromptHandler } from '../interfaces/TestGraphicsInterface';
 import { LoadedTopicDefinition, Message } from '../types/conversation.types';
-type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
-type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
-type SimplifiedTopic = LoadedTopicDefinition;
-export declare const END_OF_LINE = "END OF LINE \uD83D\uDC7E";
 export default class ScriptTester {
     private writeHandler;
     private player?;
@@ -28,4 +24,8 @@ export default class ScriptTester {
     }): Promise<ScriptTester>;
 }
 export declare function generateTransitionMessage(transitionConversationTo: string): string;
+type WriteHandler = (message: Pick<Message, 'body' | 'choices'>) => void;
+type SelectHandler = (message: Pick<Message, 'body' | 'choices'>) => Promise<string>;
+type SimplifiedTopic = LoadedTopicDefinition;
+export declare const END_OF_LINE = "END OF LINE \uD83D\uDC7E";
 export {};

package/build/tests/ScriptTester.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateTransitionMessage = exports.END_OF_LINE = void 0;
+exports.END_OF_LINE = exports.generateTransitionMessage = void 0;
 const schema_1 = require("@sprucelabs/schema");
 const inquirer_1 = __importDefault(require("inquirer"));
 const SpruceError_1 = __importDefault(require("../errors/SpruceError"));
@@ -11,25 +11,6 @@ const TestGraphicsInterface_1 = __importDefault(require("../interfaces/TestGraph
 const TopicScriptPlayer_1 = require("../topics/TopicScriptPlayer");
 const TopicSuggester_1 = require("../topics/TopicSuggester");
 const random_utility_1 = __importDefault(require("../utilities/random.utility"));
-const inquirerSelectPromptHandler = async (message) => {
-    var _a;
-    const answer = await inquirer_1.default.prompt({
-        type: 'list',
-        name: 'select',
-        message: message.body,
-        choices: (_a = message.choices) === null || _a === void 0 ? void 0 : _a.map((c) => ({ name: c.label, value: c.value })),
-    });
-    return answer.select;
-};
-const inquirerPromptHandler = async (message) => {
-    const answer = await inquirer_1.default.prompt({
-        type: 'input',
-        name: 'input',
-        message: message.body,
-    });
-    return answer.input;
-};
-exports.END_OF_LINE = 'END OF LINE 👾';
 class ScriptTester {
     constructor(topics, writeHandler, selectPromptHandler, promptHandler, lineDelay, shouldPlayReplayAfterFinish) {
         this.writeHandler = writeHandler !== null && writeHandler !== void 0 ? writeHandler : ((message) => console.log(message.body));
@@ -147,3 +128,22 @@ function generateTransitionMessage(transitionConversationTo) {
     return `Conversation exited. Transitioning to ${transitionConversationTo}.`;
 }
 exports.generateTransitionMessage = generateTransitionMessage;
+const inquirerSelectPromptHandler = async (message) => {
+    var _a;
+    const answer = await inquirer_1.default.prompt({
+        type: 'list',
+        name: 'select',
+        message: message.body,
+        choices: (_a = message.choices) === null || _a === void 0 ? void 0 : _a.map((c) => ({ name: c.label, value: c.value })),
+    });
+    return answer.select;
+};
+const inquirerPromptHandler = async (message) => {
+    const answer = await inquirer_1.default.prompt({
+        type: 'input',
+        name: 'input',
+        message: message.body,
+    });
+    return answer.input;
+};
+exports.END_OF_LINE = 'END OF LINE 👾';

package/package.json

@@ -13,7 +13,7 @@
       "@types/inquirer"
     ]
   },
-  "version": "52.3.24",
+  "version": "52.4.0",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -65,14 +65,14 @@
   "dependencies": {
     "@nlpjs/nlu": "^4.23.5",
     "@sprucelabs/error": "^5.0.554",
-    "@sprucelabs/mercury-core-events": "^15.0.134",
+    "@sprucelabs/mercury-core-events": "^15.0.135",
     "@sprucelabs/schema": "^28.5.83",
-    "@sprucelabs/spruce-core-schemas": "^35.1.85",
-    "@sprucelabs/spruce-event-plugin": "^52.3.24",
-    "@sprucelabs/spruce-event-utils": "^30.0.15",
-    "@sprucelabs/spruce-skill-booter": "^52.3.24",
+    "@sprucelabs/spruce-core-schemas": "^35.1.86",
+    "@sprucelabs/spruce-event-plugin": "^52.4.0",
+    "@sprucelabs/spruce-event-utils": "^30.0.16",
+    "@sprucelabs/spruce-skill-booter": "^52.4.0",
     "@sprucelabs/spruce-skill-utils": "^28.1.13",
-    "@sprucelabs/spruce-test-fixtures": "^52.3.24",
+    "@sprucelabs/spruce-test-fixtures": "^52.4.0",
     "fuzzyset": "^1.0.7",
     "globby": "^11.0.4",
     "inquirer": "^8.2.4",
@@ -82,7 +82,7 @@
   "devDependencies": {
     "@sprucelabs/esm-postbuild": "^2.0.48",
     "@sprucelabs/jest-json-reporter": "^6.0.534",
-    "@sprucelabs/mercury-client": "^35.0.19",
+    "@sprucelabs/mercury-client": "^35.0.20",
     "@sprucelabs/resolve-path-aliases": "^1.1.144",
     "@sprucelabs/semantic-release": "^4.0.8",
     "@sprucelabs/test": "^7.7.398",
@@ -119,5 +119,5 @@
       "^#spruce/(.*)$": "<rootDir>/build/.spruce/$1"
     }
   },
-  "gitHead": "a41e90fb0467ce6fabc03e7bcda9603f3996ce04"
+  "gitHead": "c99a131cf9100392da6fc5ce1dece954d14014e9"
 }