bard-legends-framework 0.10.8 → 0.11.0

package/dist/game-entities/base/helpers/attachable.store.test.js

@@ -0,0 +1,234 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const attachable_1 = require("../attachable");
+const attachable_store_1 = require("./attachable.store");
+(0, vitest_1.describe)('AttachableStore', () => {
+    (0, vitest_1.beforeEach)(() => {
+        attachable_store_1.AttachableStore.hardReset();
+    });
+    (0, vitest_1.describe)('registerAttachmentTarget', () => {
+        (0, vitest_1.test)('generates unique id for single instance', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance = new TestClass().attachToRoot();
+            let id = instance.id;
+            (0, vitest_1.expect)(id).toBe('1:1');
+        });
+        (0, vitest_1.test)('generates sequential ids for multiple instances of same class', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance1 = new TestClass().attachToRoot();
+            let instance2 = new TestClass().attachToRoot();
+            let instance3 = new TestClass().attachToRoot();
+            (0, vitest_1.expect)([instance1.id, instance2.id, instance3.id]).toEqual(['1:1', '1:2', '1:3']);
+        });
+        (0, vitest_1.test)('generates different class ids for different classes', () => {
+            class TestClass1 extends attachable_1.Attachable {
+            }
+            class TestClass2 extends attachable_1.Attachable {
+            }
+            let instance1 = new TestClass1().attachToRoot();
+            let instance2 = new TestClass2().attachToRoot();
+            (0, vitest_1.expect)(instance1.id).toBe('1:1');
+            (0, vitest_1.expect)(instance2.id).toBe('2:1');
+        });
+        (0, vitest_1.test)('maintains separate numbering for different classes', () => {
+            class TestClass1 extends attachable_1.Attachable {
+            }
+            class TestClass2 extends attachable_1.Attachable {
+            }
+            let instance1a = new TestClass1().attachToRoot();
+            let instance2a = new TestClass2().attachToRoot();
+            let instance1b = new TestClass1().attachToRoot();
+            let instance2b = new TestClass2().attachToRoot();
+            (0, vitest_1.expect)([instance1a.id, instance2a.id, instance1b.id, instance2b.id]).toEqual(['1:1', '2:1', '1:2', '2:2']);
+        });
+    });
+    (0, vitest_1.describe)('findAttachmentTarget', () => {
+        (0, vitest_1.test)('finds registered attachable by string id', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance = new TestClass().attachToRoot();
+            let found = attachable_store_1.AttachableStore.findAttachmentTarget(instance.id);
+            (0, vitest_1.expect)(found).toBe(instance);
+        });
+        (0, vitest_1.test)('returns same object when passed an Attachable instance', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance = new TestClass().attachToRoot();
+            let found = attachable_store_1.AttachableStore.findAttachmentTarget(instance);
+            (0, vitest_1.expect)(found).toBe(instance);
+        });
+        (0, vitest_1.test)('throws error for non-existent id', () => {
+            (0, vitest_1.expect)(() => {
+                attachable_store_1.AttachableStore.findAttachmentTarget('999:999');
+            }).toThrow('Attachable: attachable not found by id! id: 999:999');
+        });
+        (0, vitest_1.test)('throws error for empty string id', () => {
+            (0, vitest_1.expect)(() => {
+                attachable_store_1.AttachableStore.findAttachmentTarget('');
+            }).toThrow('Attachable: attachable not found by id! id: ');
+        });
+    });
+    (0, vitest_1.describe)('unregisterAttachmentTarget', () => {
+        (0, vitest_1.test)('removes attachable from store', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance = new TestClass().attachToRoot();
+            let id = instance.id;
+            attachable_store_1.AttachableStore.unregisterAttachmentTarget(instance);
+            (0, vitest_1.expect)(() => {
+                attachable_store_1.AttachableStore.findAttachmentTarget(id);
+            }).toThrow(`Attachable: attachable not found by id! id: ${id}`);
+        });
+        (0, vitest_1.test)('allows reusing id after unregister and hardReset', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance1 = new TestClass().attachToRoot();
+            let firstId = instance1.id;
+            attachable_store_1.AttachableStore.unregisterAttachmentTarget(instance1);
+            attachable_store_1.AttachableStore.hardReset();
+            let instance2 = new TestClass().attachToRoot();
+            let secondId = instance2.id;
+            (0, vitest_1.expect)(secondId).toBe(firstId);
+        });
+    });
+    (0, vitest_1.describe)('validateIdForClass', () => {
+        (0, vitest_1.test)('returns true for matching class', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance = new TestClass().attachToRoot();
+            let isValid = attachable_store_1.AttachableStore.validateIdForClass(instance.id, TestClass);
+            (0, vitest_1.expect)(isValid).toBe(true);
+        });
+        (0, vitest_1.test)('returns false for non-matching class', () => {
+            class TestClass1 extends attachable_1.Attachable {
+            }
+            class TestClass2 extends attachable_1.Attachable {
+            }
+            let instance = new TestClass1().attachToRoot();
+            let isValid = attachable_store_1.AttachableStore.validateIdForClass(instance.id, TestClass2);
+            (0, vitest_1.expect)(isValid).toBe(false);
+        });
+        (0, vitest_1.test)('returns false for non-existent id', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let isValid = attachable_store_1.AttachableStore.validateIdForClass('999:999', TestClass);
+            (0, vitest_1.expect)(isValid).toBe(false);
+        });
+        (0, vitest_1.test)('validates correctly for derived classes', () => {
+            class BaseClass extends attachable_1.Attachable {
+            }
+            class DerivedClass extends BaseClass {
+            }
+            let instance = new DerivedClass().attachToRoot();
+            let isValidForDerived = attachable_store_1.AttachableStore.validateIdForClass(instance.id, DerivedClass);
+            let isValidForBase = attachable_store_1.AttachableStore.validateIdForClass(instance.id, BaseClass);
+            (0, vitest_1.expect)(isValidForDerived).toBe(true);
+            (0, vitest_1.expect)(isValidForBase).toBe(false);
+        });
+    });
+    (0, vitest_1.describe)('hardReset', () => {
+        (0, vitest_1.test)('resets class id counter', () => {
+            class TestClass1 extends attachable_1.Attachable {
+            }
+            class TestClass2 extends attachable_1.Attachable {
+            }
+            new TestClass1().attachToRoot();
+            new TestClass2().attachToRoot();
+            attachable_store_1.AttachableStore.hardReset();
+            class TestClass3 extends attachable_1.Attachable {
+            }
+            let instance = new TestClass3().attachToRoot();
+            (0, vitest_1.expect)(instance.id).toBe('1:1');
+        });
+        (0, vitest_1.test)('resets instance id counters', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            new TestClass().attachToRoot();
+            new TestClass().attachToRoot();
+            attachable_store_1.AttachableStore.hardReset();
+            let instance = new TestClass().attachToRoot();
+            (0, vitest_1.expect)(instance.id).toBe('1:1');
+        });
+        (0, vitest_1.test)('clears all registered attachables', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance = new TestClass().attachToRoot();
+            let id = instance.id;
+            attachable_store_1.AttachableStore.hardReset();
+            (0, vitest_1.expect)(() => {
+                attachable_store_1.AttachableStore.findAttachmentTarget(id);
+            }).toThrow(`Attachable: attachable not found by id! id: ${id}`);
+        });
+        (0, vitest_1.test)('clears class validation data', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance = new TestClass().attachToRoot();
+            let id = instance.id;
+            attachable_store_1.AttachableStore.hardReset();
+            let isValid = attachable_store_1.AttachableStore.validateIdForClass(id, TestClass);
+            (0, vitest_1.expect)(isValid).toBe(false);
+        });
+    });
+    (0, vitest_1.describe)('multiple classes interaction', () => {
+        (0, vitest_1.test)('handles multiple classes with multiple instances each', () => {
+            class ClassA extends attachable_1.Attachable {
+            }
+            class ClassB extends attachable_1.Attachable {
+            }
+            class ClassC extends attachable_1.Attachable {
+            }
+            let a1 = new ClassA().attachToRoot();
+            let a2 = new ClassA().attachToRoot();
+            let b1 = new ClassB().attachToRoot();
+            let c1 = new ClassC().attachToRoot();
+            let c2 = new ClassC().attachToRoot();
+            let c3 = new ClassC().attachToRoot();
+            (0, vitest_1.expect)([a1.id, a2.id, b1.id, c1.id, c2.id, c3.id]).toEqual(['1:1', '1:2', '2:1', '3:1', '3:2', '3:3']);
+        });
+        (0, vitest_1.test)('finds correct instances after complex registration', () => {
+            class ClassA extends attachable_1.Attachable {
+            }
+            class ClassB extends attachable_1.Attachable {
+            }
+            let a1 = new ClassA().attachToRoot();
+            let b1 = new ClassB().attachToRoot();
+            let a2 = new ClassA().attachToRoot();
+            let foundA1 = attachable_store_1.AttachableStore.findAttachmentTarget(a1.id);
+            let foundB1 = attachable_store_1.AttachableStore.findAttachmentTarget(b1.id);
+            let foundA2 = attachable_store_1.AttachableStore.findAttachmentTarget(a2.id);
+            (0, vitest_1.expect)(foundA1).toBe(a1);
+            (0, vitest_1.expect)(foundB1).toBe(b1);
+            (0, vitest_1.expect)(foundA2).toBe(a2);
+        });
+    });
+    (0, vitest_1.describe)('edge cases', () => {
+        (0, vitest_1.test)('handles rapid registration and unregistration', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance1 = new TestClass().attachToRoot();
+            let id1 = instance1.id;
+            attachable_store_1.AttachableStore.unregisterAttachmentTarget(instance1);
+            let instance2 = new TestClass().attachToRoot();
+            let id2 = instance2.id;
+            (0, vitest_1.expect)(id2).toBe('1:2');
+            (0, vitest_1.expect)(() => {
+                attachable_store_1.AttachableStore.findAttachmentTarget(id1);
+            }).toThrow();
+        });
+        (0, vitest_1.test)('validates after partial unregistration', () => {
+            class TestClass extends attachable_1.Attachable {
+            }
+            let instance1 = new TestClass().attachToRoot();
+            let instance2 = new TestClass().attachToRoot();
+            attachable_store_1.AttachableStore.unregisterAttachmentTarget(instance1);
+            let isValid1 = attachable_store_1.AttachableStore.validateIdForClass(instance1.id, TestClass);
+            let isValid2 = attachable_store_1.AttachableStore.validateIdForClass(instance2.id, TestClass);
+            (0, vitest_1.expect)(isValid1).toBe(false);
+            (0, vitest_1.expect)(isValid2).toBe(true);
+        });
+    });
+});
+//# sourceMappingURL=attachable.store.test.js.map

package/dist/game-entities/base/helpers/decorate-actions-lib.d.ts

@@ -1,12 +1,12 @@
-import { AttachmentTarget } from '../attachment-target';
+import { Attachable } from '../attachable';
 declare module 'actions-lib' {
     interface ActionSubscription {
-        attach(parent: AttachmentTarget | string): ActionSubscription;
+        attach(parent: Attachable | string): ActionSubscription;
         attachToRoot(): ActionSubscription;
         decorateActionSubscription(): ActionSubscription;
     }
     interface ReducerEffectChannel<EffectType, ResponseType> {
-        attach(parent: AttachmentTarget | string): ReducerEffectChannel<EffectType, ResponseType>;
+        attach(parent: Attachable | string): ReducerEffectChannel<EffectType, ResponseType>;
         attachToRoot(): ReducerEffectChannel<EffectType, ResponseType>;
         decorateEffectChannel(): ReducerEffectChannel<EffectType, ResponseType>;
     }

package/dist/game-entities/base/helpers/decorate-actions-lib.js

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActionsLibDecorator = void 0;
 const ActionsLib = __importStar(require("actions-lib"));
-const attachment_target_store_1 = require("./attachment-target.store");
+const attachable_store_1 = require("./attachable.store");
 class ActionsLibDecorator {
     static decorate(actionsLib) {
         this.decorateAttachFunctions(actionsLib);
@@ -38,7 +38,7 @@ class ActionsLibDecorator {
     }
     static decorateAttachFunctions(actionsLib) {
         actionsLib.ActionSubscription.prototype.attach = function (parent) {
-            let parentEntity = attachment_target_store_1.AttachmentTargetStore.findAttachableParent(parent);
+            let parentEntity = attachable_store_1.AttachableStore.findAttachmentTarget(parent);
             parentEntity['setAttachment'](this);
             this.$meta = { attachIsCalled: true, attachedParent: parentEntity };
             return this;
@@ -61,7 +61,7 @@ class ActionsLibDecorator {
             return originalCombine(subscriptions);
         };
         actionsLib.ReducerEffectChannel.prototype.attach = function (parent) {
-            let parentEntity = attachment_target_store_1.AttachmentTargetStore.findAttachableParent(parent);
+            let parentEntity = attachable_store_1.AttachableStore.findAttachmentTarget(parent);
             parentEntity['setAttachment'](this);
             this.$meta = { attachIsCalled: true, attachedParent: parentEntity };
             return this;
@@ -84,7 +84,7 @@ class ActionsLibDecorator {
         actionsLib.ActionSubscription.prototype.unsubscribe = function () {
             let parentEntity = this.$meta?.attachedParent;
             if (parentEntity) {
-                parentEntity['removeAttachment'](this);
+                parentEntity.removeAttachment(this);
                 this.$meta.attachedParent = undefined;
             }
             originalUnsubscribe.call(this);
@@ -93,7 +93,7 @@ class ActionsLibDecorator {
         actionsLib.ReducerEffectChannel.prototype.unsubscribe = function () {
             let parentEntity = this.$meta?.attachedParent;
             if (parentEntity) {
-                parentEntity['removeAttachment'](this);
+                parentEntity.removeAttachment(this);
                 this.$meta.attachedParent = undefined;
             }
             originalEffectUnsubscribe.call(this);

package/dist/game-entities/base/helpers/referance-variable.d.ts

@@ -1,5 +1,5 @@
 import { ActionListenerCallbackFunction, ActionSubscription, IVariable } from 'actions-lib';
-import { AttachmentTarget } from '../attachment-target';
+import { Attachable } from '../attachable';
 export declare class ReferanceVariable implements IVariable<string | undefined> {
     private options;
     private variable;
@@ -8,7 +8,7 @@ export declare class ReferanceVariable implements IVariable<string | undefined>
     set value(value: string | undefined);
     get listenerCount(): number;
     constructor(options: {
-        attachTo: AttachmentTarget;
+        attachTo: Attachable;
     });
     set(data: string | undefined): this;
     subscribe(callback: ActionListenerCallbackFunction<string | undefined>): ActionSubscription;

package/dist/game-entities/base/helpers/referance-variable.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferanceVariable = void 0;
 const actions_lib_1 = require("actions-lib");
-const attachment_target_store_1 = require("./attachment-target.store");
+const attachable_store_1 = require("./attachable.store");
 class ReferanceVariable {
     get value() {
         return this.variable.value;
@@ -22,7 +22,7 @@ class ReferanceVariable {
             this.destroySubscription?.unsubscribe();
             this.destroySubscription = undefined;
             if (data) {
-                this.destroySubscription = attachment_target_store_1.AttachmentTargetStore.findAttachableParent(data)
+                this.destroySubscription = attachable_store_1.AttachableStore.findAttachmentTarget(data)
                     .onDestroy.subscribe(() => {
                     this.set(undefined);
                 })

package/dist/game-entities/controller/controller.d.ts

@@ -2,7 +2,6 @@ export declare class ControllerLink {
     private controllers;
     private registeredFunctionNames;
     trigger<T>(functionName: string, ...args: any[]): T;
-    private registerController;
 }
 export interface ControllerDecoratorMeta {
     controllerLink: ControllerLink;

package/dist/game-entities/controller/controller.js

@@ -16,6 +16,7 @@ class ControllerLink {
             return correspondingController[functionName](...args);
         }
     }
+    /** @internal */
     registerController(controller) {
         Reflect.ownKeys(controller.constructor.prototype)
             .filter(functionName => functionName !== 'constructor')

package/dist/game-entities/controller/controller.test.js

@@ -8,11 +8,11 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 Object.defineProperty(exports, "__esModule", { value: true });
 const vitest_1 = require("vitest");
 const service_1 = require("../service/service");
-const update_cycle_1 = require("../update-cycle");
+const unit_test_helper_1 = require("../unit-test.helper");
 const controller_1 = require("./controller");
 (0, vitest_1.describe)('CONTROLLER', () => {
     (0, vitest_1.beforeEach)(() => {
-        update_cycle_1.UpdateCycle.hardResetAction.trigger();
+        unit_test_helper_1.UnitTestHelper.hardReset();
     });
     (0, vitest_1.test)('when gateway triggers service link, it should trigger the controller function', () => {
         let sampleLink = new controller_1.ControllerLink();

package/dist/game-entities/entity/entity.d.ts

@@ -1,14 +1,15 @@
-import { AttachmentTarget } from '../base/attachment-target';
-export type EntityClassType = new (...args: any[]) => Entity;
-export declare function EntityDecorator(): (EntityClass: EntityClassType) => any;
-export declare abstract class Entity extends AttachmentTarget {
-    static getInstanceById<T extends Entity>(this: new (...args: any[]) => T, entityId: string | undefined): T | undefined;
-    static getInstanceByIdOrFail<T extends Entity>(this: new (...args: any[]) => T, entityId: string): T;
-    static getEntities<T extends Entity>(this: new (...args: any[]) => T): T[];
+import { Attachable } from 'actions-lib';
+export type EntityClassType<T extends Entity = Entity> = (new (...args: any[]) => T) & {
+    id: string;
+};
+export declare function EntityDecorator(): <T extends Entity>(EntityClass: EntityClassType<T>) => any;
+export declare abstract class Entity extends Attachable {
+    static getInstanceById<T extends Entity>(this: EntityClassType<T>, entityId: string | undefined): T | undefined;
+    static getInstanceByIdOrFail<T extends Entity>(this: EntityClassType<T>, entityId: string): T;
+    static getEntities<T extends Entity>(this: EntityClassType<T>): T[];
     private viewCreationHelper;
     constructor();
     destroy(): void;
-    protected destroySelf(): void;
-    attach(parent: AttachmentTarget | string): this;
+    attach(parent: Attachable | string): this;
     attachToRoot(): this;
 }

package/dist/game-entities/entity/entity.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Entity = exports.EntityDecorator = void 0;
-const attachment_target_1 = require("../base/attachment-target");
+const actions_lib_1 = require("actions-lib");
 const update_cycle_1 = require("../update-cycle");
 const entity_store_helper_1 = require("./helpers/entity-store.helper");
 const entity_views_helper_1 = require("./helpers/entity-views.helper");
@@ -14,14 +14,14 @@ function EntityDecorator() {
     };
 }
 exports.EntityDecorator = EntityDecorator;
-class Entity extends attachment_target_1.AttachmentTarget {
+class Entity extends actions_lib_1.Attachable {
     static getInstanceById(entityId) {
         if (entityId) {
-            return entity_store_helper_1.EntityStoreHelper.getIdToEntityMap(this).get(entityId);
+            return entity_store_helper_1.EntityStoreHelper.getEntity(this, entityId);
         }
     }
     static getInstanceByIdOrFail(entityId) {
-        let entity = entity_store_helper_1.EntityStoreHelper.getIdToEntityMap(this).get(entityId);
+        let entity = entity_store_helper_1.EntityStoreHelper.getEntity(this, entityId);
         if (!entity) {
             throw new Error(`Entity: entity is not found! Name: "${this.name}", id: "${entityId}"`);
         }
@@ -43,22 +43,18 @@ class Entity extends attachment_target_1.AttachmentTarget {
         })
             .attach(this);
     }
-    // make the destroy function non-internal
     destroy() {
-        super.destroy();
-    }
-    destroySelf() {
-        super.destroySelf();
-        this.viewCreationHelper.destroyViews();
-        entity_store_helper_1.EntityStoreHelper.unregisterEntity(this.constructor.name, this.id);
+        if (!this.destroyed) {
+            this.viewCreationHelper.destroyViews();
+            entity_store_helper_1.EntityStoreHelper.unregisterEntity(this.constructor, this.id);
+            super.destroy();
+        }
     }
-    // make the destroy function non-internal
     attach(parent) {
         super.attach(parent);
         this.viewCreationHelper.createViews();
         return this;
     }
-    // make the destroy function non-internal
     attachToRoot() {
         super.attachToRoot();
         this.viewCreationHelper.createViews();