cmpstr 3.0.2 → 3.0.4

package/dist/types/index.d.ts

@@ -7,7 +7,7 @@
  * filtering, and text analysis. It is designed for both high-level application development
  * and research, offering a unified API for single, batch, and pairwise operations.
  *
- * Version: 3.0.2
+ * Version: 3.0.4
  * Author: Paul Köhler (komed3)
  * License: MIT
  *
@@ -19,6 +19,7 @@
  *  - Phonetic algorithms (Cologne, Soundex, Metaphone) with mapping registry
  *  - Flexible normalization and filtering pipeline for all inputs
  *  - Batch, pairwise, and single comparison with detailed, type-safe results
+ *  - Safe-mode for handling empty inputs gracefully
  *  - Phonetic-aware search, indexing, and comparison
  *  - Readability and text analysis utilities (syllables, word stats, etc.)
  *  - Unified diff and difference reporting (line/word, ASCII/CLI)
@@ -39,7 +40,7 @@
  * For asynchronous workloads, use `CmpStrAsync`, which provides the same API with
  * Promise-based, non-blocking methods for large-scale or I/O-bound operations.
  *
- * @version 3.0.2
+ * @version 3.0.4
  * @author Paul Köhler (komed3)
  * @license MIT
  */

package/dist/types/root.d.ts

@@ -0,0 +1,38 @@
+/**
+ * CmpStr Development Entry Point
+ * src/root.ts
+ *
+ * This entry point is intended for development and extension of the CmpStr library. It exposes
+ * core components and utilities that allow developers to create new metrics, phonetic algorithms,
+ * and other extensions to the library.
+ *
+ * Please visit CmpStr's documentation for more information:
+ * https://github.com/komed3/cmpstr/wiki/Extending-CmpStr
+ *
+ * @version 3.0.4
+ * @author Paul Köhler (komed3)
+ * @license MIT
+ */
+export * from './utils/Types';
+/**
+ * Export utils to implement new metrics
+ *
+ *  - MetricRegistry: Metric registry service for managing metric implementations.
+ *  - Metric: Abstract class representing a generic string metric.
+ *  - MetricCls: Type definition for a class constructor that extends the Metric class.
+ */
+export { MetricRegistry, Metric, MetricCls } from './metric';
+/**
+ * Export utils to implement new phonetic algorithms
+ *
+ *  - PhoneticRegistry: Phonetic registry service for managing phonetic algorithm implementations.
+ *  - PhoneticMappingRegistry: Registry for managing phonetic character mappings.
+ *  - Phonetic: Abstract class representing a generic phonetic algorithm.
+ *  - PhoneticCls: Type definition for a class constructor that extends the Phonetic class.
+ */
+export { PhoneticRegistry, PhoneticMappingRegistry, Phonetic, PhoneticCls } from './phonetic';
+export * as DeepMerge from './utils/DeepMerge';
+export { Filter } from './utils/Filter';
+export { HashTable } from './utils/HashTable';
+export { Pool } from './utils/Pool';
+export { Profiler } from './utils/Profiler';

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

@@ -313,6 +313,7 @@ export interface CmpStrOptions {
     opt?: MetricOptions;
     processors?: CmpStrProcessors;
     output?: 'orig' | 'prep';
+    safeEmpty?: boolean;
 }
 /**
  * CmpStrResult represents a simplified result for user-facing API methods.

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.0.2",
+  "version": "3.0.4",
   "author": {
     "name": "komed3 (Paul Köhler)",
     "email": "webmaster@komed3.de",
@@ -31,23 +31,28 @@
     "README.md",
     "LICENSE"
   ],
-  "engines": { 
+  "engines": {
     "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",
-  "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "require": "./dist/cjs/index.cjs",
-      "import": "./dist/esm/index.mjs",
-      "types": "./dist/types/index.d.ts"
+      "import": "./dist/esm/index.mjs"
+    },
+    "./root": {
+      "types": "./dist/types/root.d.ts",
+      "require": "./dist/cjs/root.cjs",
+      "import": "./dist/esm/root.mjs"
     }
   },
   "scripts": {
     "test": "vitest run",
-    "build": "rollup -c && tsc --project tsconfig.build.json",
+    "build": "rollup -c && tsc --project tsconfig.declaration.json",
     "lint": "tsc --project tsconfig.lint.json",
     "clean": "rm -rf dist"
   },
@@ -56,12 +61,13 @@
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.4",
-    "@types/node": "^24.0.15",
+    "@types/node": "^24.4.0",
     "prettier": "^3.6.2",
-    "rollup": "^4.45.1",
+    "rollup": "^4.50.2",
+    "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-prettier": "^4.1.2",
     "tslib": "^2.8.1",
-    "typescript": "^5.8.3",
+    "typescript": "^5.9.2",
     "vitest": "^3.2.4"
   }
 }