cmpstr 3.2.1 → 3.3.0

package/dist/types/utils/Profiler.d.ts

@@ -32,6 +32,7 @@ export declare class Profiler {
     private memFn;
     /** Store for profiler entries */
     private store;
+    private last?;
     /** Total time and memory consumption */
     private totalTime;
     private totalMem;
@@ -56,41 +57,21 @@ export declare class Profiler {
      */
     private constructor();
     /**
-     * Gets the current time based on the environment.
+     * Stores a profiler entry in the store and updates the total time and memory consumption.
      *
-     * Uses process.hrtime.bigint() for Node.js, performance.now() for browsers,
-     * and Date.now() as a fallback.
-     *
-     * @returns {number} - Current time in milliseconds
-     */
-    private now;
-    /**
-     * Gets the current memory usage based on the environment.
-     *
-     * Uses process.memoryUsage().heapUsed for Node.js, performance.memory.usedJSHeapSize
-     * for browsers, and returns 0 as a fallback.
-     *
-     * @returns {number} - Current memory usage in bytes
-     */
-    private mem;
-    /**
-     * Profiles a synchronous function by measuring its execution time and memory usage.
-     *
-     * @param {() => T} fn - Function to be executed and profiled
-     * @param {Record< string, any >} meta - Metadata to be associated with the profiling entry
-     * @returns {T} - The result of the executed function
+     * @param {ProfilerEntry< T >} entry - The profiler entry to be stored
      */
-    private profile;
+    private storeRes;
     /**
      * Enables the profiler.
      * Sets the active state to true, allowing profiling to occur.
      */
-    enable: () => void;
+    enable(): void;
     /**
      * Disables the profiler.
      * Sets the active state to false, preventing further profiling.
      */
-    disable: () => void;
+    disable(): void;
     /**
      * Resets the profiler by clearing the store, total time and memory consumption.
      * This method is useful for starting a new profiling session.
@@ -119,19 +100,19 @@ export declare class Profiler {
      *
      * @returns {ProfilerEntry< any >[]} - An array of profiler entries
      */
-    getAll: () => ProfilerEntry<any>[];
+    getAll(): ProfilerEntry<any>[];
     /**
      * Retrieves the last profiler entry stored in the profiler.
      *
      * @returns {ProfilerEntry< any > | undefined} - The last profiler entry or undefined if no entries exist
      */
-    getLast: () => ProfilerEntry<any> | undefined;
+    getLast(): ProfilerEntry<any> | undefined;
     /**
      * Retrieves the total time and memory consumption recorded by the profiler.
      *
      * @returns {{ time: number, mem: number }} - An object containing total time and memory usage
      */
-    getTotal: () => {
+    getTotal(): {
         time: number;
         mem: number;
     };

package/dist/types/utils/Registry.d.ts

@@ -35,7 +35,7 @@ export declare const factory: Record<string, (cls: string, ...args: any[]) => In
  * @param {string} reg - The name of the registry
  * @param {RegistryConstructor< T >} ctor - The base constructor that all registered classes must extend
  * @returns {RegistryService< T >} - An object with methods to register, remove, check, get, and list classes
- * @throws {Error} If the registry already exists (overwriting is forbidden)
+ * @throws {Error} - If the registry already exists (overwriting is forbidden)
  */
 export declare function Registry<T>(reg: string, ctor: RegistryConstructor<T>): RegistryService<T>;
 /**
@@ -45,7 +45,7 @@ export declare function Registry<T>(reg: string, ctor: RegistryConstructor<T>):
  * @param {string} reg - The name of the registry
  * @param {T | string} cls - The class itself or name of the class to resolve
  * @returns {T | undefined} - The class constructor if found, otherwise undefined
- * @throws {ReferenceError} If the registry does not exist
+ * @throws {CmpStrNotFoundError} - If the registry or class does not exist
  */
 export declare function resolveCls<T extends RegistryConstructor<any>>(reg: string, cls: T | string): T;
 /**
@@ -56,6 +56,6 @@ export declare function resolveCls<T extends RegistryConstructor<any>>(reg: stri
  * @param {T | string} cls - The class itself or name of the class to instantiate
  * @param {...any} args - Arguments to pass to the class constructor
  * @returns {T} - An instance of the class
- * @throws {Error} If the class cannot be instantiated
+ * @throws {CmpStrInternalError} - If instantiation fails due to an internal error
  */
 export declare function createFromRegistry<T extends RegistryConstructor<any>>(reg: string, cls: T | string, ...args: any[]): InstanceType<T>;

package/dist/types/utils/StructuredData.d.ts

@@ -29,6 +29,9 @@ import type { CmpFnResult, CmpStrOptions, MetricRaw, StructuredDataBatchResult,
 export declare class StructuredData<T = any, R = MetricRaw> {
     private readonly data;
     private readonly key;
+    /** Sorting functions for ascending and descending order based on the 'res' property. */
+    private static readonly SORT_ASC;
+    private static readonly SORT_DESC;
     /**
      * Creates a new StructuredData instance for processing structured data.
      *
@@ -80,7 +83,7 @@ export declare class StructuredData<T = any, R = MetricRaw> {
      *
      * @param {any} results - The raw metric results
      * @returns {IndexedResult< R >[]} - Normalized results with indices
-     * @throws {TypeError} - If results format is unsupported
+     * @throws {CmpStrValidationError} - If the results format is unsupported
      */
     private normalizeResults;
     /**
@@ -121,6 +124,7 @@ export declare class StructuredData<T = any, R = MetricRaw> {
      * @param {string[]} extractedStrings - The extracted strings for index mapping
      * @param {StructuredDataOptions} [opt] - Additional options
      * @returns {StructuredDataBatchResult< T, R > | T[]} - The lookup results
+     * @throws {CmpStrUsageError} - If the lookup process fails
      */
     private performLookup;
     /**
@@ -130,6 +134,7 @@ export declare class StructuredData<T = any, R = MetricRaw> {
      * @param {string[]} extractedStrings - The extracted strings for index mapping
      * @param {StructuredDataOptions} [opt] - Additional options
      * @returns {Promise< StructuredDataBatchResult< T, R > | T[] >} - The async lookup results
+     * @throws {CmpStrUsageError} - If the async lookup process fails
      */
     private performLookupAsync;
     /**

package/dist/types/utils/Types.d.ts

@@ -14,6 +14,32 @@
  * @author Paul Köhler (komed3)
  * @license MIT
  */
+/**
+ * ================================================================================
+ * ERROR HANDLING
+ * ================================================================================
+ *
+ * Types for standardized error classes and structured error metadata.
+ */
+/**
+ * Metadata attached to a CmpStr error.
+ */
+export type CmpStrErrorMeta = Record<string, any> | undefined;
+/**
+ * Structured format for CmpStr errors when serialized to JSON.
+ */
+export interface CmpStrErrorJSON {
+    name: string;
+    code: string;
+    message: string;
+    meta?: CmpStrErrorMeta;
+    when: string;
+    cause?: {
+        name: string;
+        message: string;
+        stack?: string;
+    } | unknown;
+}
 /**
  * ================================================================================
  * PROFILER & POOL UTILITIES
@@ -53,7 +79,7 @@ export interface ProfilerService<T> {
 /**
  * PoolType enumerates the supported buffer types for the Pool utility.
  */
-export type PoolType = 'int32' | 'number[]' | 'string[]' | 'set' | 'map';
+export type PoolType = 'int32' | 'arr[]' | 'number[]' | 'string[]' | 'set' | 'map';
 /**
  * PoolConfig defines the configuration for a buffer pool.
  */
@@ -72,6 +98,18 @@ export interface PoolBuffer<T> {
     buffer: T;
     size: number;
 }
+/**
+ * ================================================================================
+ * VALIDATION
+ * ================================================================================
+ *
+ * Types for option validation.
+ */
+/**
+ * ValidatorFn defines the signature for a validation function.
+ * It takes an unknown value and either returns void if valid or throws an error if invalid.
+ */
+export type ValidatorFn = (v: unknown) => void;
 /**
  * ================================================================================
  * NORMALIZATION & FILTERING

package/package.json

@@ -2,7 +2,7 @@
   "name": "cmpstr",
   "description": "CmpStr is a lightweight, fast and well performing package for calculating string similarity",
   "license": "MIT",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "author": {
     "name": "komed3 (Paul Köhler)",
     "email": "webmaster@komed3.de",
@@ -74,19 +74,28 @@
     "node": ">=18.0.0"
   },
   "types": "./dist/types/index.d.ts",
-  "browser": "./dist/CmpStr.umd.min.js",
   "main": "./dist/cjs/index.cjs",
-  "module": "./dist/esm/index.mjs",
   "exports": {
     ".": {
+      "browser": "./dist/CmpStr.umd.min.js",
       "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.mjs",
       "require": "./dist/cjs/index.cjs",
-      "import": "./dist/esm/index.mjs"
+      "default": "./dist/esm/index.mjs"
     },
     "./root": {
       "types": "./dist/types/root.d.ts",
       "require": "./dist/cjs/root.cjs",
-      "import": "./dist/esm/root.mjs"
+      "import": "./dist/esm/root.mjs",
+      "default": "./dist/esm/root.mjs"
+    },
+    "./bundle": {
+      "import": "./dist/CmpStr.esm.js",
+      "default": "./dist/CmpStr.esm.js"
+    },
+    "./bundle/min": {
+      "import": "./dist/CmpStr.esm.min.js",
+      "default": "./dist/CmpStr.esm.min.js"
     }
   },
   "scripts": {
@@ -97,19 +106,19 @@
     "docs": "typedoc --logLevel Verbose --options typedoc.json"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-commonjs": "^29.0.2",
     "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
-    "@types/node": "^25.0.10",
+    "@types/node": "^25.4.0",
     "package-verify": "^1.0.3",
     "prettier": "^3.8.1",
-    "rollup": "^4.57.0",
+    "rollup": "^4.59.0",
     "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-prettier": "^4.1.2",
     "tslib": "^2.8.1",
-    "typedoc": "^0.28.16",
-    "typedoc-github-theme": "^0.3.1",
+    "typedoc": "^0.28.17",
+    "typedoc-github-theme": "^0.4.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.18"
   }