extreme-router 1.0.0

package/CHANGELOG.MD

@@ -0,0 +1,50 @@
+extreme-router\CHANGELOG.md
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [1.0.0] - 2025-05-09
+
+### Added
+
+-   Initial implementation of the `Extreme` router class ([`src/router.ts`](c:\Users\lior3\Development\liodex\extreme-router\src\router.ts)).
+-   Support for static route registration and matching.
+-   Support for dynamic route registration and matching via a plugin system.
+-   Plugin registration mechanism (`router.use`).
+-   Route registration mechanism (`router.register`).
+-   Route unregistration mechanism (`router.unregister`) for static, dynamic, and optional parameter paths.
+-   Route matching mechanism (`router.match`).
+-   Route inspection mechanism (`inspect()` for retrieving a list of all registered routes).
+-   Built-in plugins: `param`, `wildcard`, `regexParam`, `extensionParam`, `groupParam`, `prefixGroup`, `optionalPrefixGroup`, `optionalParam` ([`index.ts`](c:\Users\lior3\Development\liodex\extreme-router\index.ts)).
+-   Support for optional parameters in routes (`router.register`).
+-   Configurable `storeFactory` for route stores.
+-   Comprehensive JSDoc/TSDoc comments for the `Extreme` router class and its public methods ([`src/router.ts`](c:\Users\lior3\Development\liodex\extreme-router\src\router.ts)).
+-   Development setup using Bun, ESLint, Prettier, Vitest, tsup, Husky, lint-staged.
+-   Benchmark scripts (`match`, `memory`, `stress`).
+-   Testing suite with coverage reporting.
+-   `README.md` with usage examples, API documentation, and development guidelines.
+-   `CONTRIBUTING.md` outlining contribution guidelines.
+-   `LICENSE` file (MIT).
+-   Scripts for generating bundle size and benchmark reports.
+
+### Changed
+
+-   Improved error handling with specific `ErrorTypes`.
+-   Refined plugin validation logic in `router.use`.
+-   Optimized dynamic node sorting by priority in `registerDynamicPath`.
+
+### Fixed
+
+-   Ensured correct handling of wildcard routes during matching.
+-   Addressed potential conflicts during dynamic route registration.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lior Cohen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.