script-engine-lib 0.4.3 → 1.0.0-rc1

package/dist/simulator/execution-history.d.ts

@@ -1,6 +0,0 @@
-export declare class ExecutionHistory {
-    private entries;
-    addEntry(entry: string): this;
-    toString(): string;
-    duplicate(): ExecutionHistory;
-}

package/dist/simulator/execution-history.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExecutionHistory = void 0;
-class ExecutionHistory {
-    constructor() {
-        this.entries = [];
-    }
-    addEntry(entry) {
-        this.entries.push(entry);
-        return this;
-    }
-    toString() {
-        return this.entries.join('\n');
-    }
-    duplicate() {
-        let copy = new ExecutionHistory();
-        copy.entries = [...this.entries];
-        return copy;
-    }
-}
-exports.ExecutionHistory = ExecutionHistory;
-//# sourceMappingURL=execution-history.js.map

package/dist/simulator/helpers/event-branches-map.d.ts

@@ -1,16 +0,0 @@
-import { EventActionDefinition, EventDefinition, ExecutionLocation, VisitableEventBranchDefinition } from '../../interfaces';
-export declare class EventBranchesMap {
-    private idToEventMap;
-    private unvisitedBranches;
-    private branchToInfoMap;
-    private actionToInfoMap;
-    constructor(eventDefinitions: EventDefinition[]);
-    getEvent(id: string): EventDefinition;
-    getRootBranchLocation(branch: VisitableEventBranchDefinition): ExecutionLocation;
-    getBranchLocation(branch: VisitableEventBranchDefinition): ExecutionLocation;
-    getActionLocation(action: EventActionDefinition): ExecutionLocation;
-    setVisited(branch: VisitableEventBranchDefinition): void;
-    getUnvisitedBranchLocations(): ExecutionLocation[];
-    private registerBranch;
-    private checkBranchesToRegisterInActions;
-}

package/dist/simulator/helpers/event-branches-map.js

@@ -1,114 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventBranchesMap = void 0;
-var VisitableEventBranchType;
-(function (VisitableEventBranchType) {
-    VisitableEventBranchType["event"] = "event";
-    VisitableEventBranchType["branchByCondition"] = "branchByCondition";
-    VisitableEventBranchType["branchByPlayerChoice"] = "branchByPlayerChoice";
-    VisitableEventBranchType["branchByChance"] = "branchByChance";
-})(VisitableEventBranchType || (VisitableEventBranchType = {}));
-class EventBranchesMap {
-    constructor(eventDefinitions) {
-        this.idToEventMap = new Map();
-        this.unvisitedBranches = new Set();
-        this.branchToInfoMap = new Map();
-        this.actionToInfoMap = new Map();
-        eventDefinitions.forEach(eventDefinition => {
-            this.idToEventMap.set(eventDefinition.id, eventDefinition);
-            this.registerBranch(eventDefinition, VisitableEventBranchType.event, eventDefinition.id, undefined, []);
-        });
-    }
-    getEvent(id) {
-        let event = this.idToEventMap.get(id);
-        if (!event) {
-            throw new Error(`Event with id ${id} not found.`);
-        }
-        return event;
-    }
-    getRootBranchLocation(branch) {
-        let branchInfo = this.branchToInfoMap.get(branch);
-        if (!branchInfo) {
-            throw new Error('Branch not found.');
-        }
-        return {
-            eventId: branchInfo.rootEventId,
-            path: []
-        };
-    }
-    getBranchLocation(branch) {
-        let branchInfo = this.branchToInfoMap.get(branch);
-        if (!branchInfo) {
-            throw new Error('Branch not found.');
-        }
-        return {
-            eventId: branchInfo.rootEventId,
-            path: branchInfo.path
-        };
-    }
-    getActionLocation(action) {
-        let actionInfo = this.actionToInfoMap.get(action);
-        if (!actionInfo) {
-            throw new Error('Branch not found.');
-        }
-        return {
-            eventId: actionInfo.rootEventId,
-            path: actionInfo.path
-        };
-    }
-    setVisited(branch) {
-        this.unvisitedBranches.delete(branch);
-    }
-    getUnvisitedBranchLocations() {
-        return Array.from(this.unvisitedBranches)
-            .map(branch => this.branchToInfoMap.get(branch))
-            .filter(branchInfo => !branchInfo.parentBranchInfo || !this.unvisitedBranches.has(branchInfo.parentBranchInfo.branch))
-            .map(branchInfo => ({ eventId: branchInfo.rootEventId, path: branchInfo.path }));
-    }
-    registerBranch(branch, type, rootEventId, parentBranchInfo, path) {
-        let branchInfo = {
-            branch,
-            type,
-            parentBranchInfo,
-            rootEventId,
-            path
-        };
-        this.unvisitedBranches.add(branch);
-        this.branchToInfoMap.set(branch, branchInfo);
-        this.checkBranchesToRegisterInActions(branch.actions, rootEventId, branchInfo, path);
-    }
-    checkBranchesToRegisterInActions(actions, rootEventId, parentBranchInfo, path) {
-        actions.forEach((action, index) => {
-            let actionPath = [...path, 'actions', `${index}`];
-            let actionInfo = {
-                action,
-                rootEventId,
-                path: actionPath
-            };
-            this.actionToInfoMap.set(action, actionInfo);
-            if (action.type === 'branchByCondition') {
-                let definiton = action.value;
-                definiton.forEach((branchByConditionItem, branchIndex) => {
-                    let newPath = [...actionPath, 'branchByCondition', `${branchIndex}`];
-                    this.registerBranch(branchByConditionItem, VisitableEventBranchType.branchByCondition, rootEventId, parentBranchInfo, newPath);
-                });
-            }
-            else if (action.type === 'branchByPlayerChoice') {
-                let definiton = action.value;
-                definiton.forEach((branchByPlayerChoiceItem, branchIndex) => {
-                    let newPath = [...actionPath, 'branchByPlayerChoice', `${branchIndex}`];
-                    this.registerBranch(branchByPlayerChoiceItem, VisitableEventBranchType.branchByPlayerChoice, rootEventId, parentBranchInfo, newPath);
-                });
-            }
-            else if (action.type === 'branchByChance') {
-                let definiton = action.value;
-                definiton.forEach((branchByChanceItem, branchIndex) => {
-                    let newPath = [...actionPath, 'branchByChance', `${branchIndex}`];
-                    this.registerBranch(branchByChanceItem, VisitableEventBranchType.branchByChance, rootEventId, parentBranchInfo, newPath);
-                });
-            }
-        });
-    }
-}
-exports.EventBranchesMap = EventBranchesMap;
-//# sourceMappingURL=event-branches-map.js.map

package/dist/simulator/helpers/event-branches-map.test.d.ts

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

package/dist/simulator/helpers/event-branches-map.test.js

@@ -1,120 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const event_branches_map_1 = require("./event-branches-map");
-(0, vitest_1.describe)('EventTestSimulator', () => {
-    (0, vitest_1.test)('error case', () => {
-        let events = [{ id: 'eventbasic', actions: [{ type: 'command', value: 'gameOver()' }] }];
-        let visitedBranchesMap = new event_branches_map_1.EventBranchesMap(events);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([
-            {
-                eventId: 'eventbasic',
-                path: []
-            }
-        ]);
-    });
-    (0, vitest_1.test)('visiting branch', () => {
-        let events = [{ id: 'eventbasic', actions: [{ type: 'command', value: 'gameOver()' }] }];
-        let visitedBranchesMap = new event_branches_map_1.EventBranchesMap(events);
-        visitedBranchesMap.setVisited(events[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([]);
-    });
-    (0, vitest_1.test)('when an error being shown, ignore children errors', () => {
-        let childBranch = {
-            condition: 'getPlayerCredits() >= 2000',
-            actions: [{ type: 'command', value: 'gameOver()' }]
-        };
-        let events = [
-            {
-                id: 'eventbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [childBranch]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new event_branches_map_1.EventBranchesMap(events);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([
-            {
-                eventId: 'eventbasic',
-                path: []
-            }
-        ]);
-    });
-    (0, vitest_1.test)('child error', () => {
-        let childBranch = {
-            condition: 'getPlayerCredits() >= 2000',
-            actions: [{ type: 'command', value: 'gameOver()' }]
-        };
-        let events = [
-            {
-                id: 'eventbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [childBranch]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new event_branches_map_1.EventBranchesMap(events);
-        visitedBranchesMap.setVisited(events[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([
-            {
-                eventId: 'eventbasic',
-                path: ['actions', '0', 'branchByCondition', '0']
-            }
-        ]);
-    });
-    (0, vitest_1.test)('get branch path', () => {
-        let childBranch = {
-            condition: 'getPlayerCredits() >= 2000',
-            actions: [{ type: 'command', value: 'gameOver()' }]
-        };
-        let events = [
-            {
-                id: 'eventbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [childBranch]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new event_branches_map_1.EventBranchesMap(events);
-        visitedBranchesMap.setVisited(events[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getBranchLocation(childBranch)).toEqual({
-            eventId: 'eventbasic',
-            path: ['actions', '0', 'branchByCondition', '0']
-        });
-    });
-    (0, vitest_1.test)('get branch path', () => {
-        let childAction = { type: 'command', value: 'gameOver()' };
-        let events = [
-            {
-                id: 'eventbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [
-                            {
-                                condition: 'getPlayerCredits() >= 2000',
-                                actions: [childAction]
-                            }
-                        ]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new event_branches_map_1.EventBranchesMap(events);
-        visitedBranchesMap.setVisited(events[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getActionLocation(childAction)).toEqual({
-            eventId: 'eventbasic',
-            path: ['actions', '0', 'branchByCondition', '0', 'actions', '0']
-        });
-    });
-});
-//# sourceMappingURL=event-branches-map.test.js.map

package/dist/simulator/helpers/execution-history.d.ts

@@ -1,6 +0,0 @@
-export declare class ExecutionHistory {
-    private entries;
-    addEntry(entry: string): this;
-    toString(): string;
-    duplicate(): ExecutionHistory;
-}

package/dist/simulator/helpers/execution-history.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExecutionHistory = void 0;
-class ExecutionHistory {
-    constructor() {
-        this.entries = [];
-    }
-    addEntry(entry) {
-        this.entries.push(entry);
-        return this;
-    }
-    toString() {
-        return this.entries.join('\n');
-    }
-    duplicate() {
-        let copy = new ExecutionHistory();
-        copy.entries = [...this.entries];
-        return copy;
-    }
-}
-exports.ExecutionHistory = ExecutionHistory;
-//# sourceMappingURL=execution-history.js.map

package/dist/simulator/helpers/script-branches-map.d.ts

@@ -1,16 +0,0 @@
-import { ExecutionLocation, ScriptActionDefinition, ScriptDefinition, VisitableScriptBranchDefinition } from '../../interfaces';
-export declare class ScriptBranchesMap {
-    private idToScriptMap;
-    private unvisitedBranches;
-    private branchToInfoMap;
-    private actionToInfoMap;
-    constructor(scriptDefinitions: ScriptDefinition[]);
-    getScript(id: string): ScriptDefinition;
-    getRootBranchLocation(branch: VisitableScriptBranchDefinition): ExecutionLocation;
-    getBranchLocation(branch: VisitableScriptBranchDefinition): ExecutionLocation;
-    getActionLocation(action: ScriptActionDefinition): ExecutionLocation;
-    setVisited(branch: VisitableScriptBranchDefinition): void;
-    getUnvisitedBranchLocations(): ExecutionLocation[];
-    private registerBranch;
-    private checkBranchesToRegisterInActions;
-}

package/dist/simulator/helpers/script-branches-map.js

@@ -1,114 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScriptBranchesMap = void 0;
-var VisitableScriptBranchType;
-(function (VisitableScriptBranchType) {
-    VisitableScriptBranchType["script"] = "script";
-    VisitableScriptBranchType["branchByCondition"] = "branchByCondition";
-    VisitableScriptBranchType["branchByPlayerChoice"] = "branchByPlayerChoice";
-    VisitableScriptBranchType["branchByChance"] = "branchByChance";
-})(VisitableScriptBranchType || (VisitableScriptBranchType = {}));
-class ScriptBranchesMap {
-    constructor(scriptDefinitions) {
-        this.idToScriptMap = new Map();
-        this.unvisitedBranches = new Set();
-        this.branchToInfoMap = new Map();
-        this.actionToInfoMap = new Map();
-        scriptDefinitions.forEach(scriptDefinition => {
-            this.idToScriptMap.set(scriptDefinition.id, scriptDefinition);
-            this.registerBranch(scriptDefinition, VisitableScriptBranchType.script, scriptDefinition.id, undefined, []);
-        });
-    }
-    getScript(id) {
-        let script = this.idToScriptMap.get(id);
-        if (!script) {
-            throw new Error(`Script with id ${id} not found.`);
-        }
-        return script;
-    }
-    getRootBranchLocation(branch) {
-        let branchInfo = this.branchToInfoMap.get(branch);
-        if (!branchInfo) {
-            throw new Error('Branch not found.');
-        }
-        return {
-            scriptId: branchInfo.rootScriptId,
-            path: []
-        };
-    }
-    getBranchLocation(branch) {
-        let branchInfo = this.branchToInfoMap.get(branch);
-        if (!branchInfo) {
-            throw new Error('Branch not found.');
-        }
-        return {
-            scriptId: branchInfo.rootScriptId,
-            path: branchInfo.path
-        };
-    }
-    getActionLocation(action) {
-        let actionInfo = this.actionToInfoMap.get(action);
-        if (!actionInfo) {
-            throw new Error('Branch not found.');
-        }
-        return {
-            scriptId: actionInfo.rootScriptId,
-            path: actionInfo.path
-        };
-    }
-    setVisited(branch) {
-        this.unvisitedBranches.delete(branch);
-    }
-    getUnvisitedBranchLocations() {
-        return Array.from(this.unvisitedBranches)
-            .map(branch => this.branchToInfoMap.get(branch))
-            .filter(branchInfo => !branchInfo.parentBranchInfo || !this.unvisitedBranches.has(branchInfo.parentBranchInfo.branch))
-            .map(branchInfo => ({ scriptId: branchInfo.rootScriptId, path: branchInfo.path }));
-    }
-    registerBranch(branch, type, rootScriptId, parentBranchInfo, path) {
-        let branchInfo = {
-            branch,
-            type,
-            parentBranchInfo,
-            rootScriptId,
-            path
-        };
-        this.unvisitedBranches.add(branch);
-        this.branchToInfoMap.set(branch, branchInfo);
-        this.checkBranchesToRegisterInActions(branch.actions, rootScriptId, branchInfo, path);
-    }
-    checkBranchesToRegisterInActions(actions, rootScriptId, parentBranchInfo, path) {
-        actions.forEach((action, index) => {
-            let actionPath = [...path, 'actions', `${index}`];
-            let actionInfo = {
-                action,
-                rootScriptId,
-                path: actionPath
-            };
-            this.actionToInfoMap.set(action, actionInfo);
-            if (action.type === 'branchByCondition') {
-                let definiton = action.value;
-                definiton.forEach((branchByConditionItem, branchIndex) => {
-                    let newPath = [...actionPath, 'branchByCondition', `${branchIndex}`];
-                    this.registerBranch(branchByConditionItem, VisitableScriptBranchType.branchByCondition, rootScriptId, parentBranchInfo, newPath);
-                });
-            }
-            else if (action.type === 'branchByPlayerChoice') {
-                let definiton = action.value;
-                definiton.forEach((branchByPlayerChoiceItem, branchIndex) => {
-                    let newPath = [...actionPath, 'branchByPlayerChoice', `${branchIndex}`];
-                    this.registerBranch(branchByPlayerChoiceItem, VisitableScriptBranchType.branchByPlayerChoice, rootScriptId, parentBranchInfo, newPath);
-                });
-            }
-            else if (action.type === 'branchByChance') {
-                let definiton = action.value;
-                definiton.forEach((branchByChanceItem, branchIndex) => {
-                    let newPath = [...actionPath, 'branchByChance', `${branchIndex}`];
-                    this.registerBranch(branchByChanceItem, VisitableScriptBranchType.branchByChance, rootScriptId, parentBranchInfo, newPath);
-                });
-            }
-        });
-    }
-}
-exports.ScriptBranchesMap = ScriptBranchesMap;
-//# sourceMappingURL=script-branches-map.js.map

package/dist/simulator/helpers/script-branches-map.test.d.ts

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

package/dist/simulator/helpers/script-branches-map.test.js

@@ -1,120 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const vitest_1 = require("vitest");
-const script_branches_map_1 = require("./script-branches-map");
-(0, vitest_1.describe)('ScriptTestSimulator', () => {
-    (0, vitest_1.test)('error case', () => {
-        let scripts = [{ id: 'scriptbasic', actions: [{ type: 'command', value: 'gameOver()' }] }];
-        let visitedBranchesMap = new script_branches_map_1.ScriptBranchesMap(scripts);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([
-            {
-                scriptId: 'scriptbasic',
-                path: []
-            }
-        ]);
-    });
-    (0, vitest_1.test)('visiting branch', () => {
-        let scripts = [{ id: 'scriptbasic', actions: [{ type: 'command', value: 'gameOver()' }] }];
-        let visitedBranchesMap = new script_branches_map_1.ScriptBranchesMap(scripts);
-        visitedBranchesMap.setVisited(scripts[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([]);
-    });
-    (0, vitest_1.test)('when an error being shown, ignore children errors', () => {
-        let childBranch = {
-            condition: 'getPlayerCredits() >= 2000',
-            actions: [{ type: 'command', value: 'gameOver()' }]
-        };
-        let scripts = [
-            {
-                id: 'scriptbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [childBranch]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new script_branches_map_1.ScriptBranchesMap(scripts);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([
-            {
-                scriptId: 'scriptbasic',
-                path: []
-            }
-        ]);
-    });
-    (0, vitest_1.test)('child error', () => {
-        let childBranch = {
-            condition: 'getPlayerCredits() >= 2000',
-            actions: [{ type: 'command', value: 'gameOver()' }]
-        };
-        let scripts = [
-            {
-                id: 'scriptbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [childBranch]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new script_branches_map_1.ScriptBranchesMap(scripts);
-        visitedBranchesMap.setVisited(scripts[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getUnvisitedBranchLocations()).toEqual([
-            {
-                scriptId: 'scriptbasic',
-                path: ['actions', '0', 'branchByCondition', '0']
-            }
-        ]);
-    });
-    (0, vitest_1.test)('get branch path', () => {
-        let childBranch = {
-            condition: 'getPlayerCredits() >= 2000',
-            actions: [{ type: 'command', value: 'gameOver()' }]
-        };
-        let scripts = [
-            {
-                id: 'scriptbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [childBranch]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new script_branches_map_1.ScriptBranchesMap(scripts);
-        visitedBranchesMap.setVisited(scripts[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getBranchLocation(childBranch)).toEqual({
-            scriptId: 'scriptbasic',
-            path: ['actions', '0', 'branchByCondition', '0']
-        });
-    });
-    (0, vitest_1.test)('get branch path', () => {
-        let childAction = { type: 'command', value: 'gameOver()' };
-        let scripts = [
-            {
-                id: 'scriptbasic',
-                actions: [
-                    {
-                        type: 'branchByCondition',
-                        value: [
-                            {
-                                condition: 'getPlayerCredits() >= 2000',
-                                actions: [childAction]
-                            }
-                        ]
-                    }
-                ]
-            }
-        ];
-        let visitedBranchesMap = new script_branches_map_1.ScriptBranchesMap(scripts);
-        visitedBranchesMap.setVisited(scripts[0]);
-        (0, vitest_1.expect)(visitedBranchesMap.getActionLocation(childAction)).toEqual({
-            scriptId: 'scriptbasic',
-            path: ['actions', '0', 'branchByCondition', '0', 'actions', '0']
-        });
-    });
-});
-//# sourceMappingURL=script-branches-map.test.js.map

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

@@ -1,42 +0,0 @@
-import { JSEngine } from 'helpers-lib';
-import { ExecutionLocation, ScriptDefinition, ScriptTestActionDefinition } from '../interfaces';
-export declare abstract class ScriptEngineSimulatorFunctions {
-    abstract onDialog(text: string, speaker: string): void;
-    abstract onPlayerChoice(choices: readonly string[]): void;
-    abstract onEnd(): void;
-    abstract onScriptBranchingEnd(): void;
-}
-export interface ScriptTestSimulatorOptions {
-    readonly prscriptTypeChanges?: boolean;
-    readonly richTextTags?: Set<string>;
-}
-export declare class ScriptTestSimulator<T extends ScriptEngineSimulatorFunctions> {
-    private scriptDefinitions;
-    private options;
-    private scriptBranchesMap;
-    private globalNameSpace?;
-    private visitedBranchStates;
-    constructor(scriptDefinitions: ScriptDefinition[], options?: ScriptTestSimulatorOptions);
-    /**
-     * @throws SimulationError, ActionsBeforeTestingError, BranchingBeforeTestingError
-     */
-    simulateScript(scriptDefinition: ScriptDefinition, jsEngine: JSEngine<T>, actionsBeforeTesting: readonly ScriptTestActionDefinition[]): void;
-    getUnvisitedBranchLocations(): ExecutionLocation[];
-    private processActionsBeforeTesting;
-    private executeActionBeforeTesting;
-    private branchOutFromScript;
-    private executeScript;
-    private executeBranch;
-    private executeAction;
-    private executeActionCommand;
-    private executeDialogCommand;
-    private executeActionjumpTo;
-    private executeActionBranchByCondition;
-    private executeActionBranchByChance;
-    private executeActionBranchByPlayerChoice;
-    private checkBranchCondition;
-    private removeDuplicateEndings;
-    private isBranchVisitedAndRegister;
-    private duplicateContext;
-    private prepareErrorMessage;
-}