script-engine-lib 0.4.3 → 1.0.0-rc0

package/src/index.ts

@@ -0,0 +1,10 @@
+export { ActionBeforeTesting } from './decorators/action-before-testing';
+export * from './interfaces';
+export { JSEngine, JSEngineFunction } from './js-engine/js-engine';
+export { ScriptEngine, ScriptEngineFunctions, ScriptEngineOptions, ScriptEngineState } from './script-engine/script-engine';
+export {
+  ScriptEngineSimulatorFunctions,
+  ScriptTestSimulator,
+  ScriptTestSimulatorOptions
+} from './simulator/script-test-simulator';
+export * from './structured-text';

package/dist/decorators/action-before-testing.d.ts

@@ -1,2 +0,0 @@
-export declare const ActionBeforeTestingFlag = "actionsBeforeTesting";
-export declare function ActionBeforeTesting(): (_: unknown, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/decorators/action-before-testing.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionBeforeTesting = exports.ActionBeforeTestingFlag = void 0;
-const helpers_lib_1 = require("helpers-lib");
-exports.ActionBeforeTestingFlag = 'actionsBeforeTesting';
-function ActionBeforeTesting() {
-    return function (_, propertyKey, descriptor) {
-        let originalFunction = descriptor.value;
-        helpers_lib_1.JSEngine.setAsJSEngineFunction(originalFunction);
-        descriptor.value = function (...args) {
-            let hasFlag = Reflect.getOwnMetadata(exports.ActionBeforeTestingFlag, this);
-            if (hasFlag) {
-                return originalFunction.apply(this, args);
-            }
-            else {
-                throw new Error(`"${String(propertyKey)}(...)" can only be called at "actions before testing".`);
-            }
-        };
-        helpers_lib_1.MetaDataHelper.carryMetaDataOfFunction(originalFunction, descriptor.value);
-    };
-}
-exports.ActionBeforeTesting = ActionBeforeTesting;
-//# sourceMappingURL=action-before-testing.js.map

package/dist/decorators/action-before-testing.test.d.ts

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

package/dist/decorators/action-before-testing.test.js

@@ -1,82 +0,0 @@
-"use strict";
-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 __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const helpers_lib_1 = require("helpers-lib");
-const vitest_1 = require("vitest");
-const script_test_simulator_1 = require("../simulator/script-test-simulator");
-const action_before_testing_1 = require("./action-before-testing");
-let SampleFunctions = class SampleFunctions extends script_test_simulator_1.ScriptEngineSimulatorFunctions {
-    onPlayerChoice(choices) { }
-    onDialog(text, speaker) { }
-    onEnd() { }
-    onScriptBranchingEnd() { }
-    exclusive() { }
-    sayHi(message) { }
-};
-__decorate([
-    (0, action_before_testing_1.ActionBeforeTesting)(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
-    __metadata("design:returntype", void 0)
-], SampleFunctions.prototype, "exclusive", null);
-__decorate([
-    (0, action_before_testing_1.ActionBeforeTesting)(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String]),
-    __metadata("design:returntype", void 0)
-], SampleFunctions.prototype, "sayHi", null);
-SampleFunctions = __decorate([
-    (0, helpers_lib_1.AutoValidate)({ allowReadingNonExistantProperties: true })
-], SampleFunctions);
-(0, vitest_1.describe)('ScriptTestSimulator', () => {
-    let functions;
-    (0, vitest_1.beforeEach)(() => {
-        functions = new SampleFunctions();
-    });
-    (0, vitest_1.test)('sample 1 - valid call', () => {
-        let actionsBeforeTesting = [{ type: 'command', value: 'exclusive()' }];
-        let scripts = [
-            {
-                id: 'script1',
-                actions: [{ type: 'command', value: 'a = 1' }]
-            }
-        ];
-        let simulator = new script_test_simulator_1.ScriptTestSimulator(scripts);
-        let jsEngine = new helpers_lib_1.JSEngine(functions, {});
-        (0, vitest_1.expect)(() => simulator.simulateScript(scripts[0], jsEngine, actionsBeforeTesting)).not.toThrow();
-    });
-    (0, vitest_1.test)('sample 2 - call during execution error', () => {
-        let scripts = [
-            {
-                id: 'script1',
-                actions: [{ type: 'command', value: 'exclusive()' }]
-            }
-        ];
-        let simulator = new script_test_simulator_1.ScriptTestSimulator(scripts);
-        let jsEngine = new helpers_lib_1.JSEngine(functions, {});
-        (0, vitest_1.expect)(() => simulator.simulateScript(scripts[0], jsEngine, [])).toThrow('"exclusive(...)" can only be called at "actions before testing"');
-    });
-    (0, vitest_1.test)('sample 3 - wrong parameter count error', () => {
-        let scripts = [
-            {
-                id: 'script1',
-                actions: [{ type: 'command', value: 'exclusive("a")' }]
-            }
-        ];
-        let simulator = new script_test_simulator_1.ScriptTestSimulator(scripts);
-        let jsEngine = new helpers_lib_1.JSEngine(functions, {});
-        (0, vitest_1.expect)(() => simulator.simulateScript(scripts[0], jsEngine, [])).toThrow('Error: Unexpected argument has sent to exclusive. Expected: 0, Received: 1');
-    });
-    (0, vitest_1.test)('sample 4 - preserve parameter count', () => {
-        (0, vitest_1.expect)(functions.sayHi.length).toBe(1);
-    });
-});
-//# sourceMappingURL=action-before-testing.test.js.map

package/dist/engine/script-engine.d.ts

@@ -1,35 +0,0 @@
-import { ScriptDefinition } from '../interfaces';
-export interface ScriptEngineOptions {
-    readonly manualTestingMode?: boolean;
-}
-export declare abstract class ScriptEngineFunctions {
-    abstract onPlayerChoice(choices: readonly string[]): void;
-    abstract onDialog(text: string, speaker: string): void;
-}
-export declare enum ScriptEngineState {
-    idle = "idle",
-    running = "running",
-    waitingForPlayerChoice = "waitingForPlayerChoice"
-}
-export declare class ScriptEngine<ScriptFunctions extends ScriptEngineFunctions> {
-    private scriptDefinitions;
-    private jsEngine;
-    private stack;
-    private playerBranchingChoices;
-    private manualTestingMode;
-    get variables(): {
-        [key: string]: any;
-    };
-    get state(): ScriptEngineState;
-    private get running();
-    constructor(scriptDefinitions: Readonly<Record<string, ScriptDefinition>>, functions: ScriptFunctions, variables: {
-        [key: string]: any;
-    }, options?: ScriptEngineOptions);
-    start(scriptId: string): void;
-    next(): void;
-    playerChoice(choice: number): void;
-    private jumpTo;
-    private executeAction;
-    private insertActionsToStack;
-    private validateReservedFunctions;
-}

package/dist/engine/script-engine.js

@@ -1,175 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScriptEngine = exports.ScriptEngineState = exports.ScriptEngineFunctions = void 0;
-const helpers_lib_1 = require("helpers-lib");
-class ScriptEngineFunctions {
-}
-exports.ScriptEngineFunctions = ScriptEngineFunctions;
-var ScriptEngineState;
-(function (ScriptEngineState) {
-    ScriptEngineState["idle"] = "idle";
-    ScriptEngineState["running"] = "running";
-    ScriptEngineState["waitingForPlayerChoice"] = "waitingForPlayerChoice";
-})(ScriptEngineState || (exports.ScriptEngineState = ScriptEngineState = {}));
-class ScriptEngine {
-    get variables() {
-        return this.jsEngine.variables;
-    }
-    get state() {
-        if (this.playerBranchingChoices) {
-            return ScriptEngineState.waitingForPlayerChoice;
-        }
-        else if (this.running) {
-            return ScriptEngineState.running;
-        }
-        else {
-            return ScriptEngineState.idle;
-        }
-    }
-    get running() {
-        return !this.stack.isEmpty;
-    }
-    constructor(scriptDefinitions, functions, variables, options) {
-        this.stack = new helpers_lib_1.Stack();
-        this.manualTestingMode = false;
-        this.validateReservedFunctions(functions);
-        this.manualTestingMode = options?.manualTestingMode ? true : false;
-        this.scriptDefinitions = scriptDefinitions;
-        this.jsEngine = new helpers_lib_1.JSEngine(functions, variables);
-    }
-    start(scriptId) {
-        if (!this.stack.isEmpty) {
-            throw new Error(`ScriptEngine: Existing script haven't been concluded yet.`);
-        }
-        this.jumpTo(scriptId);
-    }
-    next() {
-        if (this.stack.isEmpty) {
-            throw new Error(`ScriptEngine: There is no active script to iterate.`);
-        }
-        if (this.state !== ScriptEngineState.running) {
-            throw new Error(`ScriptEngine: The engine is not in running state. Next action cannot be executed. State: ${this.state}`);
-        }
-        let action = this.stack.pop();
-        this.executeAction(action);
-    }
-    playerChoice(choice) {
-        if (!this.playerBranchingChoices) {
-            throw new Error(`ScriptEngine: No player branching choices available.`);
-        }
-        let selectedActions = this.playerBranchingChoices[choice];
-        if (!selectedActions) {
-            throw new Error(`ScriptEngine: Invalid player choice.`);
-        }
-        this.insertActionsToStack(selectedActions);
-        this.playerBranchingChoices = undefined;
-        if (this.running) {
-            this.next();
-        }
-    }
-    jumpTo(scriptId) {
-        let scriptDefinition = this.scriptDefinitions[scriptId];
-        if (!scriptDefinition) {
-            throw new Error(`ScriptEngine: Script definition not found: ${scriptId}`);
-        }
-        this.insertActionsToStack(scriptDefinition.actions);
-    }
-    executeAction(action) {
-        switch (action.type) {
-            case 'command':
-                this.jsEngine.execute(action.value);
-                break;
-            case 'dialog': {
-                let dialogItem = action.value;
-                this.jsEngine.functions.onDialog(this.jsEngine.string(dialogItem.text), dialogItem.speaker);
-                break;
-            }
-            case 'jumpTo': {
-                this.jumpTo(action.value);
-                if (this.running) {
-                    this.next();
-                }
-                break;
-            }
-            case 'branchByCondition': {
-                let branches = action.value;
-                let selectedBranch = branches.find(branch => {
-                    if (branch.condition) {
-                        return this.jsEngine.boolean(branch.condition);
-                    }
-                    else {
-                        return true;
-                    }
-                });
-                if (!selectedBranch) {
-                    throw new Error(`ScriptEngine: No branch is fulfilled the condition in branchByCondition action.`);
-                }
-                else {
-                    this.insertActionsToStack(selectedBranch.actions);
-                }
-                if (this.running) {
-                    this.next();
-                }
-                break;
-            }
-            case 'branchByChance': {
-                let validBranches = action.value.filter(branch => {
-                    if (branch.condition) {
-                        return this.jsEngine.boolean(branch.condition);
-                    }
-                    else {
-                        return true;
-                    }
-                });
-                if (validBranches.length === 0) {
-                    throw new Error(`ScriptEngine: No branch is fulfilled the condition in branchByChance action.`);
-                }
-                else if (this.manualTestingMode) {
-                    this.playerBranchingChoices = validBranches.map(branch => branch.actions);
-                    this.jsEngine.functions.onPlayerChoice(validBranches.map((branch, index) => branch.label ?? `Anonymous ${index}`));
-                }
-                else {
-                    let selectedActions = helpers_lib_1.Random.pickRandomElementWithWeight(validBranches.map(branch => ({
-                        value: branch.actions,
-                        weight: helpers_lib_1.Comparator.isString(branch.weight) ? this.jsEngine.number(branch.weight) : branch.weight
-                    })));
-                    this.insertActionsToStack(selectedActions);
-                    if (this.running) {
-                        this.next();
-                    }
-                }
-                break;
-            }
-            case 'branchByPlayerChoice': {
-                let validBranches = action.value.filter(branch => {
-                    if (branch.condition) {
-                        return this.jsEngine.boolean(branch.condition);
-                    }
-                    else {
-                        return true;
-                    }
-                });
-                if (validBranches.length === 0) {
-                    throw new Error(`ScriptEngine: No branch is fulfilled the condition in branchByPlayerChoice action.`);
-                }
-                else {
-                    this.playerBranchingChoices = validBranches.map(branch => branch.actions);
-                    this.jsEngine.functions.onPlayerChoice(validBranches.map(branch => this.jsEngine.string(branch.text)));
-                }
-                break;
-            }
-            default:
-                throw new Error(`ScriptEngine: Unknown action type: ${action.type}`);
-        }
-    }
-    insertActionsToStack(actions) {
-        this.stack.add(...actions);
-    }
-    validateReservedFunctions(functions) {
-        if (helpers_lib_1.JSEngine.isJSEngineFunction(functions.onPlayerChoice)) {
-            throw new Error(`ScriptEngine: onPlayerChoice function shall not be decorated as a JSEngineFunction.`);
-        }
-    }
-}
-exports.ScriptEngine = ScriptEngine;
-//# sourceMappingURL=script-engine.js.map

package/dist/engine/script-engine.test.d.ts

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