@axi-engine/utils 0.2.1 → 0.2.3

package/dist/index.d.mts

@@ -127,11 +127,11 @@ declare function getRandomElement<T>(array: T[]): T | undefined;
 
 /**
  * Throws an error if the condition is true.
- * @param conditionForThrow - If true, an error will be thrown.
+ * @param condition  - If true, an error will be thrown.
  * @param exceptionMessage - The message for the error.
  * @throws {Error} if the value is true
  */
-declare function throwIf(conditionForThrow: boolean, exceptionMessage: string): void | never;
+declare function throwIf(condition: boolean, exceptionMessage: string): asserts condition is false;
 /**
  * Throws an error if the value is null, undefined, or an empty array.
  *
@@ -205,6 +205,28 @@ declare class ConstructorRegistry<T> {
     clear(): void;
 }
 
+/**
+ * A read-only contract for any system that can provide data by path.
+ */
+interface DataSource {
+    get(path: PathType): unknown;
+    has(path: PathType): boolean;
+}
+/**
+ * A write-only contract for any system that can accept data by path.
+ */
+interface DataSink {
+    set(path: PathType, value: unknown): void;
+    create(path: PathType, value: unknown): void;
+    delete(path: PathType): void;
+}
+/**
+ * A full CRUD contract for systems that provide complete data management.
+ * Combines both reading and writing capabilities.
+ */
+interface DataStorage extends DataSource, DataSink {
+}
+
 /**
  * A minimal, type-safe event emitter for a single event.
  * It does not manage state, it only manages subscribers and event dispatching.
@@ -302,4 +324,4 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, type Constructor, ConstructorRegistry, 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 };
+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 };

package/dist/index.d.ts

@@ -127,11 +127,11 @@ declare function getRandomElement<T>(array: T[]): T | undefined;
 
 /**
  * Throws an error if the condition is true.
- * @param conditionForThrow - If true, an error will be thrown.
+ * @param condition  - If true, an error will be thrown.
  * @param exceptionMessage - The message for the error.
  * @throws {Error} if the value is true
  */
-declare function throwIf(conditionForThrow: boolean, exceptionMessage: string): void | never;
+declare function throwIf(condition: boolean, exceptionMessage: string): asserts condition is false;
 /**
  * Throws an error if the value is null, undefined, or an empty array.
  *
@@ -205,6 +205,28 @@ declare class ConstructorRegistry<T> {
     clear(): void;
 }
 
+/**
+ * A read-only contract for any system that can provide data by path.
+ */
+interface DataSource {
+    get(path: PathType): unknown;
+    has(path: PathType): boolean;
+}
+/**
+ * A write-only contract for any system that can accept data by path.
+ */
+interface DataSink {
+    set(path: PathType, value: unknown): void;
+    create(path: PathType, value: unknown): void;
+    delete(path: PathType): void;
+}
+/**
+ * A full CRUD contract for systems that provide complete data management.
+ * Combines both reading and writing capabilities.
+ */
+interface DataStorage extends DataSource, DataSink {
+}
+
 /**
  * A minimal, type-safe event emitter for a single event.
  * It does not manage state, it only manages subscribers and event dispatching.
@@ -302,4 +324,4 @@ declare function randInt(min: number, max: number): number;
  */
 declare function randId(): string;
 
-export { type AxiEngineConfig, type Constructor, ConstructorRegistry, 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 };
+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 };

package/dist/index.js

@@ -126,8 +126,8 @@ function isPercentageString(val) {
 }
 
 // src/assertion.ts
-function throwIf(conditionForThrow, exceptionMessage) {
-  if (conditionForThrow) {
+function throwIf(condition, exceptionMessage) {
+  if (condition) {
     throw new Error(exceptionMessage);
   }
 }

package/dist/index.mjs

@@ -72,8 +72,8 @@ function isPercentageString(val) {
 }
 
 // src/assertion.ts
-function throwIf(conditionForThrow, exceptionMessage) {
-  if (conditionForThrow) {
+function throwIf(condition, exceptionMessage) {
+  if (condition) {
     throw new Error(exceptionMessage);
   }
 }

package/package.json

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