@axi-engine/utils 0.2.4 → 0.2.6

package/dist/index.d.mts

@@ -155,6 +155,11 @@ declare function throwIf(condition: boolean, exceptionMessage: string): asserts
  * console.log('First item:', items[0]);
  */
 declare function throwIfEmpty<T>(value: T, exceptionMessage: string): asserts value is NonNullable<T>;
+/**
+ * Throws an error unconditionally.
+ * @param message The message for the error.
+ */
+declare function throwError(message: string): never;
 
 interface AxiEngineConfig {
     pathSeparator: string;
@@ -166,45 +171,6 @@ 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 read-only contract for any system that can provide data by path.
  */
@@ -364,4 +330,46 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, type Constructor, ConstructorRegistry, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNull, isNullOrUndefined, isNumber, isPercentageString, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };
+/**
+ * A generic, type-safe wrapper around a Map for managing collections of items by key.
+ * This class provides a consistent API for registering, retrieving, and checking for
+ * the existence of items.
+ *
+ * @template K - The type of the key (must be a string).
+ * @template V - The type of the value being stored.
+ */
+declare class Registry<K extends string, V> {
+    protected readonly items: Map<K, V>;
+    /**
+     * Registers an item with a specific key.
+     * Warns if an item with the same key is already registered.
+     * @param key The key to associate with the item.
+     * @param value The item to register.
+     */
+    register(key: K, value: V): void;
+    /**
+     * Checks if an item with the given key is registered.
+     * @param key The key to check.
+     */
+    has(key: K): boolean;
+    /**
+     * Retrieves an item by its key.
+     * @param key The key of the item to retrieve.
+     * @returns The item, or `undefined` if not found.
+     */
+    get(key: K): V | undefined;
+    /**
+     * Retrieves an item by its key, throwing an error if it's not found.
+     * @param key The key of the item to retrieve.
+     * @returns The item.
+     * @throws {Error} if no item is found for the given key.
+     */
+    getOrThrow(key: K): V;
+    delete(key: K): boolean;
+    /**
+     * Clears all registered items from the registry.
+     */
+    clear(): void;
+}
+
+export { type AxiEngineConfig, type Constructor, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, Registry, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNull, isNullOrUndefined, isNumber, isPercentageString, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwError, throwIf, throwIfEmpty, unique };

package/dist/index.d.ts

@@ -155,6 +155,11 @@ declare function throwIf(condition: boolean, exceptionMessage: string): asserts
  * console.log('First item:', items[0]);
  */
 declare function throwIfEmpty<T>(value: T, exceptionMessage: string): asserts value is NonNullable<T>;
+/**
+ * Throws an error unconditionally.
+ * @param message The message for the error.
+ */
+declare function throwError(message: string): never;
 
 interface AxiEngineConfig {
     pathSeparator: string;
@@ -166,45 +171,6 @@ 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 read-only contract for any system that can provide data by path.
  */
@@ -364,4 +330,46 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, type Constructor, ConstructorRegistry, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNull, isNullOrUndefined, isNumber, isPercentageString, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwIf, throwIfEmpty, unique };
+/**
+ * A generic, type-safe wrapper around a Map for managing collections of items by key.
+ * This class provides a consistent API for registering, retrieving, and checking for
+ * the existence of items.
+ *
+ * @template K - The type of the key (must be a string).
+ * @template V - The type of the value being stored.
+ */
+declare class Registry<K extends string, V> {
+    protected readonly items: Map<K, V>;
+    /**
+     * Registers an item with a specific key.
+     * Warns if an item with the same key is already registered.
+     * @param key The key to associate with the item.
+     * @param value The item to register.
+     */
+    register(key: K, value: V): void;
+    /**
+     * Checks if an item with the given key is registered.
+     * @param key The key to check.
+     */
+    has(key: K): boolean;
+    /**
+     * Retrieves an item by its key.
+     * @param key The key of the item to retrieve.
+     * @returns The item, or `undefined` if not found.
+     */
+    get(key: K): V | undefined;
+    /**
+     * Retrieves an item by its key, throwing an error if it's not found.
+     * @param key The key of the item to retrieve.
+     * @returns The item.
+     * @throws {Error} if no item is found for the given key.
+     */
+    getOrThrow(key: K): V;
+    delete(key: K): boolean;
+    /**
+     * Clears all registered items from the registry.
+     */
+    clear(): void;
+}
+
+export { type AxiEngineConfig, type Constructor, type DataSink, type DataSource, type DataStorage, Emitter, type PathType, Registry, type ScalarType, type Subscribable, areArraysEqual, axiSettings, clampNumber, configure, ensurePathArray, ensurePathString, firstKeyOf, genArray, getPercentOf, getRandomElement, haveSameElements, isBoolean, isNull, isNullOrUndefined, isNumber, isPercentageString, isScalar, isSequentialStart, isString, isUndefined, last, randId, randInt, shuffleArray, throwError, throwIf, throwIfEmpty, unique };

package/dist/index.js

@@ -20,8 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  ConstructorRegistry: () => ConstructorRegistry,
   Emitter: () => Emitter,
+  Registry: () => Registry,
   areArraysEqual: () => areArraysEqual,
   axiSettings: () => axiSettings,
   clampNumber: () => clampNumber,
@@ -46,6 +46,7 @@ __export(index_exports, {
   randId: () => randId,
   randInt: () => randInt,
   shuffleArray: () => shuffleArray,
+  throwError: () => throwError,
   throwIf: () => throwIf,
   throwIfEmpty: () => throwIfEmpty,
   unique: () => unique
@@ -137,6 +138,9 @@ function throwIfEmpty(value, exceptionMessage) {
     throw new Error(exceptionMessage);
   }
 }
+function throwError(message) {
+  throw new Error(message);
+}
 
 // src/config.ts
 var defaultConfig = {
@@ -147,50 +151,6 @@ 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 {
   listeners = /* @__PURE__ */ new Set();
@@ -262,10 +222,60 @@ function randInt(min, max) {
 function randId() {
   return (0, import_uuid.v4)();
 }
+
+// src/registry.ts
+var Registry = class {
+  items = /* @__PURE__ */ new Map();
+  /**
+   * Registers an item with a specific key.
+   * Warns if an item with the same key is already registered.
+   * @param key The key to associate with the item.
+   * @param value The item to register.
+   */
+  register(key, value) {
+    throwIf(this.items.has(key), `An item with the key '${key}' is already registered and will be overwritten.`);
+    this.items.set(key, value);
+  }
+  /**
+   * Checks if an item with the given key is registered.
+   * @param key The key to check.
+   */
+  has(key) {
+    return this.items.has(key);
+  }
+  /**
+   * Retrieves an item by its key.
+   * @param key The key of the item to retrieve.
+   * @returns The item, or `undefined` if not found.
+   */
+  get(key) {
+    return this.items.get(key);
+  }
+  /**
+   * Retrieves an item by its key, throwing an error if it's not found.
+   * @param key The key of the item to retrieve.
+   * @returns The item.
+   * @throws {Error} if no item is found for the given key.
+   */
+  getOrThrow(key) {
+    const item = this.get(key);
+    throwIfEmpty(item, `No item registered for the key '${key}'.`);
+    return item;
+  }
+  delete(key) {
+    return this.items.delete(key);
+  }
+  /**
+   * Clears all registered items from the registry.
+   */
+  clear() {
+    this.items.clear();
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ConstructorRegistry,
   Emitter,
+  Registry,
   areArraysEqual,
   axiSettings,
   clampNumber,
@@ -290,6 +300,7 @@ function randId() {
   randId,
   randInt,
   shuffleArray,
+  throwError,
   throwIf,
   throwIfEmpty,
   unique

package/dist/index.mjs

@@ -83,6 +83,9 @@ function throwIfEmpty(value, exceptionMessage) {
     throw new Error(exceptionMessage);
   }
 }
+function throwError(message) {
+  throw new Error(message);
+}
 
 // src/config.ts
 var defaultConfig = {
@@ -93,50 +96,6 @@ 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 {
   listeners = /* @__PURE__ */ new Set();
@@ -208,9 +167,59 @@ function randInt(min, max) {
 function randId() {
   return uuidv4();
 }
+
+// src/registry.ts
+var Registry = class {
+  items = /* @__PURE__ */ new Map();
+  /**
+   * Registers an item with a specific key.
+   * Warns if an item with the same key is already registered.
+   * @param key The key to associate with the item.
+   * @param value The item to register.
+   */
+  register(key, value) {
+    throwIf(this.items.has(key), `An item with the key '${key}' is already registered and will be overwritten.`);
+    this.items.set(key, value);
+  }
+  /**
+   * Checks if an item with the given key is registered.
+   * @param key The key to check.
+   */
+  has(key) {
+    return this.items.has(key);
+  }
+  /**
+   * Retrieves an item by its key.
+   * @param key The key of the item to retrieve.
+   * @returns The item, or `undefined` if not found.
+   */
+  get(key) {
+    return this.items.get(key);
+  }
+  /**
+   * Retrieves an item by its key, throwing an error if it's not found.
+   * @param key The key of the item to retrieve.
+   * @returns The item.
+   * @throws {Error} if no item is found for the given key.
+   */
+  getOrThrow(key) {
+    const item = this.get(key);
+    throwIfEmpty(item, `No item registered for the key '${key}'.`);
+    return item;
+  }
+  delete(key) {
+    return this.items.delete(key);
+  }
+  /**
+   * Clears all registered items from the registry.
+   */
+  clear() {
+    this.items.clear();
+  }
+};
 export {
-  ConstructorRegistry,
   Emitter,
+  Registry,
   areArraysEqual,
   axiSettings,
   clampNumber,
@@ -235,6 +244,7 @@ export {
   randId,
   randInt,
   shuffleArray,
+  throwError,
   throwIf,
   throwIfEmpty,
   unique

package/package.json

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