bard-legends-framework 0.11.0 → 0.12.1

package/dist/utilities/animator/state-animation/fade-in/fade-in-state-animation.test.js

@@ -0,0 +1,431 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const game_entities_1 = require("../../../../game-entities");
+const fade_in_state_animation_1 = require("./fade-in-state-animation");
+(0, vitest_1.describe)('FadeInStateAnimation', () => {
+    let heap = [];
+    let stateAnimation;
+    (0, vitest_1.beforeEach)(async () => {
+        if (stateAnimation) {
+            stateAnimation.destroy();
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+        }
+        heap = [];
+        stateAnimation = new fade_in_state_animation_1.FadeInStateAnimation({ duration: 4 })
+            .onStateChange(state => heap.push(state))
+            .onValueChange(value => heap.push(value))
+            .attachToRoot();
+    });
+    (0, vitest_1.describe)('Appearing', () => {
+        (0, vitest_1.test)('default values', () => {
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: undefined,
+                queuedState: undefined,
+                animationState: 'hidden'
+            });
+        });
+        (0, vitest_1.test)('initial values', () => {
+            stateAnimation.setState('A');
+            (0, vitest_1.expect)(heap).toEqual(['A']);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'appearing'
+            });
+        });
+        (0, vitest_1.test)('animation in the middle', async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual(['A', 0.25]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.25,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'appearing'
+            });
+        });
+        (0, vitest_1.test)('animation end', async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            (0, vitest_1.expect)(heap).toEqual(['A', 1]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+        (0, vitest_1.test)('instant once', async () => {
+            stateAnimation.setState('A', { instant: true });
+            (0, vitest_1.expect)(heap).toEqual(['A', 1]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+        (0, vitest_1.test)('instant twice', async () => {
+            stateAnimation.setState('A', { instant: true });
+            heap = [];
+            stateAnimation.setState('A', { instant: true });
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+    });
+    (0, vitest_1.describe)('Disappearing', () => {
+        (0, vitest_1.beforeEach)(async () => {
+            stateAnimation.setState('A', { instant: true });
+            heap = [];
+        });
+        (0, vitest_1.test)('initial values', async () => {
+            stateAnimation.setState(undefined);
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'disappearing'
+            });
+        });
+        (0, vitest_1.test)('animation in the middle', async () => {
+            stateAnimation.setState(undefined);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual([0.75]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.75,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'disappearing'
+            });
+        });
+        (0, vitest_1.test)('animation end', async () => {
+            stateAnimation.setState(undefined);
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            (0, vitest_1.expect)(heap).toEqual([undefined, 0]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: undefined,
+                queuedState: undefined,
+                animationState: 'hidden'
+            });
+        });
+        (0, vitest_1.test)('instant', async () => {
+            stateAnimation.setState(undefined, { instant: true });
+            (0, vitest_1.expect)(heap).toEqual([undefined, 0]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: undefined,
+                queuedState: undefined,
+                animationState: 'hidden'
+            });
+        });
+    });
+    (0, vitest_1.describe)('Cancel appearing', () => {
+        (0, vitest_1.beforeEach)(async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+        });
+        (0, vitest_1.test)('initial values', () => {
+            stateAnimation.setState(undefined);
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.5,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'disappearing'
+            });
+        });
+        (0, vitest_1.test)('animation end', async () => {
+            stateAnimation.setState(undefined);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            (0, vitest_1.expect)(heap).toEqual([undefined, 0]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: undefined,
+                queuedState: undefined,
+                animationState: 'hidden'
+            });
+        });
+        (0, vitest_1.test)('instant', async () => {
+            stateAnimation.setState(undefined, { instant: true });
+            (0, vitest_1.expect)(heap).toEqual([undefined, 0]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: undefined,
+                queuedState: undefined,
+                animationState: 'hidden'
+            });
+        });
+    });
+    (0, vitest_1.describe)('Cancel disappearing', () => {
+        (0, vitest_1.beforeEach)(async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            stateAnimation.setState(undefined);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+        });
+        (0, vitest_1.test)('initial values', () => {
+            stateAnimation.setState('A');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.5,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'appearing'
+            });
+        });
+        (0, vitest_1.test)('animation end', async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            (0, vitest_1.expect)(heap).toEqual([1]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+        (0, vitest_1.test)('instant', async () => {
+            stateAnimation.setState('A', { instant: true });
+            (0, vitest_1.expect)(heap).toEqual([1]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+        (0, vitest_1.test)('callbacks', async () => {
+            let stateChangeCalledWith = 'unset';
+            let valueChangeCalledWith = 'unset';
+            stateAnimation
+                .onStateChange(state => {
+                stateChangeCalledWith = state;
+            })
+                .onValueChange(value => {
+                valueChangeCalledWith = value;
+            });
+            stateAnimation.setState('A');
+            (0, vitest_1.expect)(stateChangeCalledWith).toBe('unset');
+            (0, vitest_1.expect)(valueChangeCalledWith).toBe('unset');
+            stateChangeCalledWith = 'unset';
+            valueChangeCalledWith = 'unset';
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateChangeCalledWith).toBe('unset');
+            (0, vitest_1.expect)(valueChangeCalledWith).toBe(0.75);
+            stateChangeCalledWith = 'unset';
+            valueChangeCalledWith = 'unset';
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(stateChangeCalledWith).toBe('unset');
+            (0, vitest_1.expect)(valueChangeCalledWith).toBe(1);
+        });
+    });
+    (0, vitest_1.describe)('Disappear to change', () => {
+        (0, vitest_1.beforeEach)(async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            heap = [];
+        });
+        (0, vitest_1.test)('initial values', async () => {
+            stateAnimation.setState('B');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: 'B',
+                animationState: 'disappearToChange'
+            });
+        });
+        (0, vitest_1.test)('dissapear animation in the middle', async () => {
+            stateAnimation.setState('B');
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual([0.75]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.75,
+                state: 'A',
+                queuedState: 'B',
+                animationState: 'disappearToChange'
+            });
+        });
+        (0, vitest_1.test)('dissapear animation end', async () => {
+            stateAnimation.setState('B');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            (0, vitest_1.expect)(heap).toEqual(['B', 0]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: 'B',
+                queuedState: undefined,
+                animationState: 'appearing'
+            });
+        });
+        (0, vitest_1.test)('appear animation in the middle', async () => {
+            stateAnimation.setState('B');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual(['B', 0, 0.25]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.25,
+                state: 'B',
+                queuedState: undefined,
+                animationState: 'appearing'
+            });
+        });
+        (0, vitest_1.test)('appear animation end', async () => {
+            stateAnimation.setState('B');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            (0, vitest_1.expect)(heap).toEqual(['B', 0, 1]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'B',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+        (0, vitest_1.test)('returning back to the original state', async () => {
+            stateAnimation.setState('B');
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual([0.75, 1]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+        (0, vitest_1.test)('edge case, changing the decition back at the moment of re-appearing', async () => {
+            stateAnimation.setState('B');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(1);
+            (0, vitest_1.expect)(heap).toEqual(['B', 0, 'A', 0.25]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.25,
+                state: 'A',
+                queuedState: undefined,
+                animationState: 'appearing'
+            });
+        });
+        (0, vitest_1.test)('instant', async () => {
+            stateAnimation.setState('B', { instant: true });
+            (0, vitest_1.expect)(heap).toEqual(['B', 1]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'B',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+    });
+    (0, vitest_1.describe)('Nullish State', () => {
+        (0, vitest_1.test)('initial values', () => {
+            stateAnimation.setState('');
+            (0, vitest_1.expect)(heap).toEqual(['']);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0,
+                state: '',
+                queuedState: undefined,
+                animationState: 'appearing'
+            });
+        });
+        (0, vitest_1.test)('instant', () => {
+            stateAnimation.setState('', { instant: true });
+            // expect(heap).toEqual(['', 0]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: '',
+                queuedState: undefined,
+                animationState: 'visible'
+            });
+        });
+        (0, vitest_1.test)('Cancel appearing', async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+            stateAnimation.setState('');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.5,
+                state: 'A',
+                queuedState: '',
+                animationState: 'disappearToChange'
+            });
+        });
+        (0, vitest_1.test)('Cancel disappearing', async () => {
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            stateAnimation.setState(undefined);
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+            stateAnimation.setState('');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.5,
+                state: 'A',
+                queuedState: '',
+                animationState: 'disappearToChange'
+            });
+        });
+        (0, vitest_1.test)('Disappear to change', () => {
+            stateAnimation.setState('A', { instant: true });
+            heap = [];
+            stateAnimation.setState('');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 1,
+                state: 'A',
+                queuedState: '',
+                animationState: 'disappearToChange'
+            });
+        });
+        (0, vitest_1.test)('Change disappear to change', async () => {
+            stateAnimation.setState('A', { instant: true });
+            stateAnimation.setState('B');
+            game_entities_1.UpdateCycle.triggerUpdateTick(2);
+            heap = [];
+            stateAnimation.setState('');
+            (0, vitest_1.expect)(heap).toEqual([]);
+            (0, vitest_1.expect)(stateAnimation.currentState).toEqual({
+                value: 0.5,
+                state: 'A',
+                queuedState: '',
+                animationState: 'disappearToChange'
+            });
+        });
+    });
+    (0, vitest_1.describe)('Error Cases:', () => {
+        (0, vitest_1.test)('completion on hidden state', async () => {
+            let consoleErrorSpy = vitest_1.vi.spyOn(console, 'error').mockImplementation(() => { });
+            stateAnimation.setState('A');
+            stateAnimation.setState(undefined);
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            (0, vitest_1.expect)(consoleErrorSpy).not.toBeCalled();
+            consoleErrorSpy.mockRestore();
+        });
+        (0, vitest_1.test)('completion on visible state', async () => {
+            let consoleErrorSpy = vitest_1.vi.spyOn(console, 'error').mockImplementation(() => { });
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            stateAnimation.setState(undefined);
+            stateAnimation.setState('A');
+            game_entities_1.UpdateCycle.triggerUpdateTick(4);
+            (0, vitest_1.expect)(consoleErrorSpy).not.toBeCalled();
+            consoleErrorSpy.mockRestore();
+        });
+    });
+});
+//# sourceMappingURL=fade-in-state-animation.test.js.map

package/dist/utilities/animator/state-animation/slide/slide-in-content.d.ts

@@ -0,0 +1,37 @@
+import { Vector } from 'helpers-lib';
+import { Container } from '../../../../pixi/display-object/container';
+import { AnimatorAnimation } from '../../animations';
+export interface ScrollInContentOptions {
+    readonly duration: number;
+    readonly animation: AnimatorAnimation;
+    readonly size: Vector;
+    readonly margin: number;
+    readonly direction: 'horizontal' | 'vertical';
+}
+export declare class SlideInContentByIndex extends Container {
+    private createFunction;
+    private options;
+    private directionProperty;
+    private stateAnimation;
+    private contents;
+    constructor(createFunction: (value: {
+        index: number;
+        container: Container;
+    }) => void, partialOptions?: Partial<ScrollInContentOptions>);
+    setIndex(index: number, options?: {
+        instant?: boolean;
+    }): this;
+    private createMask;
+}
+export declare class SlideInContent<T> extends SlideInContentByIndex {
+    readonly itemToIndex: Map<T, number>;
+    readonly indexToItem: Map<number, T>;
+    constructor(items: T[], createFunction: (value: {
+        index: number;
+        item: T;
+        container: Container;
+    }) => void, partialOptions?: Partial<ScrollInContentOptions>);
+    setItem(item: T, options?: {
+        instant?: boolean;
+    }): this;
+}

package/dist/utilities/animator/state-animation/slide/slide-in-content.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SlideInContent = exports.SlideInContentByIndex = void 0;
+const helpers_lib_1 = require("helpers-lib");
+const scroll_mask_ui_1 = require("../../../../pixi/components/scroll-mask.ui");
+const container_1 = require("../../../../pixi/display-object/container");
+const animations_1 = require("../../animations");
+const slide_state_animation_1 = require("./slide-state-animation");
+class SlideInContentByIndex extends container_1.Container {
+    constructor(createFunction, partialOptions) {
+        super();
+        this.createFunction = createFunction;
+        this.directionProperty = 'x';
+        this.contents = new Map();
+        this.options = {
+            duration: 300,
+            animation: animations_1.Animations.easeInOutCubic,
+            size: new helpers_lib_1.Vector(500, 500),
+            margin: 20,
+            direction: 'horizontal',
+            ...partialOptions
+        };
+        let fullSize = this.options.direction === 'horizontal'
+            ? new helpers_lib_1.Vector(this.options.size.x + this.options.margin * 2, this.options.size.y)
+            : new helpers_lib_1.Vector(this.options.size.x, this.options.size.y + this.options.margin * 2);
+        let wrapper = new container_1.Container()
+            .setPosition(this.options.direction === 'horizontal' ? new helpers_lib_1.Vector(-this.options.margin, 0) : new helpers_lib_1.Vector(0, -this.options.margin), { round: false })
+            .displayParent(this)
+            .attach(this);
+        this.createMask(fullSize, this.options.margin, this.options.direction, wrapper);
+        this.directionProperty = this.options.direction === 'horizontal' ? 'x' : 'y';
+        this.stateAnimation = new slide_state_animation_1.SlideStateAnimation({
+            duration: this.options.duration,
+            animation: this.options.animation
+        })
+            .onStateChange((state, index) => {
+            if (state === slide_state_animation_1.SlideStateAnimationState.appear) {
+                let container = new container_1.Container().displayParent(this).attach(this);
+                this.contents.set(index, container);
+                this.createFunction({ index, container });
+            }
+            else {
+                let container = this.contents.get(index);
+                if (container) {
+                    container.destroy();
+                    this.contents.delete(index);
+                }
+            }
+        })
+            .onValueChange((value, index) => {
+            let container = this.contents.get(index);
+            if (container) {
+                let vec = { x: 0, y: 0 };
+                vec[this.directionProperty] = fullSize[this.directionProperty] * value + this.options.margin;
+                container.setPosition(helpers_lib_1.Vector.fromVec2(vec), { round: false });
+            }
+        })
+            .attach(this);
+        this.addChildTo = wrapper;
+    }
+    setIndex(index, options) {
+        this.stateAnimation.setIndex(index, options);
+        return this;
+    }
+    createMask(size, padding, direction, container) {
+        new scroll_mask_ui_1.ScrollMaskUI(container, new helpers_lib_1.Vector(size.x, size.y), padding, direction).attach(this);
+    }
+}
+exports.SlideInContentByIndex = SlideInContentByIndex;
+class SlideInContent extends SlideInContentByIndex {
+    constructor(items, createFunction, partialOptions) {
+        super((value) => {
+            let item = this.indexToItem.get(value.index);
+            if (item) {
+                createFunction({ index: value.index, item, container: value.container });
+            }
+            else {
+                throw new Error(`SlideInContent: The item with index '${value.index}' is not part of the items list`);
+            }
+        }, partialOptions);
+        this.itemToIndex = new Map();
+        this.indexToItem = new Map();
+        items.forEach((item, index) => {
+            this.itemToIndex.set(item, index);
+            this.indexToItem.set(index, item);
+        });
+    }
+    setItem(item, options) {
+        let index = this.itemToIndex.get(item);
+        if (index !== undefined) {
+            this.setIndex(index, options);
+        }
+        else {
+            throw new Error(`SlideInContent: The item '${item}' is not part of the items list`);
+        }
+        return this;
+    }
+}
+exports.SlideInContent = SlideInContent;
+//# sourceMappingURL=slide-in-content.js.map

package/dist/utilities/animator/state-animation/slide/slide-in-content.test.d.ts

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

package/dist/utilities/animator/state-animation/slide/slide-in-content.test.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const slide_in_content_1 = require("./slide-in-content");
+(0, vitest_1.describe)('Slide In Content', () => {
+    (0, vitest_1.test)('should exist', () => {
+        (0, vitest_1.expect)(slide_in_content_1.SlideInContent).toBeDefined();
+    });
+});
+//# sourceMappingURL=slide-in-content.test.js.map

package/dist/utilities/animator/state-animation/slide/slide-state-animation.d.ts

@@ -0,0 +1,24 @@
+import { Attachable } from 'actions-lib';
+import { StateAnimationOptions } from '../state-animation';
+export declare enum SlideStateAnimationState {
+    appear = "appear",
+    disappear = "disappear"
+}
+export declare class SlideStateAnimation extends Attachable {
+    private stateAnimation;
+    private options;
+    private index;
+    private nextIndex;
+    private animationState;
+    constructor(partialOptions?: Partial<StateAnimationOptions>);
+    setIndex(index: number, options?: {
+        instant?: boolean;
+    }): void;
+    private handleStateChange;
+    private handleValueChange;
+    private handleNewTarget;
+    private onStateChangeAction;
+    private onValueChangeAction;
+    onStateChange(callback: (state: SlideStateAnimationState, index: number) => void): this;
+    onValueChange(callback: (value: number, index: number) => void): this;
+}