script-engine-lib 0.4.3 → 1.0.0-rc1

package/dist/interfaces.d.ts

@@ -1,51 +0,0 @@
-export type ScriptActionType = 'command' | 'dialog' | 'jumpTo' | 'branchByCondition' | 'branchByPlayerChoice' | 'branchByChance';
-export interface DialogItemDefinition {
-    readonly text: string;
-    readonly speaker: string;
-}
-export interface BranchByConditionItemDefinition {
-    readonly condition?: string;
-    readonly actions: readonly ScriptActionDefinition[];
-}
-export interface BranchByPlayerChoiceItemDefinition {
-    readonly text: string;
-    readonly condition?: string;
-    readonly actions: readonly ScriptActionDefinition[];
-}
-export interface BranchByChanceItemDefinition {
-    readonly label?: string;
-    readonly weight: number | string;
-    readonly condition?: string;
-    readonly actions: readonly ScriptActionDefinition[];
-}
-export interface ScriptActionDefinition {
-    readonly type: ScriptActionType;
-    readonly value: string | DialogItemDefinition | readonly BranchByConditionItemDefinition[] | readonly BranchByPlayerChoiceItemDefinition[] | readonly BranchByChanceItemDefinition[];
-}
-export interface ScriptDefinition {
-    readonly id: string;
-    readonly actions: readonly ScriptActionDefinition[];
-}
-export type VisitableScriptBranchDefinition = ScriptDefinition | BranchByConditionItemDefinition | BranchByPlayerChoiceItemDefinition | BranchByChanceItemDefinition;
-export interface ExecutionLocation {
-    readonly scriptId: string;
-    readonly path: readonly string[];
-}
-export type ActionBeforeTestType = 'command' | 'runScript';
-export interface ScriptTestActionDefinition {
-    readonly type: ActionBeforeTestType;
-    readonly value: string;
-}
-export declare class SimulationError extends Error {
-    readonly location: ExecutionLocation;
-    constructor(message: string, location: ExecutionLocation);
-}
-export declare class ActionsBeforeTestingError extends Error {
-    readonly actionIndex: number;
-    constructor(message: string, actionIndex: number);
-}
-export declare class BranchingBeforeTestingError extends Error {
-    readonly actionIndex: number;
-    readonly location: ExecutionLocation;
-    constructor(message: string, actionIndex: number, location: ExecutionLocation);
-}

package/dist/interfaces.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BranchingBeforeTestingError = exports.ActionsBeforeTestingError = exports.SimulationError = void 0;
-// --------------- Script Simulation Errors ---------------
-class SimulationError extends Error {
-    constructor(message, location) {
-        super(message);
-        this.location = location;
-    }
-}
-exports.SimulationError = SimulationError;
-class ActionsBeforeTestingError extends Error {
-    constructor(message, actionIndex) {
-        super(message);
-        this.actionIndex = actionIndex;
-    }
-}
-exports.ActionsBeforeTestingError = ActionsBeforeTestingError;
-class BranchingBeforeTestingError extends Error {
-    constructor(message, actionIndex, location) {
-        super(message);
-        this.actionIndex = actionIndex;
-        this.location = location;
-    }
-}
-exports.BranchingBeforeTestingError = BranchingBeforeTestingError;
-//# sourceMappingURL=interfaces.js.map

package/dist/simulator/decorators.d.ts

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

package/dist/simulator/decorators.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=decorators.js.map

package/dist/simulator/decorators.test.d.ts

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

package/dist/simulator/decorators.test.js

@@ -1,81 +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 story_engine_1 = require("../engine/story-engine");
-const decorators_1 = require("./decorators");
-const event_test_simulator_1 = require("./event-test-simulator");
-let SampleFunctions = class SampleFunctions extends story_engine_1.StoryEngineFunctions {
-    onPlayerChoice(choices) { }
-    onEnd() { }
-    exclusive() { }
-    sayHi(message) { }
-};
-__decorate([
-    (0, decorators_1.ActionBeforeTesting)(),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
-    __metadata("design:returntype", void 0)
-], SampleFunctions.prototype, "exclusive", null);
-__decorate([
-    (0, decorators_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)('EventTestSimulator', () => {
-    let functions;
-    (0, vitest_1.beforeEach)(() => {
-        functions = new SampleFunctions();
-    });
-    (0, vitest_1.test)('sample 1 - valid call', () => {
-        let actionsBeforeTesting = [{ type: 'command', value: 'exclusive()' }];
-        let events = [
-            {
-                id: 'event1',
-                actions: [{ type: 'command', value: 'a = 1' }]
-            }
-        ];
-        let simulator = new event_test_simulator_1.EventTestSimulator(events);
-        let jsEngine = new helpers_lib_1.JSEngine(functions, {});
-        (0, vitest_1.expect)(() => simulator.simulateEvent(events[0], jsEngine, actionsBeforeTesting)).not.toThrow();
-    });
-    (0, vitest_1.test)('sample 2 - call during execution error', () => {
-        let events = [
-            {
-                id: 'event1',
-                actions: [{ type: 'command', value: 'exclusive()' }]
-            }
-        ];
-        let simulator = new event_test_simulator_1.EventTestSimulator(events);
-        let jsEngine = new helpers_lib_1.JSEngine(functions, {});
-        (0, vitest_1.expect)(() => simulator.simulateEvent(events[0], jsEngine, [])).toThrow('"exclusive(...)" can only be called at "actions before testing"');
-    });
-    (0, vitest_1.test)('sample 3 - wrong parameter count error', () => {
-        let events = [
-            {
-                id: 'event1',
-                actions: [{ type: 'command', value: 'exclusive("a")' }]
-            }
-        ];
-        let simulator = new event_test_simulator_1.EventTestSimulator(events);
-        let jsEngine = new helpers_lib_1.JSEngine(functions, {});
-        (0, vitest_1.expect)(() => simulator.simulateEvent(events[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=decorators.test.js.map

package/dist/simulator/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/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/event-branches-map.test.d.ts

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

package/dist/simulator/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/event-test-simulator.d.ts

@@ -1,42 +0,0 @@
-import { JSEngine } from 'helpers-lib';
-import { EventDefinition, EventTestActionDefinition, ExecutionLocation } from '../interfaces';
-export declare abstract class StoryEngineSimulatorFunctions {
-    abstract onDialog(text: string, speaker: string): void;
-    abstract onPlayerChoice(choices: readonly string[]): void;
-    abstract onEnd(): void;
-    abstract onEventBranchingEnd(): void;
-}
-export interface EventTestSimulatorOptions {
-    readonly preventTypeChanges?: boolean;
-    readonly richTextTags?: Set<string>;
-}
-export declare class EventTestSimulator<T extends StoryEngineSimulatorFunctions> {
-    private eventDefinitions;
-    private options;
-    private eventBranchesMap;
-    private globalNameSpace?;
-    private visitedBranchStates;
-    constructor(eventDefinitions: EventDefinition[], options?: EventTestSimulatorOptions);
-    /**
-     * @throws SimulationError, ActionsBeforeTestingError, BranchingBeforeTestingError
-     */
-    simulateEvent(eventDefinition: EventDefinition, jsEngine: JSEngine<T>, actionsBeforeTesting: readonly EventTestActionDefinition[]): void;
-    getUnvisitedBranchLocations(): ExecutionLocation[];
-    private processActionsBeforeTesting;
-    private executeActionBeforeTesting;
-    private branchOutFromEvent;
-    private executeEvent;
-    private executeBranch;
-    private executeAction;
-    private executeActionCommand;
-    private executeDialogCommand;
-    private executeActionJumpToEvent;
-    private executeActionBranchByCondition;
-    private executeActionBranchByChance;
-    private executeActionBranchByPlayerChoice;
-    private checkBranchCondition;
-    private removeDuplicateEndings;
-    private isBranchVisitedAndRegister;
-    private duplicateContext;
-    private prepareErrorMessage;
-}