script-engine-lib 0.3.0

package/.eslintrc.js

@@ -0,0 +1,177 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    node: true
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:import/recommended',
+    'plugin:import/electron',
+    'plugin:import/typescript',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier'
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    sourceType: 'module'
+  },
+  root: true,
+  env: {
+    node: true,
+    jest: true
+  },
+  plugins: ['@typescript-eslint', '@typescript-eslint/eslint-plugin', 'no-null'],
+  ignorePatterns: ['**/*.js', 'vite.config.ts', 'out/**/*', 'dist/**/*', 'node_modules/**/*'],
+  rules: {
+    'no-null/no-null': 2,
+    '@typescript-eslint/adjacent-overload-signatures': 'error',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/ban-types': 'error',
+    '@typescript-eslint/consistent-type-definitions': 'error',
+    '@typescript-eslint/dot-notation': 'off',
+    '@typescript-eslint/explicit-function-return-type': [
+      "warn",
+      { "allowExpressions": true } 
+    ],
+    '@typescript-eslint/explicit-member-accessibility': [
+      'off',
+      {
+        accessibility: 'explicit'
+      }
+    ],
+    '@typescript-eslint/explicit-module-boundary-types': 'warn',
+    '@typescript-eslint/indent': ['off', 2],
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/member-delimiter-style': [
+      'error',
+      {
+        multiline: {
+          delimiter: 'semi',
+          requireLast: true
+        },
+        singleline: {
+          delimiter: 'semi',
+          requireLast: false
+        }
+      }
+    ],
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        selector: 'variable',
+        modifiers: ['const'],
+        format: ['PascalCase', 'UPPER_CASE']
+      }
+    ],
+    '@typescript-eslint/no-array-constructor': 'error',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-empty-interface': 'error',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-extra-non-null-assertion': 'error',
+    '@typescript-eslint/no-inferrable-types': [
+      'error',
+      {
+        ignoreParameters: true,
+        ignoreProperties: true
+      }
+    ],
+    '@typescript-eslint/no-misused-new': 'error',
+    '@typescript-eslint/no-namespace': 'error',
+    '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-this-alias': 'error',
+    '@typescript-eslint/no-unused-expressions': 'off',
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/no-var-requires': 'error',
+    '@typescript-eslint/prefer-as-const': 'error',
+    '@typescript-eslint/prefer-function-type': 'error',
+    '@typescript-eslint/prefer-namespace-keyword': 'error',
+    '@typescript-eslint/quotes': ['error', 'single', { allowTemplateLiterals: true }],
+    '@typescript-eslint/semi': ['error', 'always'],
+    '@typescript-eslint/triple-slash-reference': 'error',
+    '@typescript-eslint/type-annotation-spacing': 'error',
+    '@typescript-eslint/unified-signatures': 'error',
+    '@typescript-eslint/no-shadow': 'warn',
+    'arrow-body-style': 'error',
+    'arrow-parens': [2, 'as-needed'],
+    'brace-style': ['error', '1tbs'],
+    'constructor-super': 'error',
+    curly: 'error',
+    'eol-last': 'error',
+    eqeqeq: ['error', 'smart'],
+    'guard-for-in': 'off',
+    'id-blacklist': 'off',
+    'id-match': 'off',
+    'max-len': [
+      'error',
+      {
+        code: 170
+      }
+    ],
+    'no-array-constructor': 'off',
+    'no-bitwise': 'error',
+    'no-caller': 'error',
+    'no-console': [
+      'error',
+      {
+        allow: [
+          'log',
+          'warn',
+          'dir',
+          'timeLog',
+          'assert',
+          'clear',
+          'count',
+          'countReset',
+          'group',
+          'groupEnd',
+          'table',
+          'info',
+          'dirxml',
+          'error',
+          'groupCollapsed',
+          'Console',
+          'profile',
+          'profileEnd',
+          'timeStamp',
+          'context'
+        ]
+      }
+    ],
+    'no-debugger': 'error',
+    'no-empty': 'off',
+    'no-empty-function': 'off',
+    'no-eval': 'error',
+    'no-fallthrough': 'error',
+    'no-new-wrappers': 'error',
+    'no-restricted-imports': 'error',
+    'no-shadow': 'off',
+    'no-throw-literal': 'error',
+    'no-trailing-spaces': 'error',
+    'no-undef-init': 'error',
+    'no-underscore-dangle': 'off',
+    'no-unused-labels': 'error',
+    'no-unused-vars': 'off',
+    'no-var': 'error',
+    'prefer-const': 'off',
+    radix: 'off',
+    semi: [
+      'error',
+      'always',
+      {
+        omitLastInOneLineBlock: true
+      }
+    ],
+    'spaced-comment': [
+      'error',
+      'always',
+      {
+        markers: ['/']
+      }
+    ]
+  }
+};

package/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  "configurations": [
+    {
+      "name": "Unit Tests",
+      "type": "node",
+      "request": "launch",
+      "autoAttachChildProcesses": true,
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
+      "args": ["run"],
+      "smartStep": true,
+      "console": "integratedTerminal"
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,15 @@
+{
+  "javascript.preferences.importModuleSpecifier": "relative",
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "workbench.activityBar.location": "top",
+  "window.zoomLevel": 0,
+  "editor.stickyScroll.enabled": false,
+  "workbench.tree.enableStickyScroll": false,
+  "terminal.integrated.shellIntegration.decorationsEnabled": "never",
+  "editor.wrappingIndent": "indent",
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "always"
+  },
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true
+}

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

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

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

@@ -0,0 +1,23 @@
+"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.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-before-testing.js","sourceRoot":"","sources":["../../src/decorators/action-before-testing.ts"],"names":[],"mappings":";;;AAAA,6CAAuD;AAE1C,QAAA,uBAAuB,GAAG,sBAAsB,CAAC;AAE9D,SAAgB,mBAAmB;IACjC,OAAO,UAAU,CAAU,EAAE,WAAmB,EAAE,UAA8B;QAC9E,IAAI,gBAAgB,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,sBAAQ,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;QAEjD,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;YACzC,IAAI,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,+BAAuB,EAAE,IAAI,CAAC,CAAC;YACpE,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,gBAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC,wDAAwD,CAAC,CAAC;YACnG,CAAC;QACH,CAAC,CAAC;QAEF,4BAAc,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7E,CAAC,CAAC;AACJ,CAAC;AAhBD,kDAgBC"}

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

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

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

@@ -0,0 +1,82 @@
+"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/decorators/action-before-testing.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-before-testing.test.js","sourceRoot":"","sources":["../../src/decorators/action-before-testing.test.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,6CAAqD;AACrD,mCAA4D;AAG5D,8EAAyG;AACzG,mEAA8D;AAG9D,IAAM,eAAe,GAArB,MAAM,eAAgB,SAAQ,sDAA8B;IAC1D,cAAc,CAAC,OAA0B,IAAS,CAAC;IACnD,QAAQ,CAAC,IAAY,EAAE,OAAe,IAAS,CAAC;IAChD,KAAK,KAAU,CAAC;IAChB,oBAAoB,KAAU,CAAC;IAG/B,SAAS,KAAU,CAAC;IAGpB,KAAK,CAAC,OAAe,IAAS,CAAC;CAChC,CAAA;AAJC;IADC,IAAA,2CAAmB,GAAE;;;;gDACF;AAGpB;IADC,IAAA,2CAAmB,GAAE;;;;4CACS;AAV3B,eAAe;IADpB,IAAA,0BAAY,EAAC,EAAE,iCAAiC,EAAE,IAAI,EAAE,CAAC;GACpD,eAAe,CAWpB;AAED,IAAA,iBAAQ,EAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,IAAI,SAA0B,CAAC;IAE/B,IAAA,mBAAU,EAAC,GAAG,EAAE;QACd,SAAS,GAAG,IAAI,eAAe,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,uBAAuB,EAAE,GAAG,EAAE;QACjC,IAAI,oBAAoB,GAAiC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;QACrG,IAAI,OAAO,GAAuB;YAChC;gBACE,EAAE,EAAE,SAAS;gBACb,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;aAC/C;SACF,CAAC;QAEF,IAAI,SAAS,GAAG,IAAI,2CAAmB,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,QAAQ,GAAG,IAAI,sBAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAE3C,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACnG,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,IAAI,OAAO,GAAuB;YAChC;gBACE,EAAE,EAAE,SAAS;gBACb,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;aACrD;SACF,CAAC;QAEF,IAAI,SAAS,GAAG,IAAI,2CAAmB,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,QAAQ,GAAG,IAAI,sBAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAE3C,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CACtE,iEAAiE,CAClE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,wCAAwC,EAAE,GAAG,EAAE;QAClD,IAAI,OAAO,GAAuB;YAChC;gBACE,EAAE,EAAE,SAAS;gBACb,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC;aACxD;SACF,CAAC;QAEF,IAAI,SAAS,GAAG,IAAI,2CAAmB,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,QAAQ,GAAG,IAAI,sBAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAE3C,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CACtE,4EAA4E,CAC7E,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,qCAAqC,EAAE,GAAG,EAAE;QAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,35 @@
+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 {
+    running = "running",
+    waitingForPlayerChoice = "waitingForPlayerChoice",
+    finished = "finished"
+}
+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);
+    startScript(scriptId: string): void;
+    next(): void;
+    playerChoice(choice: number): void;
+    private jumpToScript;
+    private executeAction;
+    private insertActionsToStack;
+    private validateReservedFunctions;
+}

package/dist/engine/script-engine.js

@@ -0,0 +1,175 @@
+"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["running"] = "running";
+    ScriptEngineState["waitingForPlayerChoice"] = "waitingForPlayerChoice";
+    ScriptEngineState["finished"] = "finished";
+})(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.finished;
+        }
+    }
+    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);
+    }
+    startScript(scriptId) {
+        if (!this.stack.isEmpty) {
+            throw new Error(`ScriptEngine: Existing script haven't been concluded yet.`);
+        }
+        this.jumpToScript(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();
+        }
+    }
+    jumpToScript(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 'jumpToScript': {
+                this.jumpToScript(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 => branch.label));
+                }
+                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.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-engine.js","sourceRoot":"","sources":["../../src/engine/script-engine.ts"],"names":[],"mappings":";;;AAAA,6CAAkE;AAelE,MAAsB,qBAAqB;CAG1C;AAHD,sDAGC;AAED,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,sEAAiD,CAAA;IACjD,0CAAqB,CAAA;AACvB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B;AAED,MAAa,YAAY;IASvB,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IACjC,CAAC;IAED,IAAI,KAAK;QACP,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAChC,OAAO,iBAAiB,CAAC,sBAAsB,CAAC;QAClD,CAAC;aAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACxB,OAAO,iBAAiB,CAAC,OAAO,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,OAAO,iBAAiB,CAAC,QAAQ,CAAC;QACpC,CAAC;IACH,CAAC;IAED,IAAY,OAAO;QACjB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED,YACE,iBAA6D,EAC7D,SAA0B,EAC1B,SAAiC,EACjC,OAA6B;QA3BvB,UAAK,GAAG,IAAI,mBAAK,EAA0B,CAAC;QAG5C,sBAAiB,GAAY,KAAK,CAAC;QA0BzC,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;QAE1C,IAAI,CAAC,iBAAiB,GAAG,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAEnE,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,sBAAQ,CAAkB,SAAS,EAAE,SAAS,CAAC,CAAC;IACtE,CAAC;IAED,WAAW,CAAC,QAAgB;QAC1B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,IAAI,CAAC,KAAK,KAAK,iBAAiB,CAAC,OAAO,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CACb,4FAA4F,IAAI,CAAC,KAAK,EAAE,CACzG,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAG,CAAC;QAC/B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED,YAAY,CAAC,MAAc;QACzB,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,CAAC;QAED,IAAI,eAAe,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;QAC3C,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;QAExC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAEO,YAAY,CAAC,QAAgB;QACnC,IAAI,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,8CAA8C,QAAQ,EAAE,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACtD,CAAC;IAEO,aAAa,CAAC,MAA8B;QAClD,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,SAAS;gBACZ,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,KAAe,CAAC,CAAC;gBAC9C,MAAM;YACR,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAI,UAAU,GAAG,MAAM,CAAC,KAA6B,CAAC;gBACtD,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;gBAC5F,MAAM;YACR,CAAC;YACD,KAAK,cAAc,CAAC,CAAC,CAAC;gBACpB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAe,CAAC,CAAC;gBAE1C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,CAAC;gBAED,MAAM;YACR,CAAC;YACD,KAAK,mBAAmB,CAAC,CAAC,CAAC;gBACzB,IAAI,QAAQ,GAAG,MAAM,CAAC,KAAmD,CAAC;gBAC1E,IAAI,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBAC1C,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;wBACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBACjD,CAAC;yBAAM,CAAC;wBACN,OAAO,IAAI,CAAC;oBACd,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,cAAc,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;gBACrG,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBACpD,CAAC;gBAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,IAAI,aAAa,GAAI,MAAM,CAAC,KAAiD,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;oBAC5F,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;wBACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBACjD,CAAC;yBAAM,CAAC;wBACN,OAAO,IAAI,CAAC;oBACd,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC/B,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;gBAClG,CAAC;qBAAM,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAClC,IAAI,CAAC,sBAAsB,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC1E,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBACpF,CAAC;qBAAM,CAAC;oBACN,IAAI,eAAe,GAAG,oBAAM,CAAC,2BAA2B,CACtD,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;wBAC3B,KAAK,EAAE,MAAM,CAAC,OAAO;wBACrB,MAAM,EAAE,wBAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM;qBACjG,CAAC,CAAC,CACJ,CAAC;oBAEF,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;oBAE3C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;wBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,CAAC;gBACH,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,sBAAsB,CAAC,CAAC,CAAC;gBAC5B,IAAI,aAAa,GAAI,MAAM,CAAC,KAAuD,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;oBAClG,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;wBACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;oBACjD,CAAC;yBAAM,CAAC;wBACN,OAAO,IAAI,CAAC;oBACd,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC/B,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;gBACxG,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,sBAAsB,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC1E,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACzG,CAAC;gBAED,MAAM;YACR,CAAC;YACD;gBACE,MAAM,IAAI,KAAK,CAAC,sCAAsC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAEO,oBAAoB,CAAC,OAA0C;QACrE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IAC7B,CAAC;IAEO,yBAAyB,CAAC,SAA0B;QAC1D,IAAI,sBAAQ,CAAC,kBAAkB,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAC;QACzG,CAAC;IACH,CAAC;CACF;AAhMD,oCAgMC"}

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

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