@spirobel/mininext 0.3.9 → 0.4.1

package/dist/url.d.ts

@@ -45,6 +45,8 @@ export declare class Mini<X = unknown> {
     params: URLSearchParams;
     form: Form;
     requrl: Readonly<URL>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static) */
+    redirect: (url: string | URL, status?: number) => void;
     constructor(mini: Mini<unknown>, data: X);
 }
 /**
@@ -185,12 +187,21 @@ export declare class url {
     static link<X>(Url: string, qs?: string[] | string, settings?: LinkSettings): (mini: Mini<X>) => string;
     static currylink(Url: string, qs: string[] | string, req: Request, settings?: LinkSettings): string;
     /**
-     * This method retrieves a url from the urls array. If the url does not exist in the urls array, an error will be thrown.
+     * users expect links to work with or without a trailing slash.
+     * Developers expect that that links work with or without a preceding slash.
+     * We make sure that these expectations are met when using url.set and url.get.
+     * (by adding all the variations to the url.direct_handlers Map)
+     * @param {string} inputString - the url
+     * @returns {string[]} - returns array of variations (added slash in the beginning, added, removed slash at the end)
+     */
+    static generateVariations(inputString: string): string[];
+    /**
+     * This method retrieves a url from the urls array. If the url does not exist in the urls array, null will be returned.
      * @param {string} Url - The url to retrieve.
      * @return {string} - The retrieved url.
      * @throws Will throw an Error if the provided url is not found in the urls array.
      */
-    static get(Url: string): string;
+    static get(Url: string): string | null;
     static match(req: Request, reqPath?: string): Promise<Response | undefined>;
     /**
      * user this to set the Websocket object. Check out [the bun docs](https://bun.sh/docs/api/websockets) for more details.

package/dist/url.js

@@ -21,6 +21,8 @@ export class Mini {
     params;
     form;
     requrl;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirect_static) */
+    redirect;
     constructor(mini, data) {
         Object.assign(this, mini);
         this.html = (html);
@@ -50,7 +52,7 @@ export class url {
     static websocket = undefined;
     static server;
     // direct mapping of "url string" -> function leads to Html Response
-    static direct_handlers_html;
+    static direct_handlers_html = new Map();
     // An array of the uncompiled frontend files, example frontends[0] = "index.tsx" -> frontend/index.tsx (from the project root)
     static frontends = [];
     static svgs = new Map();
@@ -173,16 +175,18 @@ export class url {
         };
     }
     static set(entries, handler) {
-        if (typeof entries === "string" && handler) {
-            if (url.direct_handlers_html) {
-                url.direct_handlers_html.set(entries, handler);
-            }
-            else {
-                url.direct_handlers_html = new Map([[entries, handler]]);
+        function addUrl(entryUrl, entryHandler) {
+            for (const u of url.generateVariations(entryUrl)) {
+                url.direct_handlers_html.set(u, entryHandler);
             }
         }
+        if (typeof entries === "string" && handler) {
+            addUrl(entries, handler);
+        }
         if (typeof entries !== "string")
-            url.direct_handlers_html = new Map(entries);
+            for (const [entryUrl, entryHandler] of entries) {
+                addUrl(entryUrl, entryHandler);
+            }
     }
     /**
      * wrap your handlers in this if you mutate something to prevent CSRF issues.
@@ -278,7 +282,7 @@ export class url {
         // Create a new URL object from the current location
         // https://github.com/whatwg/url/issues/531#issuecomment-1337050285
         const GOOFY_HACK = "http://goofyhack.com";
-        const updatedUrl = new URL(url.get(Url), GOOFY_HACK);
+        const updatedUrl = new URL(url.get(Url) || "/url_not_found_error", GOOFY_HACK);
         for (const q of qs) {
             // Use URLSearchParams to set the name query parameter
             const reqParam = new URL(req.url).searchParams.get(q);
@@ -296,15 +300,47 @@ export class url {
         return updatedUrl.toString().slice(GOOFY_HACK.length);
     }
     /**
-     * This method retrieves a url from the urls array. If the url does not exist in the urls array, an error will be thrown.
+     * users expect links to work with or without a trailing slash.
+     * Developers expect that that links work with or without a preceding slash.
+     * We make sure that these expectations are met when using url.set and url.get.
+     * (by adding all the variations to the url.direct_handlers Map)
+     * @param {string} inputString - the url
+     * @returns {string[]} - returns array of variations (added slash in the beginning, added, removed slash at the end)
+     */
+    static generateVariations(inputString) {
+        const variations = [];
+        // Special case for the index route
+        if (inputString === "/") {
+            variations.push("/");
+            return variations;
+        }
+        // Check if the string starts with a slash and add/remove variations accordingly
+        if (inputString.startsWith("/")) {
+            variations.push(inputString); // With leading slash
+        }
+        else {
+            inputString = "/" + inputString;
+            variations.push(inputString); // With leading slash
+        }
+        // Check if the string ends with a slash and add/remove variations accordingly
+        if (inputString.endsWith("/")) {
+            variations.push(inputString.slice(0, -1)); // Without trailing slash
+        }
+        else {
+            variations.push(inputString + "/"); // With trailing slash
+        }
+        return variations;
+    }
+    /**
+     * This method retrieves a url from the urls array. If the url does not exist in the urls array, null will be returned.
      * @param {string} Url - The url to retrieve.
      * @return {string} - The retrieved url.
      * @throws Will throw an Error if the provided url is not found in the urls array.
      */
     static get(Url) {
-        const foundUrl = url.direct_handlers_html.get(Url);
+        const foundUrl = url.direct_handlers_html.get(url.generateVariations(Url)[0]);
         if (!foundUrl) {
-            throw new Error(`URL "${html `${Url}`}" was not set.`);
+            return null;
         }
         return Url;
     }
@@ -315,7 +351,8 @@ export class url {
         }
         const handler = url.direct_handlers_html.get(reqPath);
         if (handler) {
-            //this is the source of mini
+            let redirectTarget = null;
+            let redirectStatus = undefined;
             let handlerHead = undefined;
             let handlerOptions = {
                 headers: {
@@ -340,6 +377,7 @@ export class url {
             if (post && (urlencoded || multipart)) {
                 formData = await req.formData();
             }
+            //this is the source of mini
             const mini = new Mini({
                 requrl: miniurl,
                 data: undefined,
@@ -381,8 +419,15 @@ export class url {
                 options: (options) => {
                     handlerOptions = options;
                 },
+                redirect: (url, status) => {
+                    redirectTarget = url;
+                    redirectStatus = status;
+                },
             }, undefined);
             const unresolved = await handler(mini); //passing mini
+            if (redirectTarget) {
+                return Response.redirect(redirectTarget, redirectStatus);
+            }
             return htmlResponder(mini, unresolved, handlerHead, handlerOptions);
         }
     }
@@ -421,10 +466,6 @@ export class url {
                 return res;
             //handle svg file serving
             res = url.serveSvg(req);
-            if (res)
-                return res;
-            // go through all the Htmlhandlers again with added slash at the end.
-            res = await url.match(req, new URL(req.url).pathname + "/");
             if (res)
                 return res;
             return new Response("No matching url found", { status: 404 });

package/package.json

@@ -11,7 +11,7 @@
     "clean":"rm -rf ./dist"
   },
   "files": ["dist"],
-  "version": "0.3.9",
+  "version": "0.4.1",
   "devDependencies": {
     "@types/bun": "latest"
   },