@axi-engine/utils 0.1.5 → 0.1.7

package/dist/index.d.mts

@@ -6,6 +6,47 @@
  * ['player', 'stats', 'health']
  */
 type PathType = string | string[];
+/**
+ * Represents a generic constructor for any class.
+ *
+ * This utility type is essential for implementing higher-order patterns
+ * like mixins, where a function takes a class as an argument and returns
+ * a new, extended class.
+ *
+ * The `...args: any[]` signature allows it to represent constructors
+ * with any number and type of arguments, making it universally applicable.
+ *
+ * @template T - The type of the instance created by the constructor. Defaults to `{}`.
+ *
+ * @example
+ * // Used as a constraint for a base class in a mixin
+ * function Timestamped<TBase extends Constructor>(Base: TBase) {
+ *   return class extends Base {
+ *     timestamp = new Date();
+ *   };
+ * }
+ *
+ * class User {}
+ * const TimestampedUser = Timestamped(User);
+ * const userInstance = new TimestampedUser();
+ * console.log(userInstance.timestamp); // Logs the current date
+ */
+type Constructor<T = {}> = new (...args: any[]) => T;
+/**
+ * Defines the public, read-only contract for an event emitter.
+ * It allows subscribing to an event but not emitting it.
+ * @template T A tuple representing the types of the event arguments.
+ */
+type Subscribable<T extends any[]> = {
+    readonly listenerCount: number;
+    /**
+     * Subscribes a listener to this event.
+     * @returns A function to unsubscribe the listener.
+     */
+    subscribe(listener: (...args: T) => void): () => void;
+    unsubscribe(listener: (...args: T) => void): boolean;
+    clear(): void;
+};
 
 /**
  * Generates an array of numbers from 0 to length-1.
@@ -120,13 +161,56 @@ declare const axiSettings: AxiEngineConfig;
  */
 declare function configure(newConfig: Partial<AxiEngineConfig>): void;
 
+/**
+ * A generic registry for mapping string identifiers to class constructors.
+ *
+ * This utility is fundamental for building extensible systems like dependency injection containers,
+ * factories, and serialization engines where types need to be dynamically resolved.
+ *
+ * @template T - A base type that all registered constructors must produce an instance of.
+ */
+declare class ConstructorRegistry<T> {
+    private readonly items;
+    /**
+     * Registers a constructor with a unique string identifier.
+     *
+     * @param typeId - The unique identifier for the constructor (e.g., a static `typeName` property from a class).
+     * @param ctor - The class constructor to register.
+     * @returns The registry instance for chainable calls.
+     * @throws If a constructor with the same `typeId` is already registered.
+     */
+    register(typeId: string, ctor: Constructor<T>): this;
+    /**
+     * Retrieves a constructor by its identifier.
+     *
+     * @param typeId - The identifier of the constructor to retrieve.
+     * @returns The found class constructor.
+     * @throws If no constructor is found for the given `typeId`.
+     */
+    get(typeId: string): Constructor<T>;
+    /**
+     * Checks if a constructor for a given identifier is registered.
+     * @param typeId - The identifier to check.
+     * @returns `true` if a constructor is registered, otherwise `false`.
+     */
+    has(typeId: string): boolean;
+    /**
+     * Clears all registered constructors from the registry.
+     */
+    clear(): void;
+}
+
 /**
  * A minimal, type-safe event emitter for a single event.
  * It does not manage state, it only manages subscribers and event dispatching.
  * @template T A tuple representing the types of the event arguments.
  */
-declare class Emitter<T extends any[]> {
+declare class Emitter<T extends any[]> implements Subscribable<T> {
     private listeners;
+    /**
+     * Returns the number of listeners.
+     */
+    get listenerCount(): number;
     /**
      * Subscribes a listener to this event.
      * @returns A function to unsubscribe the listener.
@@ -145,10 +229,6 @@ declare class Emitter<T extends any[]> {
      * Clears all listeners.
      */
     clear(): void;
-    /**
-     * Returns the number of listeners.
-     */
-    get listenerCount(): number;
 }
 
 declare function isNullOrUndefined(val: unknown): val is null | undefined;
@@ -210,4 +290,4 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, Emitter, type PathType, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };
+export { type AxiEngineConfig, type Constructor, ConstructorRegistry, Emitter, type PathType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };

package/dist/index.d.ts

@@ -6,6 +6,47 @@
  * ['player', 'stats', 'health']
  */
 type PathType = string | string[];
+/**
+ * Represents a generic constructor for any class.
+ *
+ * This utility type is essential for implementing higher-order patterns
+ * like mixins, where a function takes a class as an argument and returns
+ * a new, extended class.
+ *
+ * The `...args: any[]` signature allows it to represent constructors
+ * with any number and type of arguments, making it universally applicable.
+ *
+ * @template T - The type of the instance created by the constructor. Defaults to `{}`.
+ *
+ * @example
+ * // Used as a constraint for a base class in a mixin
+ * function Timestamped<TBase extends Constructor>(Base: TBase) {
+ *   return class extends Base {
+ *     timestamp = new Date();
+ *   };
+ * }
+ *
+ * class User {}
+ * const TimestampedUser = Timestamped(User);
+ * const userInstance = new TimestampedUser();
+ * console.log(userInstance.timestamp); // Logs the current date
+ */
+type Constructor<T = {}> = new (...args: any[]) => T;
+/**
+ * Defines the public, read-only contract for an event emitter.
+ * It allows subscribing to an event but not emitting it.
+ * @template T A tuple representing the types of the event arguments.
+ */
+type Subscribable<T extends any[]> = {
+    readonly listenerCount: number;
+    /**
+     * Subscribes a listener to this event.
+     * @returns A function to unsubscribe the listener.
+     */
+    subscribe(listener: (...args: T) => void): () => void;
+    unsubscribe(listener: (...args: T) => void): boolean;
+    clear(): void;
+};
 
 /**
  * Generates an array of numbers from 0 to length-1.
@@ -120,13 +161,56 @@ declare const axiSettings: AxiEngineConfig;
  */
 declare function configure(newConfig: Partial<AxiEngineConfig>): void;
 
+/**
+ * A generic registry for mapping string identifiers to class constructors.
+ *
+ * This utility is fundamental for building extensible systems like dependency injection containers,
+ * factories, and serialization engines where types need to be dynamically resolved.
+ *
+ * @template T - A base type that all registered constructors must produce an instance of.
+ */
+declare class ConstructorRegistry<T> {
+    private readonly items;
+    /**
+     * Registers a constructor with a unique string identifier.
+     *
+     * @param typeId - The unique identifier for the constructor (e.g., a static `typeName` property from a class).
+     * @param ctor - The class constructor to register.
+     * @returns The registry instance for chainable calls.
+     * @throws If a constructor with the same `typeId` is already registered.
+     */
+    register(typeId: string, ctor: Constructor<T>): this;
+    /**
+     * Retrieves a constructor by its identifier.
+     *
+     * @param typeId - The identifier of the constructor to retrieve.
+     * @returns The found class constructor.
+     * @throws If no constructor is found for the given `typeId`.
+     */
+    get(typeId: string): Constructor<T>;
+    /**
+     * Checks if a constructor for a given identifier is registered.
+     * @param typeId - The identifier to check.
+     * @returns `true` if a constructor is registered, otherwise `false`.
+     */
+    has(typeId: string): boolean;
+    /**
+     * Clears all registered constructors from the registry.
+     */
+    clear(): void;
+}
+
 /**
  * A minimal, type-safe event emitter for a single event.
  * It does not manage state, it only manages subscribers and event dispatching.
  * @template T A tuple representing the types of the event arguments.
  */
-declare class Emitter<T extends any[]> {
+declare class Emitter<T extends any[]> implements Subscribable<T> {
     private listeners;
+    /**
+     * Returns the number of listeners.
+     */
+    get listenerCount(): number;
     /**
      * Subscribes a listener to this event.
      * @returns A function to unsubscribe the listener.
@@ -145,10 +229,6 @@ declare class Emitter<T extends any[]> {
      * Clears all listeners.
      */
     clear(): void;
-    /**
-     * Returns the number of listeners.
-     */
-    get listenerCount(): number;
 }
 
 declare function isNullOrUndefined(val: unknown): val is null | undefined;
@@ -210,4 +290,4 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, Emitter, type PathType, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };
+export { type AxiEngineConfig, type Constructor, ConstructorRegistry, Emitter, type PathType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNullOrUndefined, isNumber, isPercentageString, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ConstructorRegistry: () => ConstructorRegistry,
   Emitter: () => Emitter,
   areArraysEqual: () => areArraysEqual,
   axiSettings: () => axiSettings,
@@ -137,10 +138,58 @@ function configure(newConfig) {
   Object.assign(axiSettings, newConfig);
 }
 
+// src/constructor-registry.ts
+var ConstructorRegistry = class {
+  items = /* @__PURE__ */ new Map();
+  /**
+   * Registers a constructor with a unique string identifier.
+   *
+   * @param typeId - The unique identifier for the constructor (e.g., a static `typeName` property from a class).
+   * @param ctor - The class constructor to register.
+   * @returns The registry instance for chainable calls.
+   * @throws If a constructor with the same `typeId` is already registered.
+   */
+  register(typeId, ctor) {
+    throwIf(this.items.has(typeId), `A constructor with typeId '${typeId}' is already registered.`);
+    this.items.set(typeId, ctor);
+    return this;
+  }
+  /**
+   * Retrieves a constructor by its identifier.
+   *
+   * @param typeId - The identifier of the constructor to retrieve.
+   * @returns The found class constructor.
+   * @throws If no constructor is found for the given `typeId`.
+   */
+  get(typeId) {
+    const Ctor = this.items.get(typeId);
+    throwIfEmpty(Ctor, `No constructor found for typeId '${typeId}'`);
+    return Ctor;
+  }
+  /**
+   * Checks if a constructor for a given identifier is registered.
+   * @param typeId - The identifier to check.
+   * @returns `true` if a constructor is registered, otherwise `false`.
+   */
+  has(typeId) {
+    return this.items.has(typeId);
+  }
+  /**
+   * Clears all registered constructors from the registry.
+   */
+  clear() {
+    this.items.clear();
+  }
+};
+
 // src/emitter.ts
 var Emitter = class {
-  constructor() {
-    this.listeners = /* @__PURE__ */ new Set();
+  listeners = /* @__PURE__ */ new Set();
+  /**
+   * Returns the number of listeners.
+   */
+  get listenerCount() {
+    return this.listeners.size;
   }
   /**
    * Subscribes a listener to this event.
@@ -169,12 +218,6 @@ var Emitter = class {
   clear() {
     this.listeners.clear();
   }
-  /**
-   * Returns the number of listeners.
-   */
-  get listenerCount() {
-    return this.listeners.size;
-  }
 };
 
 // src/math.ts
@@ -212,6 +255,7 @@ function randId() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ConstructorRegistry,
   Emitter,
   areArraysEqual,
   axiSettings,

package/dist/index.mjs

@@ -86,10 +86,58 @@ function configure(newConfig) {
   Object.assign(axiSettings, newConfig);
 }
 
+// src/constructor-registry.ts
+var ConstructorRegistry = class {
+  items = /* @__PURE__ */ new Map();
+  /**
+   * Registers a constructor with a unique string identifier.
+   *
+   * @param typeId - The unique identifier for the constructor (e.g., a static `typeName` property from a class).
+   * @param ctor - The class constructor to register.
+   * @returns The registry instance for chainable calls.
+   * @throws If a constructor with the same `typeId` is already registered.
+   */
+  register(typeId, ctor) {
+    throwIf(this.items.has(typeId), `A constructor with typeId '${typeId}' is already registered.`);
+    this.items.set(typeId, ctor);
+    return this;
+  }
+  /**
+   * Retrieves a constructor by its identifier.
+   *
+   * @param typeId - The identifier of the constructor to retrieve.
+   * @returns The found class constructor.
+   * @throws If no constructor is found for the given `typeId`.
+   */
+  get(typeId) {
+    const Ctor = this.items.get(typeId);
+    throwIfEmpty(Ctor, `No constructor found for typeId '${typeId}'`);
+    return Ctor;
+  }
+  /**
+   * Checks if a constructor for a given identifier is registered.
+   * @param typeId - The identifier to check.
+   * @returns `true` if a constructor is registered, otherwise `false`.
+   */
+  has(typeId) {
+    return this.items.has(typeId);
+  }
+  /**
+   * Clears all registered constructors from the registry.
+   */
+  clear() {
+    this.items.clear();
+  }
+};
+
 // src/emitter.ts
 var Emitter = class {
-  constructor() {
-    this.listeners = /* @__PURE__ */ new Set();
+  listeners = /* @__PURE__ */ new Set();
+  /**
+   * Returns the number of listeners.
+   */
+  get listenerCount() {
+    return this.listeners.size;
   }
   /**
    * Subscribes a listener to this event.
@@ -118,12 +166,6 @@ var Emitter = class {
   clear() {
     this.listeners.clear();
   }
-  /**
-   * Returns the number of listeners.
-   */
-  get listenerCount() {
-    return this.listeners.size;
-  }
 };
 
 // src/math.ts
@@ -160,6 +202,7 @@ function randId() {
   return uuidv4();
 }
 export {
+  ConstructorRegistry,
   Emitter,
   areArraysEqual,
   axiSettings,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axi-engine/utils",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Core utility library for Axi Engine, providing common functions for arrays, math, type guards, and more.",
   "license": "MIT",
   "keywords": [