(feat): initial version

.github/workflows/npm-integration.yml

@@ -0,0 +1,22 @@
+name: Node.js Integration
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.18
+      - run: npm ci --legacy-peer-deps
+      - run: npm run lint
+      - run: npm test
+      - run: npm run build

.github/workflows/npm-publish.yml

@@ -0,0 +1,38 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.18
+      - run: npm ci --legacy-peer-deps
+      - run: npm run build
+      - run: npm run lint
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.18
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci --legacy-peer-deps
+      - run: npm run build
+      - run: npm run lint
+      - run: npm ci --legacy-peer-deps --omit=dev
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.npmignore

@@ -0,0 +1,8 @@
+src
+examples
+tsconfig.json
+eslint.config.js
+.prettierrc
+.gitignore
+.github
+.nvmrc

.nvmrc

@@ -0,0 +1 @@
+18.18

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Move Your Digital, Inc.
+
+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.

README.md

@@ -0,0 +1,59 @@
+# RegexRouter
+
+Unlike traditional routers that only match the path and method, RegexRouter allows to match any part of the HTTP request message, which includes headers, method, path, URL and query parameters, enabling customized and dynamic routing logic.
+
+**Notice:** currently available in beta; avoid using in production.
+
+## Key Features
+- **Match Any Part of the Request**: Goes beyond the basics of path and method matching: routes can be regex-based on headers, query strings, cookies, and more.
+
+- **Flexible**: Provides and allows extension with middlewares and uses standard Web API syntax.
+
+- **Easy to Use**: Plugin to any environment. It support's node.js, browser, edge, workers, etc.
+
+- **High Performance**: Being small and straighforward, it is optimized for speed and efficiency to handle high traffic loads without compromising on routing capabilities.
+
+## Getting Started
+### Installation
+Install RegexRouter via npm:
+```
+npm install @moveyourdigital/router
+```
+
+### Basic Usage
+
+```ts
+import { createServer } from "http"
+import { bind } from "../src/node/node-router"
+import { Router } from "../src/router"
+import { auth, logger, notFound, throwable } from "../src/middlewares"
+
+const router = new Router()
+  .add(/.*/, logger(), throwable(), notFound())
+  .add(/^POST/, () => new Response())
+  .add(/^GET \/private\s/, auth({ secret: 'test' }), () => new Response())
+  .add(/^GET \/\s/, () => {
+    return Response.json('Hello world!', {
+      status: 201
+    })
+  })
+
+bind(createServer, router).listen(3001) // bind for Node JS createServer
+```
+
+### Development
+To watch for changes in `src` directory.
+```bash
+npm start
+```
+To bundle for production
+```bash
+npm run build
+```
+Unit tests are located in
+```bash
+npm t
+```
+
+### Contributions
+This project is open to contributions. Feel free to discuss in Issues any implementation details first.

eslint.config.js

@@ -0,0 +1,11 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+
+export default [
+  {files: ["**/*.{js,mjs,cjs,ts}"]},
+  {languageOptions: { globals: {...globals.browser, ...globals.node} }},
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];

examples/node.ts

@@ -0,0 +1,16 @@
+import { createServer } from "http"
+import { bind } from "@moveyourdigital/router/node"
+import { Router } from "@moveyourdigital/router"
+import { auth, logger, notFound, throwable } from "@moveyourdigital/router"
+
+const router = new Router()
+  .add(/.*/, logger(), throwable(), notFound())
+  .add(/^POST/, () => new Response())
+  .add(/^GET \/private\s/, auth({ secret: 'test' }), () => new Response())
+  .add(/^GET \/\s/, () => {
+    return Response.json('Hello world!', {
+      status: 201
+    })
+  })
+
+bind(createServer, router).listen(3001)