@axi-engine/fields 0.1.1 → 0.1.2

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { ReadonlySignal, Signal } from '@preact/signals-core';
-import EventEmitter3 from 'eventemitter3';
+import { AxiEventEmitter } from '@axi-engine/events';
+import { PathType } from '@axi-engine/utils';
 
 declare const enum FieldsNodeType {
     fieldTree = "FieldTree",
@@ -131,15 +132,6 @@ declare class NumberField extends Field<number> {
     dec(amount?: number): void;
 }
 
-/**
- * This class is a wrapper around EventEmitter3, providing a stable,
- *
- * A high performance event emitter
- * @see {@link https://github.com/primus/eventemitter3}
- */
-declare class AxiEventEmitter<T extends string | symbol> extends EventEmitter3<T> {
-}
-
 /**
  * An abstract base class for managing a reactive collection of `Field` instances.
  *
@@ -226,15 +218,6 @@ declare class Fields extends BaseFields<any> {
 declare class TypedFields<T> extends BaseFields<T> {
 }
 
-/**
- * Represents a path that can be provided as a single string
- * or an array of segments.
- * @example
- * 'player/stats/health'
- * ['player', 'stats', 'health']
- */
-type PathType = string | string[];
-
 /** A type alias for any container that can be a child node in a FieldTree */
 type TreeOrFieldsContainer = FieldTree | Fields | TypedFields<any>;
 /** Describes the payload for events emitted when a container is created or removed from a FieldTree. */

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { ReadonlySignal, Signal } from '@preact/signals-core';
-import EventEmitter3 from 'eventemitter3';
+import { AxiEventEmitter } from '@axi-engine/events';
+import { PathType } from '@axi-engine/utils';
 
 declare const enum FieldsNodeType {
     fieldTree = "FieldTree",
@@ -131,15 +132,6 @@ declare class NumberField extends Field<number> {
     dec(amount?: number): void;
 }
 
-/**
- * This class is a wrapper around EventEmitter3, providing a stable,
- *
- * A high performance event emitter
- * @see {@link https://github.com/primus/eventemitter3}
- */
-declare class AxiEventEmitter<T extends string | symbol> extends EventEmitter3<T> {
-}
-
 /**
  * An abstract base class for managing a reactive collection of `Field` instances.
  *
@@ -226,15 +218,6 @@ declare class Fields extends BaseFields<any> {
 declare class TypedFields<T> extends BaseFields<T> {
 }
 
-/**
- * Represents a path that can be provided as a single string
- * or an array of segments.
- * @example
- * 'player/stats/health'
- * ['player', 'stats', 'health']
- */
-type PathType = string | string[];
-
 /** A type alias for any container that can be a child node in a FieldTree */
 type TreeOrFieldsContainer = FieldTree | Fields | TypedFields<any>;
 /** Describes the payload for events emitted when a container is created or removed from a FieldTree. */

package/dist/index.js

@@ -372,39 +372,8 @@ var Field = class {
   }
 };
 
-// ../utils/src/guards.ts
-function isNullOrUndefined(val) {
-  return val === void 0 || val === null;
-}
-
-// ../utils/src/assertion.ts
-function throwIf(conditionForThrow, exceptionMessage) {
-  if (conditionForThrow) {
-    throw new Error(exceptionMessage);
-  }
-}
-function throwIfEmpty(value, exceptionMessage) {
-  const isArrayAndEmpty = Array.isArray(value) && value.length === 0;
-  if (isNullOrUndefined(value) || isArrayAndEmpty) {
-    throw new Error(exceptionMessage);
-  }
-}
-
-// ../utils/src/config.ts
-var defaultConfig = {
-  pathSeparator: "/"
-};
-var axiSettings = { ...defaultConfig };
-
-// ../utils/src/path.ts
-function ensurePathArray(path, separator = axiSettings.pathSeparator) {
-  return Array.isArray(path) ? [...path] : path.split(separator);
-}
-function ensurePathString(path, separator = axiSettings.pathSeparator) {
-  return !Array.isArray(path) ? path : path.join(separator);
-}
-
 // src/number-field.ts
+var import_utils = require("@axi-engine/utils");
 var NumberField = class extends Field {
   get min() {
     const policy = this.getPolicy(ClampPolicy.id) ?? this.getPolicy(ClampMinPolicy.id);
@@ -416,19 +385,19 @@ var NumberField = class extends Field {
   }
   get isMin() {
     const min = this.min;
-    return isNullOrUndefined(min) ? false : this.val <= min;
+    return (0, import_utils.isNullOrUndefined)(min) ? false : this.val <= min;
   }
   get isMax() {
     const max = this.max;
-    return isNullOrUndefined(max) ? false : this.val >= max;
+    return (0, import_utils.isNullOrUndefined)(max) ? false : this.val >= max;
   }
   constructor(name, initialVal, options) {
     const policies = options?.policies ?? [];
-    if (!isNullOrUndefined(options?.min) && !isNullOrUndefined(options?.max)) {
+    if (!(0, import_utils.isNullOrUndefined)(options?.min) && !(0, import_utils.isNullOrUndefined)(options?.max)) {
       policies.unshift(clampPolicy(options.min, options.max));
-    } else if (!isNullOrUndefined(options?.min)) {
+    } else if (!(0, import_utils.isNullOrUndefined)(options?.min)) {
       policies.unshift(clampMinPolicy(options.min));
-    } else if (!isNullOrUndefined(options?.max)) {
+    } else if (!(0, import_utils.isNullOrUndefined)(options?.max)) {
       policies.unshift(clampMaxPolicy(options.max));
     }
     super(name, initialVal, { policies });
@@ -455,6 +424,7 @@ var AxiEventEmitter = class extends eventemitter3_default {
 };
 
 // src/base-fields.ts
+var import_utils2 = require("@axi-engine/utils");
 var BaseFields = class {
   constructor() {
     this._fields = (0, import_signals_core2.signal)(/* @__PURE__ */ new Map());
@@ -492,7 +462,7 @@ var BaseFields = class {
    * @returns The added `Field` instance.
    */
   add(field) {
-    throwIf(this.has(field.name), `Field with name '${field.name}' already exists`);
+    (0, import_utils2.throwIf)(this.has(field.name), `Field with name '${field.name}' already exists`);
     const fieldsMap = new Map(this._fields.value);
     fieldsMap.set(field.name, field);
     this._fields.value = fieldsMap;
@@ -509,7 +479,7 @@ var BaseFields = class {
    * @returns The `Field` instance.
    */
   get(name) {
-    throwIf(!this._fields.value.has(name), `Field with name '${name}' not exists`);
+    (0, import_utils2.throwIf)(!this._fields.value.has(name), `Field with name '${name}' not exists`);
     return this._fields.value.get(name);
   }
   /**
@@ -582,6 +552,7 @@ var BaseFields = class {
 };
 
 // src/fields.ts
+var import_utils3 = require("@axi-engine/utils");
 var Fields = class extends BaseFields {
   createNumber(name, initialValue, options) {
     return this.add(new NumberField(name, initialValue, options));
@@ -596,7 +567,7 @@ var Fields = class extends BaseFields {
   }
   getNumber(name) {
     const field = this.get(name);
-    throwIf(!(field instanceof NumberField), `wrong field type, field ${name} not a instance of NUmberField`);
+    (0, import_utils3.throwIf)(!(field instanceof NumberField), `wrong field type, field ${name} not a instance of NUmberField`);
     return field;
   }
   create(name, initialValue) {
@@ -611,7 +582,7 @@ var Fields = class extends BaseFields {
     return this.create(name, value);
   }
   get(name) {
-    throwIf(!this._fields.value.has(name), `Field with name '${name}' not exists`);
+    (0, import_utils3.throwIf)(!this._fields.value.has(name), `Field with name '${name}' not exists`);
     return this._fields.value.get(name);
   }
 };
@@ -622,6 +593,7 @@ var TypedFields = class extends BaseFields {
 
 // src/field-tree.ts
 var import_signals_core3 = require("@preact/signals-core");
+var import_utils4 = require("@axi-engine/utils");
 var FieldTree = class _FieldTree {
   constructor() {
     this.events = new AxiEventEmitter();
@@ -639,7 +611,7 @@ var FieldTree = class _FieldTree {
    * @returns true if the entire path exists, false otherwise.
    */
   hasPath(path) {
-    const pathParts = ensurePathArray(path);
+    const pathParts = (0, import_utils4.ensurePathArray)(path);
     let currentNode = this;
     for (let i = 0; i < pathParts.length; i++) {
       const part = pathParts[i];
@@ -651,9 +623,9 @@ var FieldTree = class _FieldTree {
         if (i === pathParts.length - 1) {
           return true;
         }
-        throwIf(
+        (0, import_utils4.throwIf)(
           pathParts.length - i > 2,
-          `Path validation failed, full path: ${ensurePathString(path)}, has extra nodes after Fields placed at: ${ensurePathString(pathParts.slice(0, i + 1))}`
+          `Path validation failed, full path: ${(0, import_utils4.ensurePathString)(path)}, has extra nodes after Fields placed at: ${(0, import_utils4.ensurePathString)(pathParts.slice(0, i + 1))}`
         );
         return nextNode.has(pathParts[i + 1]);
       }
@@ -669,7 +641,7 @@ var FieldTree = class _FieldTree {
    */
   getFieldTree(name) {
     const node = this.getNode(name);
-    throwIf(!(node instanceof _FieldTree), `Node '${name}' should be instance of FieldTree`);
+    (0, import_utils4.throwIf)(!(node instanceof _FieldTree), `Node '${name}' should be instance of FieldTree`);
     return node;
   }
   /**
@@ -680,7 +652,7 @@ var FieldTree = class _FieldTree {
    */
   getFields(name) {
     const node = this.getNode(name);
-    throwIf(!(node instanceof Fields), `Node '${name}' should be instance of Fields`);
+    (0, import_utils4.throwIf)(!(node instanceof Fields), `Node '${name}' should be instance of Fields`);
     return node;
   }
   /**
@@ -691,7 +663,7 @@ var FieldTree = class _FieldTree {
    */
   getTypedFields(name) {
     const node = this.getNode(name);
-    throwIf(!(node instanceof TypedFields), `Node '${name}' should be instance of TypedFields`);
+    (0, import_utils4.throwIf)(!(node instanceof TypedFields), `Node '${name}' should be instance of TypedFields`);
     return node;
   }
   /**
@@ -702,7 +674,7 @@ var FieldTree = class _FieldTree {
    */
   getNode(name) {
     const node = this._items.value.get(name);
-    throwIfEmpty(node, `Can't find node with name '${name}'`);
+    (0, import_utils4.throwIfEmpty)(node, `Can't find node with name '${name}'`);
     return node;
   }
   /**
@@ -736,8 +708,8 @@ var FieldTree = class _FieldTree {
    * @throws If the path is empty, or any intermediate node is not a `FieldTree`.
    */
   getFieldsByPath(path) {
-    const pathParts = ensurePathArray(path);
-    throwIf(!pathParts.length, "Empty path");
+    const pathParts = (0, import_utils4.ensurePathArray)(path);
+    (0, import_utils4.throwIf)(!pathParts.length, "Empty path");
     let container = this;
     for (let i = 0; i < pathParts.length - 1; i++) {
       container = container.getFieldTree(pathParts[i]);
@@ -752,9 +724,9 @@ var FieldTree = class _FieldTree {
    * @returns The newly created `Field` instance.
    */
   create(path, initialValue) {
-    const fullPath = [...ensurePathArray(path)];
+    const fullPath = [...(0, import_utils4.ensurePathArray)(path)];
     const fieldName = fullPath.pop();
-    throwIf(!fullPath.length, `Wrong path format of one field creating: '${ensurePathString(path)}', should be at least two sections`);
+    (0, import_utils4.throwIf)(!fullPath.length, `Wrong path format of one field creating: '${(0, import_utils4.ensurePathString)(path)}', should be at least two sections`);
     return this.getFieldsByPath(fullPath).create(fieldName, initialValue);
   }
   /**
@@ -764,7 +736,7 @@ var FieldTree = class _FieldTree {
    * @returns The newly created `NumberField` instance.
    */
   createNumber(path, initialValue) {
-    const fullPath = [...ensurePathArray(path)];
+    const fullPath = [...(0, import_utils4.ensurePathArray)(path)];
     const fieldName = fullPath.pop();
     return this.getFieldsByPath(fullPath).createNumber(fieldName, initialValue);
   }
@@ -774,7 +746,7 @@ var FieldTree = class _FieldTree {
    * @returns The `Field` instance at the specified path.
    */
   get(path) {
-    const fullPath = [...ensurePathArray(path)];
+    const fullPath = [...(0, import_utils4.ensurePathArray)(path)];
     const fieldName = fullPath.pop();
     return this.getFieldsByPath(fullPath).get(fieldName);
   }
@@ -784,7 +756,7 @@ var FieldTree = class _FieldTree {
    * @returns The `NumberField` instance at the specified path.
    */
   getNumber(path) {
-    const fullPath = [...ensurePathArray(path)];
+    const fullPath = [...(0, import_utils4.ensurePathArray)(path)];
     const fieldName = fullPath.pop();
     return this.getFieldsByPath(fullPath).getNumber(fieldName);
   }
@@ -833,7 +805,7 @@ var FieldTree = class _FieldTree {
    */
   createNode(name, ctor) {
     const currentItems = this._items.value;
-    throwIf(currentItems.has(name), `Can't create node with name: '${name}', node already exists`);
+    (0, import_utils4.throwIf)(currentItems.has(name), `Can't create node with name: '${name}', node already exists`);
     const res = new ctor();
     const newItems = new Map(currentItems);
     newItems.set(name, res);

package/dist/index.mjs

@@ -347,39 +347,8 @@ var Field = class {
   }
 };
 
-// ../utils/src/guards.ts
-function isNullOrUndefined(val) {
-  return val === void 0 || val === null;
-}
-
-// ../utils/src/assertion.ts
-function throwIf(conditionForThrow, exceptionMessage) {
-  if (conditionForThrow) {
-    throw new Error(exceptionMessage);
-  }
-}
-function throwIfEmpty(value, exceptionMessage) {
-  const isArrayAndEmpty = Array.isArray(value) && value.length === 0;
-  if (isNullOrUndefined(value) || isArrayAndEmpty) {
-    throw new Error(exceptionMessage);
-  }
-}
-
-// ../utils/src/config.ts
-var defaultConfig = {
-  pathSeparator: "/"
-};
-var axiSettings = { ...defaultConfig };
-
-// ../utils/src/path.ts
-function ensurePathArray(path, separator = axiSettings.pathSeparator) {
-  return Array.isArray(path) ? [...path] : path.split(separator);
-}
-function ensurePathString(path, separator = axiSettings.pathSeparator) {
-  return !Array.isArray(path) ? path : path.join(separator);
-}
-
 // src/number-field.ts
+import { isNullOrUndefined } from "@axi-engine/utils";
 var NumberField = class extends Field {
   get min() {
     const policy = this.getPolicy(ClampPolicy.id) ?? this.getPolicy(ClampMinPolicy.id);
@@ -430,6 +399,7 @@ var AxiEventEmitter = class extends eventemitter3_default {
 };
 
 // src/base-fields.ts
+import { throwIf } from "@axi-engine/utils";
 var BaseFields = class {
   constructor() {
     this._fields = signal2(/* @__PURE__ */ new Map());
@@ -557,6 +527,7 @@ var BaseFields = class {
 };
 
 // src/fields.ts
+import { throwIf as throwIf2 } from "@axi-engine/utils";
 var Fields = class extends BaseFields {
   createNumber(name, initialValue, options) {
     return this.add(new NumberField(name, initialValue, options));
@@ -571,7 +542,7 @@ var Fields = class extends BaseFields {
   }
   getNumber(name) {
     const field = this.get(name);
-    throwIf(!(field instanceof NumberField), `wrong field type, field ${name} not a instance of NUmberField`);
+    throwIf2(!(field instanceof NumberField), `wrong field type, field ${name} not a instance of NUmberField`);
     return field;
   }
   create(name, initialValue) {
@@ -586,7 +557,7 @@ var Fields = class extends BaseFields {
     return this.create(name, value);
   }
   get(name) {
-    throwIf(!this._fields.value.has(name), `Field with name '${name}' not exists`);
+    throwIf2(!this._fields.value.has(name), `Field with name '${name}' not exists`);
     return this._fields.value.get(name);
   }
 };
@@ -597,6 +568,7 @@ var TypedFields = class extends BaseFields {
 
 // src/field-tree.ts
 import { signal as signal3 } from "@preact/signals-core";
+import { ensurePathArray, ensurePathString, throwIf as throwIf3, throwIfEmpty } from "@axi-engine/utils";
 var FieldTree = class _FieldTree {
   constructor() {
     this.events = new AxiEventEmitter();
@@ -626,7 +598,7 @@ var FieldTree = class _FieldTree {
         if (i === pathParts.length - 1) {
           return true;
         }
-        throwIf(
+        throwIf3(
           pathParts.length - i > 2,
           `Path validation failed, full path: ${ensurePathString(path)}, has extra nodes after Fields placed at: ${ensurePathString(pathParts.slice(0, i + 1))}`
         );
@@ -644,7 +616,7 @@ var FieldTree = class _FieldTree {
    */
   getFieldTree(name) {
     const node = this.getNode(name);
-    throwIf(!(node instanceof _FieldTree), `Node '${name}' should be instance of FieldTree`);
+    throwIf3(!(node instanceof _FieldTree), `Node '${name}' should be instance of FieldTree`);
     return node;
   }
   /**
@@ -655,7 +627,7 @@ var FieldTree = class _FieldTree {
    */
   getFields(name) {
     const node = this.getNode(name);
-    throwIf(!(node instanceof Fields), `Node '${name}' should be instance of Fields`);
+    throwIf3(!(node instanceof Fields), `Node '${name}' should be instance of Fields`);
     return node;
   }
   /**
@@ -666,7 +638,7 @@ var FieldTree = class _FieldTree {
    */
   getTypedFields(name) {
     const node = this.getNode(name);
-    throwIf(!(node instanceof TypedFields), `Node '${name}' should be instance of TypedFields`);
+    throwIf3(!(node instanceof TypedFields), `Node '${name}' should be instance of TypedFields`);
     return node;
   }
   /**
@@ -712,7 +684,7 @@ var FieldTree = class _FieldTree {
    */
   getFieldsByPath(path) {
     const pathParts = ensurePathArray(path);
-    throwIf(!pathParts.length, "Empty path");
+    throwIf3(!pathParts.length, "Empty path");
     let container = this;
     for (let i = 0; i < pathParts.length - 1; i++) {
       container = container.getFieldTree(pathParts[i]);
@@ -729,7 +701,7 @@ var FieldTree = class _FieldTree {
   create(path, initialValue) {
     const fullPath = [...ensurePathArray(path)];
     const fieldName = fullPath.pop();
-    throwIf(!fullPath.length, `Wrong path format of one field creating: '${ensurePathString(path)}', should be at least two sections`);
+    throwIf3(!fullPath.length, `Wrong path format of one field creating: '${ensurePathString(path)}', should be at least two sections`);
     return this.getFieldsByPath(fullPath).create(fieldName, initialValue);
   }
   /**
@@ -808,7 +780,7 @@ var FieldTree = class _FieldTree {
    */
   createNode(name, ctor) {
     const currentItems = this._items.value;
-    throwIf(currentItems.has(name), `Can't create node with name: '${name}', node already exists`);
+    throwIf3(currentItems.has(name), `Can't create node with name: '${name}', node already exists`);
     const res = new ctor();
     const newItems = new Map(currentItems);
     newItems.set(name, res);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axi-engine/fields",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "",
   "license": "MIT",
   "keywords": [
@@ -20,7 +20,7 @@
     }
   },
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "build": "tsup",
     "docs": "typedoc src/index.ts --out docs/api --options ../../typedoc.json",
     "test": "echo 'No tests yet for @axi-engine/fields'"
   },
@@ -28,10 +28,10 @@
     "dist"
   ],
   "dependencies": {
-    "@preact/signals-core": "^1.12.1"
+    "@axi-engine/utils": "*",
+    "@axi-engine/events": "*"
   },
-  "devDependencies": {
-    "@axi-engine/events": "*",
-    "@axi-engine/utils": "*"
+  "peerDependencies": {
+    "@preact/signals-core": "^1.12.1"
   }
 }