@axi-engine/utils 0.1.7 → 0.1.9

package/dist/path.d.ts

@@ -0,0 +1,10 @@
+import { PathType } from "./types";
+/**
+ * Ensures that the given path is returned as an array of segments.
+ */
+export declare function ensurePathArray(path: PathType, separator?: string): string[];
+/**
+ * Ensures that the given path is returned as a single string.
+ */
+export declare function ensurePathString(path: PathType, separator?: string): string;
+//# sourceMappingURL=path.d.ts.map

package/dist/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAGjC;;GAEG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,SAA4B,GAAG,MAAM,EAAE,CAE/F;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,SAA4B,GAAG,MAAM,CAE9F"}

package/dist/path.js

@@ -0,0 +1,14 @@
+import { axiSettings } from './config';
+/**
+ * Ensures that the given path is returned as an array of segments.
+ */
+export function ensurePathArray(path, separator = axiSettings.pathSeparator) {
+    return Array.isArray(path) ? [...path] : path.split(separator);
+}
+/**
+ * Ensures that the given path is returned as a single string.
+ */
+export function ensurePathString(path, separator = axiSettings.pathSeparator) {
+    return !Array.isArray(path) ? path : path.join(separator);
+}
+//# sourceMappingURL=path.js.map

package/dist/path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../src/path.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,WAAW,EAAC,MAAM,UAAU,CAAC;AAErC;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAc,EAAE,SAAS,GAAG,WAAW,CAAC,aAAa;IACnF,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAc,EAAE,SAAS,GAAG,WAAW,CAAC,aAAa;IACpF,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5D,CAAC"}

package/dist/random.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns a random integer between min (inclusive) and max (exclusive).
+ * @param min The minimum integer (inclusive).
+ * @param max The maximum integer (exclusive).
+ * @returns A random integer.
+ * @example randInt(1, 5); // returns 1, 2, 3, or 4
+ */
+export declare function randInt(min: number, max: number): number;
+/**
+ * Generates a unique identifier using uuidv4.
+ * @returns A unique string ID.
+ */
+export declare function randId(): string;
+//# sourceMappingURL=random.d.ts.map

package/dist/random.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../src/random.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAIxD;AAED;;;GAGG;AACH,wBAAgB,MAAM,WAErB"}

package/dist/random.js

@@ -0,0 +1,21 @@
+import { v4 as uuidv4 } from 'uuid';
+/**
+ * Returns a random integer between min (inclusive) and max (exclusive).
+ * @param min The minimum integer (inclusive).
+ * @param max The maximum integer (exclusive).
+ * @returns A random integer.
+ * @example randInt(1, 5); // returns 1, 2, 3, or 4
+ */
+export function randInt(min, max) {
+    min = Math.ceil(min);
+    max = Math.floor(max);
+    return Math.floor(Math.random() * (max - min) + min);
+}
+/**
+ * Generates a unique identifier using uuidv4.
+ * @returns A unique string ID.
+ */
+export function randId() {
+    return uuidv4();
+}
+//# sourceMappingURL=random.js.map

package/dist/random.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.js","sourceRoot":"","sources":["../src/random.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,GAAW;IAC9C,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM;IACpB,OAAO,MAAM,EAAE,CAAC;AAClB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Represents a path that can be provided as a single string
+ * or an array of segments.
+ * @example
+ * 'player/stats/health'
+ * ['player', 'stats', 'health']
+ */
+export 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
+ */
+export 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.
+ */
+export 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;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,EAAE,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,IAAI;IAC1C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAEtD,WAAW,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC;IAErD,KAAK,IAAI,IAAI,CAAC;CACf,CAAA"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@axi-engine/utils",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Core utility library for Axi Engine, providing common functions for arrays, math, type guards, and more.",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/axijs/engine.git",
+    "directory": "packages/utils"
+  },
   "keywords": [
     "axi-engine",
     "typescript",
@@ -20,7 +25,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/utils'"
   },