@mapl/router 0.0.1

package/README.md

@@ -0,0 +1,60 @@
+# `@mapl/router`
+
+A fast compiled radix tree router.
+
+```ts
+import {
+  PARAMS,
+  PATHNAME,
+  PATHNAME_LEN,
+  compileNode,
+  type RouterCompilerState,
+} from "@mapl/router/tree/compiler";
+import { createNode, insertItem } from "@mapl/router/tree/node";
+import { getExternalKeys, getContent } from "@mapl/compiler";
+
+// Initialize the root node
+const root = createNode("/");
+
+// Add some routes
+insertItem(root, "/", 0);
+insertItem(root, "/user/*", 1);
+insertItem(root, "/**", 2);
+
+// Initialize the compiler state
+const state: RouterCompilerState<any> = {
+  contentBuilder: [],
+  declarationBuilders: [],
+  localVarCount: 0,
+  externalValues: [],
+
+  // Same args as compileNode except the first one
+  compileItem: (item, state) => {
+    state.contentBuilder.push(`return f${state.externalValues.length};`);
+    state.externalValues.push(item);
+  },
+};
+
+// Compile from root node
+compileNode(root, state, false, false, 0, "");
+
+// Create the match function using the result state
+const match = Function(
+  ...getExternalKeys(state),
+  `return (${PATHNAME},${PARAMS})=>{const ${PATHNAME_LEN}=${PATHNAME}.length;${getContent(state)}}`,
+)(...state.externalValues);
+
+// Example usage
+const res0 = match("/", []);
+res0; // 0
+
+const params1 = [];
+const res1 = match("/user/0", params1);
+params1; // ['0']
+res1; // 1
+
+const params2 = [];
+const res2 = match("/navigate/to/about", params2);
+params2; // ['navigate/to/about']
+res2; // 2
+```

package/index.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@mapl/router",
+  "version": "0.0.1",
+  "description": "Fast compiled router for all runtimes",
+  "keywords": [
+    "fast",
+    "compiled",
+    "router",
+    "node",
+    "bun",
+    "deno"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "scripts": {
+    "build:test": "bun scripts/build.ts && bun test",
+    "build:bench": "bun build:test && bun scripts/bench.ts",
+    "build:publish": "bun build:test && bun scripts/publish.ts",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "latest",
+    "eslint": "latest",
+    "typescript-eslint": "latest",
+    "eslint-plugin-jsdoc": "latest",
+    "@types/bun": "latest",
+    "mitata": "latest",
+    "typescript": "latest"
+  },
+  "dependencies": {
+    "@mapl/compiler": "^0.0.2"
+  }
+}

package/tree/compiler.d.ts

@@ -0,0 +1,13 @@
+import type { Node } from './node';
+import type { CompilerState } from '@mapl/compiler';
+type ParametersExcludeState<T> = T extends (arg0: any, arg1: any, ...rest: infer R) => any ? R : never;
+export interface RouterCompilerState<Item> extends CompilerState {
+    compileItem: (item: Item, state: this, ...args: ParametersExcludeState<typeof compileNode>) => void;
+}
+export declare const PATHNAME = "__req_p";
+export declare const PATHNAME_LEN = "__req_pl";
+export declare const PARAMS = "__req_ps";
+export declare const PREV_PARAM_INDEX = "__req_ppi";
+export declare const CURRENT_PARAM_INDEX = "__req_cpi";
+export declare function compileNode(node: Node, state: RouterCompilerState<any>, hasParam: boolean, hasMultipleParams: boolean, startIndexValue: number, startIndexPrefix: string): void;
+export {};

package/tree/compiler.js

@@ -0,0 +1 @@
+export function compileNode(node,state,hasParam,hasMultipleParams,startIndexValue,startIndexPrefix){const builder=state.contentBuilder;const part=node[0];const partLen=part.length;startIndexValue++;if(partLen!==1){builder.push(`if(__req_pl>${startIndexPrefix}${startIndexValue+partLen-2})`);for(let i=1;i<partLen;i++,startIndexValue++)builder.push(`if(__req_p.charCodeAt(${startIndexPrefix}${startIndexValue})===${part.charCodeAt(i)})`);builder.push("{")}if(node[1]!==null){builder.push(`if(__req_pl===${startIndexPrefix}${startIndexValue}){`);state.compileItem(node[1],state,hasParam,hasMultipleParams,startIndexValue,startIndexPrefix);builder.push("}")}if(node[2]!==null){const children=node[2];const childrenKeys=Object.keys(children);if(childrenKeys.length===1){builder.push(`if(__req_p.charCodeAt(${startIndexPrefix}${startIndexValue})===${childrenKeys[0]}){`);compileNode(children[childrenKeys[0]],state,hasParam,hasMultipleParams,startIndexValue,startIndexPrefix);builder.push("}")}else{builder.push(`switch(__req_p.charCodeAt(${startIndexPrefix}${startIndexValue})){`);for(let i=0,l=childrenKeys.length;i<l;i++){builder.push(`case ${childrenKeys[i]}:`);compileNode(children[childrenKeys[i]],state,hasParam,hasMultipleParams,startIndexValue,startIndexPrefix);builder.push("break;")}builder.push("}")}}if(node[3]!==null){const params=node[3];const hasStore=params[1]!==null;const hasChild=params[0]!==null;const requireAllocation=hasParam?hasMultipleParams:hasChild||!hasStore;if(requireAllocation)builder.push("{");if(hasParam)builder.push(`${hasMultipleParams?"":"let "}__req_ppi=${startIndexPrefix}${startIndexValue};`);const currentIndex=hasParam?"__req_ppi":`${startIndexPrefix}${startIndexValue}`;const slashIndex=`__req_p.indexOf('/',${currentIndex})`;if(hasChild||!hasStore)builder.push(`${hasParam?"":"let "}__req_cpi=${slashIndex};`);if(hasStore){builder.push(`if(${hasChild?"__req_cpi":slashIndex}===-1){__req_ps.push(__req_p.slice(${currentIndex}));`);state.compileItem(params[1],state,true,hasParam,startIndexValue,startIndexPrefix);builder.push("}")}if(hasChild){builder.push(`if(${hasStore?"":"__req_cpi!==-1&&"}__req_cpi!==${currentIndex}){__req_ps.push(__req_p.substring(${currentIndex},__req_cpi));`);compileNode(params[0],state,true,hasParam,0,"__req_cpi+");builder.push("__req_ps.pop();}")}if(requireAllocation)builder.push("}")}if(node[4]!==null){const noStore=node[1]===null;if(noStore)builder.push(`if(__req_pl!==${startIndexPrefix}${startIndexValue}){`);builder.push(`__req_ps.push(__req_p.slice(${startIndexPrefix}${startIndexValue}));`);state.compileItem(node[4],state,hasParam,hasMultipleParams,startIndexValue,startIndexPrefix);if(noStore)builder.push("}")}if(partLen!==1)builder.push("}")}export const PATHNAME="__req_p";export const PATHNAME_LEN="__req_pl";export const PARAMS="__req_ps";export const PREV_PARAM_INDEX="__req_ppi";export const CURRENT_PARAM_INDEX="__req_cpi";

package/tree/matcher.d.ts

@@ -0,0 +1,2 @@
+import type { Node } from './node';
+export declare function matchItem(node: Node, path: string, params: string[], startIdx: number): unknown;

package/tree/matcher.js

@@ -0,0 +1 @@
+export function matchItem(node,path,params,startIdx){const part=node[0];const pathPartLen=part.length;const pathLen=path.length;if(pathPartLen>1){if(startIdx+pathPartLen>pathLen)return null;startIdx++;for(let i=1;i<pathPartLen;i++,startIdx++){if(part.charCodeAt(i)!==path.charCodeAt(startIdx))return null}}else startIdx++;if(startIdx===pathLen)return node[1];if(node[2]!==null){const child=node[2][path.charCodeAt(startIdx)];if(typeof child!=="undefined"){const matchResult=matchItem(child,path,params,startIdx);if(matchResult!==null)return matchResult}}if(node[3]!==null){const paramsNode=node[3];const slashIdx=path.indexOf("/",startIdx);if(slashIdx===-1){if(paramsNode[1]!==null){params.push(path.slice(startIdx));return paramsNode[1]}}else if(slashIdx!==startIdx&&paramsNode[0]!==null){params.push(path.substring(startIdx,slashIdx));const matchResult=matchItem(paramsNode[0],path,params,slashIdx);if(matchResult!==null)return matchResult;params.pop()}}if(node[4]!==null){params.push(path.slice(startIdx));return node[4]}return null}

package/tree/node.d.ts

@@ -0,0 +1,17 @@
+export type Node = [
+    part: string,
+    store: any,
+    children: Record<number, Node> | null,
+    params: ParamNode | null,
+    wildcardStore: unknown
+];
+export type ParamNode = [
+    child: Node | null,
+    store: unknown
+];
+export declare function createNode(part: string): Node;
+export declare function createParamNode(node: Node, nextNode: ParamNode[0]): ParamNode;
+export declare function cloneNode(node: Node, part: string): Node;
+export declare function resetNode(node: Node, part: string, children: Node[2]): void;
+export declare function visitNode(node: Node, path: string): Node;
+export declare function insertItem(node: Node, path: string, item: unknown): void;

package/tree/node.js

@@ -0,0 +1 @@
+export function createNode(part){return[part,null,null,null,null]}export function createParamNode(node,nextNode){return node[3]=[nextNode,null]}export function cloneNode(node,part){return[part,node[1],node[2],node[3],node[4]]}export function resetNode(node,part,children){node[0]=part;node[2]=children;node[1]=null;node[3]=null;node[4]=null}export function visitNode(node,path){const parts=path.split("*");for(let i=0,{length}=parts;i<length;++i){if(i!==0){if(node[3]===null){const nextNode=createNode(parts[i]);createParamNode(node,nextNode);node=nextNode}else node=node[3][0]??=createNode(parts[i])}for(let j=0,pathPart=parts[i];;++j){const nodePart=node[0];if(j===pathPart.length){if(j<nodePart.length){const children={};children[nodePart.charCodeAt(j)]=cloneNode(node,nodePart.slice(j));resetNode(node,pathPart,children)}break}if(j===nodePart.length){if(node[2]===null)node[2]={};else{const nextNode=node[2][pathPart.charCodeAt(j)];if(typeof nextNode!=="undefined"){node=nextNode;pathPart=pathPart.slice(j);j=0;continue}}const nextNode=createNode(pathPart.slice(j));node[2][pathPart.charCodeAt(j)]=nextNode;node=nextNode;break}if(pathPart.charCodeAt(j)!==nodePart.charCodeAt(j)){const children={};children[nodePart.charCodeAt(j)]=cloneNode(node,nodePart.slice(j));const nextNode=createNode(pathPart.slice(j));children[pathPart.charCodeAt(j)]=createNode(pathPart.slice(j));resetNode(node,nodePart.substring(0,j),children);node=nextNode;break}}}return node}export function insertItem(node,path,item){if(path.charCodeAt(path.length-1)===42){if(path.charCodeAt(path.length-2)===42)visitNode(node,path.substring(0,path.length-2))[4]=item;else createParamNode(visitNode(node,path.substring(0,path.length-1)),null)[1]=item}else visitNode(node,path)[1]=item}