@vived/core 1.4.1 → 1.4.3

package/dist/types/Entities/MemoizedString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedString.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedString.ts"],"names":[],"mappings":"AAAA,qBAAa,cAAc;IACzB,OAAO,CAAC,IAAI,CAAS;IACrB,IAAI,GAAG,IAAI,MAAM,CAEhB;IACD,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAKhB;IAEM,aAAa,CAAC,GAAG,EAAE,MAAM;IAIhC,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI/D"}
+{"version":3,"file":"MemoizedString.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedString.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,IAAI,CAAS;IAErB;;OAEG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAKhB;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM;IAIhC,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAI/D"}

package/dist/types/Entities/MemoizedVector2.d.ts

@@ -1,10 +1,31 @@
 import { Vector2 } from "../ValueObjects";
+/**
+ * A wrapper class for Vector2 objects that tracks changes and triggers callbacks.
+ * Only triggers the callback when the vector value actually changes.
+ */
 export declare class MemoizedVector2 {
     private _val;
+    /**
+     * Gets the current Vector2 value
+     */
     get val(): Vector2;
+    /**
+     * Sets the Vector2 value and triggers the onChange callback if the value changed
+     * @param v - The new Vector2 value
+     */
     set val(v: Vector2);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new Vector2 value
+     */
     setValQuietly(val: Vector2): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedVector2 instance
+     *
+     * @param initialValue - The initial Vector2 value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: Vector2, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedVector2.d.ts.map

package/dist/types/Entities/MemoizedVector2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedVector2.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedVector2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAU;IAEtB,IAAI,GAAG,IAAI,OAAO,CAEjB;IAED,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAKjB;IAEM,aAAa,CAAC,GAAG,EAAE,OAAO;IAIjC,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAIhE"}
+{"version":3,"file":"MemoizedVector2.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedVector2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAU;IAEtB;;OAEG;IACH,IAAI,GAAG,IAAI,OAAO,CAEjB;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAKjB;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,OAAO;IAIjC,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAIhE"}

package/dist/types/Entities/MemoizedVector3.d.ts

@@ -1,10 +1,31 @@
 import { Vector3 } from "../ValueObjects";
+/**
+ * A wrapper class for Vector3 objects that tracks changes and triggers callbacks.
+ * Only triggers the callback when the vector value actually changes.
+ */
 export declare class MemoizedVector3 {
     private _val;
+    /**
+     * Gets the current Vector3 value
+     */
     get val(): Vector3;
+    /**
+     * Sets the Vector3 value and triggers the onChange callback if the value changed
+     * @param v - The new Vector3 value
+     */
     set val(v: Vector3);
+    /**
+     * Sets the value without triggering the onChange callback
+     * @param val - The new Vector3 value
+     */
     setValQuietly(val: Vector3): void;
     private onChangeCallback;
+    /**
+     * Creates a new MemoizedVector3 instance
+     *
+     * @param initialValue - The initial Vector3 value
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(initialValue: Vector3, onChangeCallback: () => void);
 }
 //# sourceMappingURL=MemoizedVector3.d.ts.map

package/dist/types/Entities/MemoizedVector3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MemoizedVector3.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedVector3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAU;IAEtB,IAAI,GAAG,IAAI,OAAO,CAEjB;IAED,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAKjB;IAEM,aAAa,CAAC,GAAG,EAAE,OAAO;IAIjC,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAIhE"}
+{"version":3,"file":"MemoizedVector3.d.ts","sourceRoot":"","sources":["../../../src/Entities/MemoizedVector3.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;GAGG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAU;IAEtB;;OAEG;IACH,IAAI,GAAG,IAAI,OAAO,CAEjB;IAED;;;OAGG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAKjB;IAED;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,OAAO;IAIjC,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,YAAY,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAIhE"}

package/dist/types/Entities/ObservableEntity.d.ts

@@ -1,8 +1,28 @@
+/**
+ * Function type for entity observers
+ */
 export type EntityObserver = () => void;
+/**
+ * Base class that implements the Observable pattern.
+ * Allows other objects to register as observers and be notified of changes.
+ *
+ * Extend this class to make your entity observable.
+ */
 export declare abstract class ObservableEntity {
     private observerList;
+    /**
+     * Registers a new observer to be notified of changes
+     * @param observer Function to be called when the entity changes
+     */
     addObserver: (observer: EntityObserver) => void;
+    /**
+     * Unregisters an existing observer
+     * @param observer The observer function to remove
+     */
     removeObserver: (observer: EntityObserver) => void;
+    /**
+     * Notifies all registered observers about a change
+     */
     notify: () => void;
 }
 //# sourceMappingURL=ObservableEntity.d.ts.map

package/dist/types/Entities/ObservableEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ObservableEntity.d.ts","sourceRoot":"","sources":["../../../src/Entities/ObservableEntity.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC;AAExC,8BAAsB,gBAAgB;IACpC,OAAO,CAAC,YAAY,CAA4B;IAEhD,WAAW,GAAI,UAAU,cAAc,KAAG,IAAI,CAE5C;IACF,cAAc,GAAI,UAAU,cAAc,KAAG,IAAI,CAE/C;IACF,MAAM,aAEJ;CACH"}
+{"version":3,"file":"ObservableEntity.d.ts","sourceRoot":"","sources":["../../../src/Entities/ObservableEntity.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC;AAExC;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC,OAAO,CAAC,YAAY,CAA4B;IAEhD;;;OAGG;IACH,WAAW,GAAI,UAAU,cAAc,KAAG,IAAI,CAE5C;IAEF;;;OAGG;IACH,cAAc,GAAI,UAAU,cAAc,KAAG,IAAI,CAE/C;IAEF;;OAEG;IACH,MAAM,aAEJ;CACH"}

package/dist/types/Entities/ObserverList.d.ts

@@ -1,8 +1,29 @@
+/**
+ * A generic implementation of the Observer pattern.
+ * Maintains a list of observer functions that can be notified with a message.
+ *
+ * @typeParam T - The type of message that will be passed to observers
+ */
 export declare class ObserverList<T> {
     private observers;
+    /**
+     * Notifies all observers by calling them with the provided message
+     * @param msg - The message to send to all observers
+     */
     notify: (msg: T) => void;
+    /**
+     * Adds a new observer function to the list
+     * @param obs - The observer function to add
+     */
     add: (obs: (msg: T) => void) => void;
+    /**
+     * Removes an observer from the list
+     * @param obs - The observer function to remove
+     */
     remove: (obs: (msg: T) => void) => void;
+    /**
+     * Removes all observers from the list
+     */
     clear: () => void;
 }
 //# sourceMappingURL=ObserverList.d.ts.map

package/dist/types/Entities/ObserverList.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ObserverList.d.ts","sourceRoot":"","sources":["../../../src/Entities/ObserverList.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAY,CAAC,CAAC;IACzB,OAAO,CAAC,SAAS,CAA4B;IAEtC,MAAM,GAAI,KAAK,CAAC,UAItB;IAEM,GAAG,GAAI,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,UAElC;IAEM,MAAM,GAAI,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,UAKrC;IAEM,KAAK,aAEX;CACF"}
+{"version":3,"file":"ObserverList.d.ts","sourceRoot":"","sources":["../../../src/Entities/ObserverList.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,qBAAa,YAAY,CAAC,CAAC;IACzB,OAAO,CAAC,SAAS,CAA4B;IAE7C;;;OAGG;IACI,MAAM,GAAI,KAAK,CAAC,UAIrB;IAEF;;;OAGG;IACI,GAAG,GAAI,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,UAEjC;IAEF;;;OAGG;IACI,MAAM,GAAI,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,UAKpC;IAEF;;OAEG;IACI,KAAK,aAEV;CACH"}

package/dist/types/Entities/RangedNumber.d.ts

@@ -1,17 +1,54 @@
+/**
+ * Properties required to initialize a RangedNumber
+ */
 export interface RangedNumberProperties {
+    /** The minimum allowed value */
     min: number;
+    /** The maximum allowed value */
     max: number;
+    /** The initial value (will be clamped between min and max) */
     initialValue: number;
 }
+/**
+ * A numeric value that is constrained to a specified range.
+ * Values set outside the range will be automatically clamped.
+ * Triggers a callback when the value changes.
+ */
 export declare class RangedNumber {
+    /** The maximum allowed value */
     readonly maxValue: number;
+    /** The minimum allowed value */
     readonly minValue: number;
     private _val;
+    /**
+     * Gets the current numeric value (guaranteed to be within min/max range)
+     */
     get val(): number;
+    /**
+     * Sets the numeric value and triggers the onChange callback if the value changed.
+     * The input value will be automatically clamped to the defined min/max range.
+     * @param x - The new numeric value
+     */
     set val(x: number);
+    /**
+     * Sets the value without triggering the onChange callback.
+     * The input value will still be clamped to the defined range.
+     * @param val - The new numeric value
+     */
     setValQuietly(val: number): void;
+    /**
+     * Ensures a value is within the min/max range
+     * @param x - The value to clamp
+     * @returns The clamped value
+     */
     private clamp;
     private onChangeCallback;
+    /**
+     * Creates a new RangedNumber instance
+     *
+     * @param props - Object containing min, max, and initialValue properties
+     * @param onChangeCallback - Function to call when the value changes
+     */
     constructor(props: RangedNumberProperties, onChangeCallback: () => void);
 }
 //# sourceMappingURL=RangedNumber.d.ts.map

package/dist/types/Entities/RangedNumber.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RangedNumber.d.ts","sourceRoot":"","sources":["../../../src/Entities/RangedNumber.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,qBAAa,YAAY;IACvB,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,IAAI,GAAG,IAAI,MAAM,CAEhB;IACD,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAMhB;IAEM,aAAa,CAAC,GAAG,EAAE,MAAM;IAIhC,OAAO,CAAC,KAAK;IAUb,OAAO,CAAC,gBAAgB,CAAa;gBAEzB,KAAK,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAOxE"}
+{"version":3,"file":"RangedNumber.d.ts","sourceRoot":"","sources":["../../../src/Entities/RangedNumber.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACvB,gCAAgC;IAChC,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,gCAAgC;IAChC,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,OAAO,CAAC,IAAI,CAAS;IAErB;;OAEG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;;OAIG;IACH,IAAI,GAAG,CAAC,CAAC,EAAE,MAAM,EAMhB;IAED;;;;OAIG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM;IAIhC;;;;OAIG;IACH,OAAO,CAAC,KAAK;IAWb,OAAO,CAAC,gBAAgB,CAAa;IAErC;;;;;OAKG;gBACS,KAAK,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,IAAI;CAOxE"}

package/dist/types/Types/PmAdapter.d.ts

@@ -1,7 +1,67 @@
 import { AppObjectRepo } from "../AppObject";
+/**
+ * PmAdapter interface defines a bridge between UI components and AppObjectPM (Presentation Manager) components.
+ * It allows UI frameworks (like React, Vue, Angular, etc.) to subscribe to view model updates from specific AppObjects.
+ *
+ * This adapter is used for AppObject-specific subscriptions, where each UI component subscribes to
+ * a particular AppObject's presentation manager, identified by its ID.
+ *
+ * Usage example with React:
+ * ```typescript
+ * // Define an adapter for a specific view model type
+ * class MyComponentAdapter implements PmAdapter<MyViewModel> {
+ *   // Default view model when no data is available
+ *   defaultVM: MyViewModel = { value: 0, label: "" };
+ *
+ *   // Subscribe to updates from a specific AppObject's presentation manager
+ *   subscribe(id: string, appObjects: AppObjectRepo, setVM: (vm: MyViewModel) => void): void {
+ *     const appObject = appObjects.get(id);
+ *     if (!appObject) return;
+ *
+ *     const pm = appObject.getComponent<MyPM>("MyPresentationManager");
+ *     if (pm) {
+ *       pm.addView(setVM);
+ *       // Initial update with current view model if available
+ *       if (pm.lastVM) setVM(pm.lastVM);
+ *     }
+ *   }
+ *
+ *   // Unsubscribe when component unmounts
+ *   unsubscribe(id: string, appObjects: AppObjectRepo, setVM: (vm: MyViewModel) => void): void {
+ *     const appObject = appObjects.get(id);
+ *     if (!appObject) return;
+ *
+ *     const pm = appObject.getComponent<MyPM>("MyPresentationManager");
+ *     if (pm) {
+ *       pm.removeView(setVM);
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @typeparam VM The view model type provided by this adapter
+ */
 export interface PmAdapter<VM> {
+    /**
+     * Default view model to use when no data is available
+     * This prevents null/undefined handling in UI components
+     */
     defaultVM: VM;
+    /**
+     * Subscribe to view model updates from an AppObject's presentation manager
+     *
+     * @param id The ID of the AppObject to subscribe to
+     * @param appObjects The repository containing the AppObjects
+     * @param setVM Callback function that updates the UI with new view models
+     */
     subscribe(id: string, appObjects: AppObjectRepo, setVM: (vm: VM) => void): void;
+    /**
+     * Unsubscribe from view model updates when a component is being unmounted or no longer needs updates
+     *
+     * @param id The ID of the AppObject to unsubscribe from
+     * @param appObjects The repository containing the AppObjects
+     * @param setVM The same callback function that was provided to subscribe
+     */
     unsubscribe(id: string, appObjects: AppObjectRepo, setVM: (vm: VM) => void): void;
 }
 //# sourceMappingURL=PmAdapter.d.ts.map

package/dist/types/Types/PmAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PmAdapter.d.ts","sourceRoot":"","sources":["../../../src/Types/PmAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,WAAW,SAAS,CAAC,EAAE;IAC3B,SAAS,EAAE,EAAE,CAAC;IACd,SAAS,CACP,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,EACzB,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GACtB,IAAI,CAAC;IACR,WAAW,CACT,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,EACzB,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GACtB,IAAI,CAAC;CACT"}
+{"version":3,"file":"PmAdapter.d.ts","sourceRoot":"","sources":["../../../src/Types/PmAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,WAAW,SAAS,CAAC,EAAE;IAC3B;;;OAGG;IACH,SAAS,EAAE,EAAE,CAAC;IAEd;;;;;;OAMG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,EACzB,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GACtB,IAAI,CAAC;IAER;;;;;;OAMG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,aAAa,EACzB,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GACtB,IAAI,CAAC;CACT"}

package/dist/types/Types/SingletonPmAdapter.d.ts

@@ -1,7 +1,62 @@
 import { AppObjectRepo } from "../AppObject";
+/**
+ * SingletonPmAdapter interface defines a bridge between UI components and singleton presentation managers.
+ * It's similar to PmAdapter but designed for components that subscribe to a singleton PM
+ * (a PM that exists only once in the application).
+ *
+ * This adapter simplifies the subscription process when there's only one instance of a specific
+ * presentation manager type in the entire application, eliminating the need to specify an AppObject ID.
+ *
+ * Usage example with React:
+ * ```typescript
+ * // Define an adapter for a singleton presentation manager
+ * class GlobalSettingsPMAdapter implements SingletonPmAdapter<SettingsViewModel> {
+ *   // Default view model when no data is available
+ *   defaultVM: SettingsViewModel = { theme: "light", fontSize: "medium" };
+ *
+ *   // Subscribe to updates from the singleton presentation manager
+ *   subscribe(appObjects: AppObjectRepo, setVM: (vm: SettingsViewModel) => void): void {
+ *     // Get the singleton PM
+ *     const settingsPM = appObjects.getSingleton<SettingsPM>("SettingsPM");
+ *     if (settingsPM) {
+ *       // Register the update callback
+ *       settingsPM.addView(setVM);
+ *       // Initial update with current view model if available
+ *       if (settingsPM.lastVM) setVM(settingsPM.lastVM);
+ *     }
+ *   }
+ *
+ *   // Unsubscribe when component unmounts
+ *   unsubscribe(appObjects: AppObjectRepo, setVM: (vm: SettingsViewModel) => void): void {
+ *     const settingsPM = appObjects.getSingleton<SettingsPM>("SettingsPM");
+ *     if (settingsPM) {
+ *       settingsPM.removeView(setVM);
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @typeparam VM The view model type provided by this adapter
+ */
 export interface SingletonPmAdapter<VM> {
+    /**
+     * Default view model to use when no data is available
+     * This prevents null/undefined handling in UI components
+     */
     defaultVM: VM;
+    /**
+     * Subscribe to view model updates from a singleton presentation manager
+     *
+     * @param appObjects The repository containing the AppObjects
+     * @param setVM Callback function that updates the UI with new view models
+     */
     subscribe(appObjects: AppObjectRepo, setVM: (vm: VM) => void): void;
+    /**
+     * Unsubscribe from view model updates when a component is being unmounted or no longer needs updates
+     *
+     * @param appObjects The repository containing the AppObjects
+     * @param setVM The same callback function that was provided to subscribe
+     */
     unsubscribe(appObjects: AppObjectRepo, setVM: (vm: VM) => void): void;
 }
 //# sourceMappingURL=SingletonPmAdapter.d.ts.map

package/dist/types/Types/SingletonPmAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SingletonPmAdapter.d.ts","sourceRoot":"","sources":["../../../src/Types/SingletonPmAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,MAAM,WAAW,kBAAkB,CAAC,EAAE;IACpC,SAAS,EAAE,EAAE,CAAC;IACd,SAAS,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IACpE,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;CACvE"}
+{"version":3,"file":"SingletonPmAdapter.d.ts","sourceRoot":"","sources":["../../../src/Types/SingletonPmAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,WAAW,kBAAkB,CAAC,EAAE;IACpC;;;OAGG;IACH,SAAS,EAAE,EAAE,CAAC;IAEd;;;;;OAKG;IACH,SAAS,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;IAEpE;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,IAAI,GAAG,IAAI,CAAC;CACvE"}

package/dist/types/ValueObjects/Angle.d.ts

@@ -16,7 +16,7 @@ export declare class Angle {
      * @param a Angle A
      * @param b Angle B
      * @param tolerance Tolerance for "Close" in degrees. Defaults to 0.001;
-     * @returns True if the difference between A and B (in degress) is less than the tolerance
+     * @returns True if the difference between A and B (in degrees) is less than the tolerance
      */
     static Close(a: Angle, b: Angle, tolerance?: number): boolean;
     private _degrees;

package/dist/types/ValueObjects/Matrix.d.ts

@@ -21,17 +21,17 @@ export type MatrixArray = [
 ];
 export declare class Matrix {
     /**
-     * Consructs an identity matrix
+     * Constructs an identity matrix
      * @returns An identity matrix
      */
     static Identity(): Matrix;
     /**
-     * Constructs an matrix of zeros
+     * Constructs a matrix of zeros
      * @returns A matrix of zeros
      */
     static Zero(): Matrix;
     /**
-     * Compares two matricies
+     * Compares two matrices
      * @param a Matrix A
      * @param b Matrix B
      * @returns True if all the elements in matrix A are equal to all the elements of matrix B
@@ -41,7 +41,7 @@ export declare class Matrix {
      * Checks to see if Matrix A is close to Matrix B by comparing elements
      * @param a Matrix A
      * @param b Matrix B
-     * @param threshold "Close" thershold. Defaults to 0.001
+     * @param threshold "Close" threshold. Defaults to 0.001
      * @returns True if all the difference between the elements in each array is less than the threshold
      */
     static Close(a: Matrix, b: Matrix, threshold?: number): boolean;
@@ -53,7 +53,7 @@ export declare class Matrix {
      */
     static Multiply(a: Matrix, b: Matrix): Matrix;
     /**
-     * Composes a matrix from a scale vector, rotation quaterion, and translation vector
+     * Composes a matrix from a scale vector, rotation quaternion, and translation vector
      * @param scale The scale of the transformation matrix
      * @param rotation The rotation of the transformation matrix
      * @param translation The translation of the transformation matrix

package/dist/types/ValueObjects/Matrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Matrix.d.ts","sourceRoot":"","sources":["../../../src/ValueObjects/Matrix.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAC;AAEF,qBAAa,MAAM;IACjB;;;OAGG;WACW,QAAQ,IAAI,MAAM;IAIhC;;;OAGG;WACW,IAAI,IAAI,MAAM;IAI5B;;;;;OAKG;WACW,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO;IAWlD;;;;;;OAMG;WACW,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,SAAQ,GAAG,OAAO;IAerE;;;;;OAKG;WACW,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IA+EpD;;;;;;OAMG;WACW,OAAO,CACnB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,UAAU,EACpB,WAAW,EAAE,OAAO,GACnB,MAAM;IAgDT;;;;OAIG;WACW,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAqF5C;;;;;OAKG;WACW,qBAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM;IA8BxE;;;;;OAKG;WACW,oBAAoB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,OAAO,GACnB,MAAM;IAST;;;;;OAKG;WACW,iBAAiB,CAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,UAAU,GACnB,MAAM;IAOT;;;;;OAKG;WACW,cAAc,CAC1B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,GACb,MAAM;WAOK,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM;WA4B7C,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;WAW/C,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAU9D;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAgC/B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,OAAO,CAsBnB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,UAAU,CAEzB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CA0B3B;IAGD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAc;IACjC,IAAI,CAAC,IAAI,WAAW,CAEnB;gBAEW,CAAC,EAAE,WAAW;CAG3B"}
+{"version":3,"file":"Matrix.d.ts","sourceRoot":"","sources":["../../../src/ValueObjects/Matrix.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACP,CAAC;AAEF,qBAAa,MAAM;IACjB;;;OAGG;WACW,QAAQ,IAAI,MAAM;IAIhC;;;OAGG;WACW,IAAI,IAAI,MAAM;IAI5B;;;;;OAKG;WACW,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO;IAWlD;;;;;;OAMG;WACW,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,SAAQ,GAAG,OAAO;IAerE;;;;;OAKG;WACW,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IA+EpD;;;;;;OAMG;WACW,OAAO,CACnB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,UAAU,EACpB,WAAW,EAAE,OAAO,GACnB,MAAM;IAgDT;;;;OAIG;WACW,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAqF5C;;;;;OAKG;WACW,qBAAqB,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM;IA8BxE;;;;;OAKG;WACW,oBAAoB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,OAAO,GACnB,MAAM;IAST;;;;;OAKG;WACW,iBAAiB,CAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,UAAU,GACnB,MAAM;IAOT;;;;;OAKG;WACW,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM;WAOxD,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,MAAM;WA4B7C,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;WAW/C,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAU9D;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,CAgC/B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,OAAO,CAsBnB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,UAAU,CAEzB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,MAAM,CA0B3B;IAGD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAc;IACjC,IAAI,CAAC,IAAI,WAAW,CAEnB;gBAEW,CAAC,EAAE,WAAW;CAG3B"}

package/dist/types/ValueObjects/Quaternion.d.ts

@@ -17,27 +17,27 @@ export declare class Quaternion {
     static Equal(a: Quaternion, b: Quaternion): boolean;
     /**
      * Checks two quaternions to see if they are close
-     * @param a Quaterion A
-     * @param b Quaterion B
+     * @param a Quaternion A
+     * @param b Quaternion B
      * @param threshold "Close" threshold. Defaults to 0.001
-     * @returns True if each of Quaterion's components are within the threshold of each other
+     * @returns True if each of Quaternion's components are within the threshold of each other
      */
     static Close(a: Quaternion, b: Quaternion, threshold?: number): boolean;
     /**
      * Multiplies A*B
-     * @param a Quaterion A
+     * @param a Quaternion A
      * @param b Quaternion B
      * @returns The result of A*B
      */
     static Multiply(a: Quaternion, b: Quaternion): Quaternion;
     /**
-     * Creates a new Quaterion from an array of values
-     * @param values The four values of the Quaterion: [x,y,z,w]
-     * @returns A Quaterion
+     * Creates a new Quaternion from an array of values
+     * @param values The four values of the Quaternion: [x,y,z,w]
+     * @returns A Quaternion
      */
     static FromArray(values: [number, number, number, number]): Quaternion;
     /**
-     * Creates a Quaterion from a Data Transfer Object
+     * Creates a Quaternion from a Data Transfer Object
      * @param dto The Data Transfer Object
      * @returns The Quaternion
      */
@@ -48,19 +48,19 @@ export declare class Quaternion {
      */
     static Identity(): Quaternion;
     /**
-     * Creates an quaterion about an axis for a given angle
+     * Creates a quaternion about an axis for a given angle
      * @param axis The rotation axis
      * @param angle The rotation angle
-     * @returns The resulting Quaterion
+     * @returns The resulting Quaternion
      */
     static FromAngleAxis(axis: Vector3, angle: Angle): Quaternion;
     static FromDirectionVector(direction: Vector3): Quaternion;
     /**
-     * Froms up a Quaternion from the Yaw-Pitch-Roll (Tait-Bryan) convetion
+     * Forms a Quaternion from the Yaw-Pitch-Roll (Tait-Bryan) convention
      * @param yaw defines the rotation around the y axis
      * @param pitch defines the rotation around the x axis
      * @param roll defines the rotation around the z axis
-     * @returns the resulting quaterion
+     * @returns the resulting quaternion
      */
     static FromYawPitchRoll(yaw: Angle, pitch: Angle, roll: Angle): Quaternion;
     /**
@@ -68,7 +68,7 @@ export declare class Quaternion {
      * @param x Rotation about the x axis
      * @param y Rotation about the y axis
      * @param z Rotation about the z axis
-     * @returns The Quaterion
+     * @returns The Quaternion
      */
     static FromEuler(x: Angle, y: Angle, z: Angle): Quaternion;
     /**
@@ -81,15 +81,15 @@ export declare class Quaternion {
     /**
      * Spherically interpolates between two quaternions
      * @param initial The initial quaternion
-     * @param final The final quaterion
-     * @param percent The percent along the slerp. 0 will return the initial quaterion and 1 will return the final quaterion
-     * @returns The interpolated quaterion
+     * @param final The final quaternion
+     * @param percent The percent along the slerp. 0 will return the initial quaternion and 1 will return the final quaternion
+     * @returns The interpolated quaternion
      */
     static Slerp(initial: Quaternion, final: Quaternion, percent: number): Quaternion;
     /**
      * Calculates a Quaternion from a rotation matrix
      * @param rotationMatrix A normalized, non-scaled rotation matrix
-     * @returns The Quaterion
+     * @returns The Quaternion
      */
     static FromRotationMatrix(rotationMatrix: Matrix): Quaternion;
     static ToRotationMatrix(quat: Quaternion): Matrix;

package/dist/types/ValueObjects/Vector2.d.ts

@@ -63,7 +63,7 @@ export declare class Vector2 {
      */
     static Scale: (vector: Vector2, scale: number) => Vector2;
     /**
-     * Creates a new vector of a given lenght and a unit that is equal to the original vector
+     * Creates a new vector of a given length and a unit that is equal to the original vector
      * @param vector The original vector. This determines the unit of the final vector
      * @param length The desired length of the final vector
      * @returns The final vector
@@ -95,18 +95,23 @@ export declare class Vector2 {
     /**
      * Get the magnitude (length) of the vector
      */
+    get magnitude(): number;
+    /**
+     * @deprecated Use magnitude instead - this property is kept for backward compatibility
+     * Get the magnitude (length) of the vector
+     */
     get magnitued(): number;
     /**
      * Get the unit vector
      */
     get unit(): Vector2;
     /**
-     * Returns the angle of the direction of this angle in degrees.
+     * Returns the angle of the direction of this vector in degrees.
      * A right vector [1,0] will return 0, a left vector [-1,0] will return 180, an up vector [0,1] will return 90 and a down vector [0,-1] will return -90
      */
     get theta(): number;
     /**
-     * Retuns the vector as an array of numbers [x,y]
+     * Returns the vector as an array of numbers [x,y]
      */
     get array(): [number, number];
     /**

package/dist/types/ValueObjects/Vector2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Vector2.d.ts","sourceRoot":"","sources":["../../../src/ValueObjects/Vector2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE1B,qBAAa,OAAO;IAClB;;;OAGG;WACW,IAAI,IAAI,OAAO;IAI7B;;;OAGG;WACW,GAAG,IAAI,OAAO;IAI5B;;;;;OAKG;WACW,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO;IAMpD;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO;IAI7D;;;;;OAKG;WACW,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO;IAIlD;;;;;OAKG;WACW,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO;IAIvD;;;;;;OAMG;IACH,OAAc,KAAK,GACjB,GAAG,OAAO,EACV,GAAG,OAAO,EACV,YAAW,MAAa,KACvB,OAAO,CAMR;IAEF;;;;;OAKG;IACH,OAAc,MAAM,GAAI,KAAK,OAAO,EAAE,OAAO,KAAK,KAAG,OAAO,CAI1D;IAEF;;;;;OAKG;IACH,OAAc,KAAK,GAAI,QAAQ,OAAO,EAAE,OAAO,MAAM,KAAG,OAAO,CAI7D;IAEF;;;;;OAKG;IACH,OAAc,iBAAiB,GAC7B,QAAQ,OAAO,EACf,QAAQ,MAAM,KACb,OAAO,CAKR;IAEF;;;;;OAKG;IACH,OAAc,GAAG,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,MAAM,CAElD;IAEF;;;;;OAKG;IACH,OAAc,YAAY,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,KAAK,CAO1D;IAEF;;;;;OAKG;IACH,OAAc,KAAK,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,MAAM,CAEpD;IAEF,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAMtB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CASlB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAE5B;IAED;;OAEG;IACH,IAAI,GAAG,IAAI;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAElC;gBAEW,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;CAIjC"}
+{"version":3,"file":"Vector2.d.ts","sourceRoot":"","sources":["../../../src/ValueObjects/Vector2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAE1B,qBAAa,OAAO;IAClB;;;OAGG;WACW,IAAI,IAAI,OAAO;IAI7B;;;OAGG;WACW,GAAG,IAAI,OAAO;IAI5B;;;;;OAKG;WACW,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO;IAMpD;;;;OAIG;WACW,OAAO,CAAC,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO;IAI7D;;;;;OAKG;WACW,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO;IAIlD;;;;;OAKG;WACW,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO;IAIvD;;;;;;OAMG;IACH,OAAc,KAAK,GACjB,GAAG,OAAO,EACV,GAAG,OAAO,EACV,YAAW,MAAa,KACvB,OAAO,CAMR;IAEF;;;;;OAKG;IACH,OAAc,MAAM,GAAI,KAAK,OAAO,EAAE,OAAO,KAAK,KAAG,OAAO,CAI1D;IAEF;;;;;OAKG;IACH,OAAc,KAAK,GAAI,QAAQ,OAAO,EAAE,OAAO,MAAM,KAAG,OAAO,CAI7D;IAEF;;;;;OAKG;IACH,OAAc,iBAAiB,GAC7B,QAAQ,OAAO,EACf,QAAQ,MAAM,KACb,OAAO,CAKR;IAEF;;;;;OAKG;IACH,OAAc,GAAG,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,MAAM,CAElD;IAEF;;;;;OAKG;IACH,OAAc,YAAY,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,KAAK,CAO1D;IAEF;;;;;OAKG;IACH,OAAc,KAAK,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,MAAM,CAEpD;IAEF,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAMtB;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CASlB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAE5B;IAED;;OAEG;IACH,IAAI,GAAG,IAAI;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAElC;gBAEW,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM;CAIjC"}