cmpstr 3.2.0 → 3.2.2

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

@@ -9,10 +9,37 @@
  * All interfaces are designed for extensibility and clarity, supporting both internal
  * implementation and external usage in user code.
  *
- * @module Utils/Types
+ * @module Utils
+ * @name Types
  * @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
@@ -88,6 +115,11 @@ export type NormalizerFn = (input: string) => string;
  * Each character or substring corresponds to a specific normalization operation.
  */
 export type NormalizeFlags = string;
+/**
+ * FilterHooks enumerates the supported filter hook names.
+ * Allows for custom string keys as well.
+ */
+export type FilterHooks = 'input' | (string & {});
 /**
  * FilterFn defines the signature for a filter function.
  * It takes a string and returns the filtered string.
@@ -422,7 +454,7 @@ export interface CmpStrOptions {
  */
 export interface StructuredDataResult<T = any, R = MetricRaw> {
     obj: T;
-    key: string | number | symbol;
+    key: keyof T;
     result: CmpStrResult;
     raw?: R;
 }

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.0",
+  "version": "3.2.2",
   "author": {
     "name": "komed3 (Paul Köhler)",
     "email": "webmaster@komed3.de",
@@ -93,21 +93,24 @@
     "test": "vitest run",
     "build": "rollup -c && tsc --project tsconfig.declaration.json",
     "lint": "tsc --project tsconfig.lint.json",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "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.9",
+    "@types/node": "^25.4.0",
     "package-verify": "^1.0.3",
     "prettier": "^3.8.1",
-    "rollup": "^4.55.3",
+    "rollup": "^4.59.0",
     "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-prettier": "^4.1.2",
     "tslib": "^2.8.1",
+    "typedoc": "^0.28.17",
+    "typedoc-github-theme": "^0.4.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.17"
+    "vitest": "^4.0.18"
   }
 }