@bracketed/hono-router 1.0.0 → 1.0.1

package/README.md

@@ -5,24 +5,20 @@
 
 <br>
 
-<h2 align="center" >@bracketed/logger</h2>
+<h2 align="center" >@bracketed/hono-router</h2>
 
-An alternative to your run-of-the-mill node console logging functions!
-This is a package built from the source code of [@sapphire/framework](https://www.npmjs.com/package/@sapphire/framework) & [@sapphire/plugin-logger](https://www.npmjs.com/package/@sapphire/plugin-logger) to allow usage of Sapphire's logger features in regular Node.js, full credit to the authors of the pieces of code that this package is made from.
+A router plugin for the Hono http server based on `@bracketed/hono-router`.
 
-<h2>What is this?</h2>
-
-\- A Logger package built from [@sapphire/framework](https://www.npmjs.com/package/@sapphire/framework) & [@sapphire/plugin-logger](https://www.npmjs.com/package/@sapphire/plugin-logger) that uses [colorette](https://www.npmjs.com/package/colorette) for styling.
+This package functions pretty much the same, but with minor changes and full Typescript support.
 
 <h2>Summary (Directory)</h2>
 
--   [Installation](#Installation)
+- [Installation](#Installation)
       <!--truncate-->
-    -   [Yarn](#YarnInstall)
-    -   [Npm](#NpmInstall)
--   [Usage](#Usage)
--   [Contribution](#Contribution)
--   [ChangeLog](#versionlog)
+    - [Yarn](#YarnInstall)
+    - [Npm](#NpmInstall)
+- [Usage](#Usage)
+- [Contribution](#Contribution)
 
 <h2 id="Installation">Installation</h2>
 
@@ -31,43 +27,177 @@ Install via `yarn` or `npm`:
 <p id="YarnInstall">Yarn:</p>
 
 ```sh
-yarn add @bracketed/logger
+yarn add @bracketed/hono-router
 ```
 
 <p id="NpmInstall">Npm:</p>
 
 ```sh
-npm install --save @bracketed/logger
+npm install --save @bracketed/hono-router
 ```
 
 <h2 id="Usage">Usage</h2>
 
-```ts
-// ESM
-import { Logger, LogLevel } from '@bracketed/logger';
-const console = new Logger();
-
-console.info('Hello World!');
-console.debug('Hello World!');
-console.warn('Hello World!');
-console.error('Hello World!');
-console.fatal('Hello World!');
-console.trace('Hello World!');
-console.write(LogLevel.Info, 'Hello World!');
+1. Configure the plugin with Rollup
+2. Create the routes directory with the desired routes
+3. Import the route directory into your code
+
+The examples directory of the repo contains a NodeJS and a Cloudflare Workers
+example that can be run, and a Bruno collection for each of the routes.
+
+### Importing in Code
+
+Importing with the `@routes/` prefix on the directory to import will have
+the plugin create a hono router from the routes in the directory. Normal import
+resolution rules apply to the location (relative vs absolute file paths).
+
+```js
+import router from "@routes/./routes"
+```
+
+### Rollup Config
+
+```js
+import honoRouter from "@bracketed/hono-router"
+
+export default {
+    input: "main.js",
+    output: {
+        file: "your-output-file",
+        format: "esm"
+    },
+    plugins: [
+        honoRouter({
+            debug: true
+        })
+    ]
+}
+```
+
+If `debug` is `true` the library will console.log information on what routes
+are being imported and setup when the script begins.
+
+### File Routes
+
+There are 4 route types that can be defined by the files and their locations.
+An example of the order these run is provided after all the descriptions.
+
+In order for a file to register a route action, it needs to export variables
+named `$<method>` and / or `$any`. Specific methods will always match before
+`$any` handlers (ex: if `$get` matches, `$any` in the same file won't).
+
+The exported value for any handlers should be either a function, or an array of
+functions that are used as [Hono routing](https://hono.dev/docs/api/routing)
+functions. If the exported value is an array, all the handlers are added for the
+same route/verb in the order they appear in the array. Additionally, if any of
+them in the list returns it will make the route return and not go to subsequent
+handlers, just like
+[middleware in Hono](https://hono.dev/docs/guides/middleware).
+
+> The library doesn't modify how any of the
+> [Hono context](https://hono.dev/docs/api/context) functions work, it just
+> makes it easier to setup routes based on file paths, so all context functions
+> are available as-is per the Hono docs.
+
+#### Middleware
+
+Middleware Routes are files named `+Middleware.ts` in a folder. Middleware runs
+before any routes in a folder, in a top down fashion (examples later).
+
+#### Wildcard Routes
+
+Wildcard routes match any route not defined in a directory and are defined by
+naming a file as `[[<name>]].ts`.
+
+#### Parameter Routes
+
+Parameter routes are routes that have parameters in them and are defined by
+naming a file or folder as `[<param name>]`. Any valid part of a path can match
+against a parameter, and more than one parameter can exist on a route.
+
+### Static routes
+
+Any route that isn't formatted as one of the previous types will be
+treated as a static route. The files and directories don't have any special
+syntax required (other than being `.js` or `.ts` files).
+
+### Routing Example
+
 ```
+routes/
+├─ dir/
+│  ├─ +Middleware.ts
+│  ├─ static.ts
+│  ├─ [[nested-wildcard]].ts
+├─ user/
+│  ├─ _middleware.ts
+│  ├─ logout.ts
+│  ├─ [userID].ts
+├─ [param1]/
+│  ├─ [param2]/
+│  │  ├─ thing.ts
+│  ├─ [file-param].ts
+├─ _middleware.ts
+├─ [[no-route]].ts
+```
+
+This set of files will generate the following Hono routes:
 
-```ts
-// CJS
-const { Logger, LogLevel } = require('@bracketed/logger');
-const console = new Logger();
-
-console.info('Hello World!');
-console.debug('Hello World!');
-console.warn('Hello World!');
-console.error('Hello World!');
-console.fatal('Hello World!');
-console.trace('Hello World!');
-console.write(LogLevel.Info, 'Hello World!');
+```
+/dir/static
+/dir/*
+/user/logout
+/user/:userID
+/:param1/:file-param
+/:param1/:param2/thing
+/*
+```
+
+Routes are added to Hono in such a way that the resolution order is
+always the same:
+
+1. static routes
+2. parameterized routes
+3. wildcards
+
+### Routing Resolution
+
+Using the previous set of routes, this is what the execution will look
+like given some example requests.
+
+```
+/dir/static
+-> run /+middleware.js
+-> run /dir/+middleware.js
+-> match /dir/static.js
+
+/dir/random-thing
+-> run /+middleware.js
+-> run /dir/+middleware.js
+-> match /dir/[[nested-wildcard]].js
+
+/user/logout
+-> run /+middleware.js
+-> run /user/+middleware.js
+-> match /user/logout.js
+
+/user/id-123
+-> run /+middleware.js
+-> run /user/+middleware.js
+-> match /user/[userID].js
+
+/user/not/valid
+-> run /+middleware.js
+-> run /user/+middleware.js
+-> match /[[no-route]].js
+
+/first/second/thing
+-> run /+middleware.js
+-> match /[param1]/[param2]/thing.js
+
+/first/second
+-> run /+middleware.js
+-> match /[param1]/[file-param].js
 ```
 
 <h1 id="Contribution">Contribution & Help</h1>

package/lib/cjs/base.cjs

@@ -2,19 +2,21 @@
 import { Hono } from "hono"
 
 const optlog = (...args) => {
-    if (options.debug !== true) return
+    if (options.debug !== true) {
+        return
+    }
     console.log(...args)
 }
 
 const app = new Hono()
 const verbs = [
-    "+GET",
-    "+POST",
-    "+PATCH",
-    "+PUT",
-    "+DELETE",
-    "+OPTIONS",
-    "+HEAD",
+    "$get",
+    "$post",
+    "$patch",
+    "$put",
+    "$delete",
+    "$options",
+    "$head",
 ]
 const addRoute = (pattern, module, routeType) => {
     for (const verb of verbs) {
@@ -22,14 +24,18 @@ const addRoute = (pattern, module, routeType) => {
         if (handler !== undefined) {
             const handlerList = Array.isArray(handler) ? handler : [handler]
             optlog("add", { pattern, verb, routeType, count: handlerList.length })
-            for (const handler of handlerList) app.on(verb.slice(1), pattern, handler)
+            for (const handler of handlerList) {
+                app.on(verb.slice(1), pattern, handler)
+            }
         }
     }
-
-    if (module.$any === undefined) return
-    
+    if (module.$any === undefined) {
+        return
+    }
     const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]
     optlog("add", { pattern, verb: "any", routeType, count: handlerList.length })
-    for (const handler of handlerList) app.use(pattern, handler)
+    for (const handler of handlerList) {
+        app.use(pattern, handler)
+    }
 }`;exports.base=e;//# sourceMappingURL=base.cjs.map
 //# sourceMappingURL=base.cjs.map

package/lib/cjs/base.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/base.ts"],"names":["base"],"mappings":"6CAAA,IAAMA,CAAAA,CAAO","file":"base.cjs","sourcesContent":["const base = `\r\nimport { Hono } from \"hono\"\r\n\r\nconst optlog = (...args) => {\r\n    if (options.debug !== true) return\r\n    console.log(...args)\r\n}\r\n\r\nconst app = new Hono()\r\nconst verbs = [\r\n    \"+GET\",\r\n    \"+POST\",\r\n    \"+PATCH\",\r\n    \"+PUT\",\r\n    \"+DELETE\",\r\n    \"+OPTIONS\",\r\n    \"+HEAD\",\r\n]\r\nconst addRoute = (pattern, module, routeType) => {\r\n    for (const verb of verbs) {\r\n        const handler = module[verb]\r\n        if (handler !== undefined) {\r\n            const handlerList = Array.isArray(handler) ? handler : [handler]\r\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\r\n            for (const handler of handlerList) app.on(verb.slice(1), pattern, handler)\r\n        }\r\n    }\r\n\r\n    if (module.$any === undefined) return\r\n    \r\n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\r\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\r\n    for (const handler of handlerList) app.use(pattern, handler)\r\n}`;\r\n\r\nexport { base };\r\n"]}
+{"version":3,"sources":["../../src/base.ts"],"names":["base"],"mappings":"6CAAA,IAAMA,CAAAA,CAAO","file":"base.cjs","sourcesContent":["const base = `\r\nimport { Hono } from \"hono\"\r\n\r\nconst optlog = (...args) => {\r\n    if (options.debug !== true) {\r\n        return\r\n    }\r\n    console.log(...args)\r\n}\r\n\r\nconst app = new Hono()\r\nconst verbs = [\r\n    \"$get\",\r\n    \"$post\",\r\n    \"$patch\",\r\n    \"$put\",\r\n    \"$delete\",\r\n    \"$options\",\r\n    \"$head\",\r\n]\r\nconst addRoute = (pattern, module, routeType) => {\r\n    for (const verb of verbs) {\r\n        const handler = module[verb]\r\n        if (handler !== undefined) {\r\n            const handlerList = Array.isArray(handler) ? handler : [handler]\r\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\r\n            for (const handler of handlerList) {\r\n                app.on(verb.slice(1), pattern, handler)\r\n            }\r\n        }\r\n    }\r\n    if (module.$any === undefined) {\r\n        return\r\n    }\r\n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\r\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\r\n    for (const handler of handlerList) {\r\n        app.use(pattern, handler)\r\n    }\r\n}`;\r\n\r\nexport { base };\r\n"]}

package/lib/cjs/base.d.ts

@@ -1,3 +1,3 @@
-declare const base = "\nimport { Hono } from \"hono\"\n\nconst optlog = (...args) => {\n    if (options.debug !== true) return\n    console.log(...args)\n}\n\nconst app = new Hono()\nconst verbs = [\n    \"+GET\",\n    \"+POST\",\n    \"+PATCH\",\n    \"+PUT\",\n    \"+DELETE\",\n    \"+OPTIONS\",\n    \"+HEAD\",\n]\nconst addRoute = (pattern, module, routeType) => {\n    for (const verb of verbs) {\n        const handler = module[verb]\n        if (handler !== undefined) {\n            const handlerList = Array.isArray(handler) ? handler : [handler]\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\n            for (const handler of handlerList) app.on(verb.slice(1), pattern, handler)\n        }\n    }\n\n    if (module.$any === undefined) return\n    \n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\n    for (const handler of handlerList) app.use(pattern, handler)\n}";
+declare const base = "\nimport { Hono } from \"hono\"\n\nconst optlog = (...args) => {\n    if (options.debug !== true) {\n        return\n    }\n    console.log(...args)\n}\n\nconst app = new Hono()\nconst verbs = [\n    \"$get\",\n    \"$post\",\n    \"$patch\",\n    \"$put\",\n    \"$delete\",\n    \"$options\",\n    \"$head\",\n]\nconst addRoute = (pattern, module, routeType) => {\n    for (const verb of verbs) {\n        const handler = module[verb]\n        if (handler !== undefined) {\n            const handlerList = Array.isArray(handler) ? handler : [handler]\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\n            for (const handler of handlerList) {\n                app.on(verb.slice(1), pattern, handler)\n            }\n        }\n    }\n    if (module.$any === undefined) {\n        return\n    }\n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\n    for (const handler of handlerList) {\n        app.use(pattern, handler)\n    }\n}";
 
 export { base };

package/lib/esm/base.d.mts

@@ -1,3 +1,3 @@
-declare const base = "\nimport { Hono } from \"hono\"\n\nconst optlog = (...args) => {\n    if (options.debug !== true) return\n    console.log(...args)\n}\n\nconst app = new Hono()\nconst verbs = [\n    \"+GET\",\n    \"+POST\",\n    \"+PATCH\",\n    \"+PUT\",\n    \"+DELETE\",\n    \"+OPTIONS\",\n    \"+HEAD\",\n]\nconst addRoute = (pattern, module, routeType) => {\n    for (const verb of verbs) {\n        const handler = module[verb]\n        if (handler !== undefined) {\n            const handlerList = Array.isArray(handler) ? handler : [handler]\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\n            for (const handler of handlerList) app.on(verb.slice(1), pattern, handler)\n        }\n    }\n\n    if (module.$any === undefined) return\n    \n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\n    for (const handler of handlerList) app.use(pattern, handler)\n}";
+declare const base = "\nimport { Hono } from \"hono\"\n\nconst optlog = (...args) => {\n    if (options.debug !== true) {\n        return\n    }\n    console.log(...args)\n}\n\nconst app = new Hono()\nconst verbs = [\n    \"$get\",\n    \"$post\",\n    \"$patch\",\n    \"$put\",\n    \"$delete\",\n    \"$options\",\n    \"$head\",\n]\nconst addRoute = (pattern, module, routeType) => {\n    for (const verb of verbs) {\n        const handler = module[verb]\n        if (handler !== undefined) {\n            const handlerList = Array.isArray(handler) ? handler : [handler]\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\n            for (const handler of handlerList) {\n                app.on(verb.slice(1), pattern, handler)\n            }\n        }\n    }\n    if (module.$any === undefined) {\n        return\n    }\n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\n    for (const handler of handlerList) {\n        app.use(pattern, handler)\n    }\n}";
 
 export { base };

package/lib/esm/base.mjs

@@ -2,19 +2,21 @@ import'./chunk-QWPVIX2T.mjs';var e=`
 import { Hono } from "hono"
 
 const optlog = (...args) => {
-    if (options.debug !== true) return
+    if (options.debug !== true) {
+        return
+    }
     console.log(...args)
 }
 
 const app = new Hono()
 const verbs = [
-    "+GET",
-    "+POST",
-    "+PATCH",
-    "+PUT",
-    "+DELETE",
-    "+OPTIONS",
-    "+HEAD",
+    "$get",
+    "$post",
+    "$patch",
+    "$put",
+    "$delete",
+    "$options",
+    "$head",
 ]
 const addRoute = (pattern, module, routeType) => {
     for (const verb of verbs) {
@@ -22,14 +24,18 @@ const addRoute = (pattern, module, routeType) => {
         if (handler !== undefined) {
             const handlerList = Array.isArray(handler) ? handler : [handler]
             optlog("add", { pattern, verb, routeType, count: handlerList.length })
-            for (const handler of handlerList) app.on(verb.slice(1), pattern, handler)
+            for (const handler of handlerList) {
+                app.on(verb.slice(1), pattern, handler)
+            }
         }
     }
-
-    if (module.$any === undefined) return
-    
+    if (module.$any === undefined) {
+        return
+    }
     const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]
     optlog("add", { pattern, verb: "any", routeType, count: handlerList.length })
-    for (const handler of handlerList) app.use(pattern, handler)
+    for (const handler of handlerList) {
+        app.use(pattern, handler)
+    }
 }`;export{e as base};//# sourceMappingURL=base.mjs.map
 //# sourceMappingURL=base.mjs.map

package/lib/esm/base.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/base.ts"],"names":["base"],"mappings":"6BAAA,IAAMA,CAAAA,CAAO","file":"base.mjs","sourcesContent":["const base = `\r\nimport { Hono } from \"hono\"\r\n\r\nconst optlog = (...args) => {\r\n    if (options.debug !== true) return\r\n    console.log(...args)\r\n}\r\n\r\nconst app = new Hono()\r\nconst verbs = [\r\n    \"+GET\",\r\n    \"+POST\",\r\n    \"+PATCH\",\r\n    \"+PUT\",\r\n    \"+DELETE\",\r\n    \"+OPTIONS\",\r\n    \"+HEAD\",\r\n]\r\nconst addRoute = (pattern, module, routeType) => {\r\n    for (const verb of verbs) {\r\n        const handler = module[verb]\r\n        if (handler !== undefined) {\r\n            const handlerList = Array.isArray(handler) ? handler : [handler]\r\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\r\n            for (const handler of handlerList) app.on(verb.slice(1), pattern, handler)\r\n        }\r\n    }\r\n\r\n    if (module.$any === undefined) return\r\n    \r\n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\r\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\r\n    for (const handler of handlerList) app.use(pattern, handler)\r\n}`;\r\n\r\nexport { base };\r\n"]}
+{"version":3,"sources":["../../src/base.ts"],"names":["base"],"mappings":"6BAAA,IAAMA,CAAAA,CAAO","file":"base.mjs","sourcesContent":["const base = `\r\nimport { Hono } from \"hono\"\r\n\r\nconst optlog = (...args) => {\r\n    if (options.debug !== true) {\r\n        return\r\n    }\r\n    console.log(...args)\r\n}\r\n\r\nconst app = new Hono()\r\nconst verbs = [\r\n    \"$get\",\r\n    \"$post\",\r\n    \"$patch\",\r\n    \"$put\",\r\n    \"$delete\",\r\n    \"$options\",\r\n    \"$head\",\r\n]\r\nconst addRoute = (pattern, module, routeType) => {\r\n    for (const verb of verbs) {\r\n        const handler = module[verb]\r\n        if (handler !== undefined) {\r\n            const handlerList = Array.isArray(handler) ? handler : [handler]\r\n            optlog(\"add\", { pattern, verb, routeType, count: handlerList.length })\r\n            for (const handler of handlerList) {\r\n                app.on(verb.slice(1), pattern, handler)\r\n            }\r\n        }\r\n    }\r\n    if (module.$any === undefined) {\r\n        return\r\n    }\r\n    const handlerList = Array.isArray(module.$any) ? module.$any : [module.$any]\r\n    optlog(\"add\", { pattern, verb: \"any\", routeType, count: handlerList.length })\r\n    for (const handler of handlerList) {\r\n        app.use(pattern, handler)\r\n    }\r\n}`;\r\n\r\nexport { base };\r\n"]}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@bracketed/hono-router",
   "description": "A typed CF worker compatible hono file system router based on the hono router by @axel669.",
   "packageManager": "yarn@4.9.2",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "publishConfig": {
     "access": "public"
   },