@spirobel/mininext 0.4.1 → 0.4.3

package/dist/mininext.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="bun-types" />
 /// <reference types="bun-types" />
-import { url, Mini, type HtmlHandler } from "./url";
+import { url, Mini, has, type HtmlHandler } from "./url";
 import { isError, HtmlString, BasedHtml, head, commonHead, cssReset, basedHtml as html } from "./html";
 import type { Server, WebSocketHandler } from "bun";
 declare global {
@@ -12,4 +12,4 @@ declare function makeEntrypoint(): Promise<{
     fetch: (req: Request, server: Server) => Promise<Response>;
     websocket: WebSocketHandler;
 }>;
-export { html, url, head, build, makeEntrypoint, isError, BasedHtml, HtmlString, type HtmlHandler, Mini, standardDevReloader, commonHead, cssReset, };
+export { has, html, url, head, build, makeEntrypoint, isError, BasedHtml, HtmlString, type HtmlHandler, Mini, standardDevReloader, commonHead, cssReset, };

package/dist/mininext.js

@@ -1,4 +1,4 @@
-import { url, Mini } from "./url";
+import { url, Mini, has } from "./url";
 import { isError, HtmlString, BasedHtml, head, commonHead, cssReset, basedHtml as html, } from "./html";
 import { watch } from "fs/promises";
 import * as path from "path";
@@ -182,4 +182,4 @@ async function makeEntrypoint() {
     }
     return module.default();
 }
-export { html, url, head, build, makeEntrypoint, isError, BasedHtml, HtmlString, Mini, standardDevReloader, commonHead, cssReset, };
+export { has, html, url, head, build, makeEntrypoint, isError, BasedHtml, HtmlString, Mini, standardDevReloader, commonHead, cssReset, };

package/dist/url.d.ts

@@ -3,11 +3,24 @@
 import type { Server, WebSocketHandler } from "bun";
 import { html, json, dangerjson, HtmlString } from "./html";
 import type { BasedHtml, DangerJsonInHtml, JsonString, JsonStringValues } from "./html";
+/**
+ * A helper function that helps narrow unknown objects
+ * @param object - the object of type unknown that is to be narrowed
+ * @param key - the key that may or may not exist in object
+ * @returns true if the key is present and false if not
+ * @example
+ * ``` js
+ * has(this.form.formJson, "formName") &&
+ * this.form.formJson.formName === this.form.formName
+ * ```
+ * https://stackoverflow.com/questions/70028907/narrowing-an-object-of-type-unknown
+ */
+export declare function has<T, K extends string>(object: T, key: K): object is T & object & Record<K, unknown>;
 export type Form = {
     post: boolean;
     urlencoded: boolean;
     multipart: boolean;
-    formJson?: any;
+    formJson?: unknown;
     formData?: FormData;
     formName?: string;
     hiddenField?: HtmlString;
@@ -152,6 +165,18 @@ export declare class url {
      */
     static set<K extends string>(entries: [K, HtmlHandler][]): void;
     static set(urlPath: string, handler: HtmlHandler): void;
+    /**
+     * use this to remove routes.
+     * @param urlPath - the route to remove
+     * @example
+     * ``` js
+     * let perma_link_defined_by_editor_or_admin_user_that_changed = "/haha"
+     * url.remove(perma_link_defined_by_editor_or_admin_user_that_changed);
+     * // add new url after removing the old one (that might come from a sqlite db)
+     * url.set("/huhu", (mini)=> mini.html`huhu`)
+     * ```
+     */
+    static remove(urlPath: string): void;
     /**
      * wrap your handlers in this if you mutate something to prevent CSRF issues.
      * @param handler - normal html handler with mini as the argument

package/dist/url.js

@@ -1,4 +1,19 @@
 import { htmlResponder, html, json, dangerjson, HtmlString } from "./html";
+/**
+ * A helper function that helps narrow unknown objects
+ * @param object - the object of type unknown that is to be narrowed
+ * @param key - the key that may or may not exist in object
+ * @returns true if the key is present and false if not
+ * @example
+ * ``` js
+ * has(this.form.formJson, "formName") &&
+ * this.form.formJson.formName === this.form.formName
+ * ```
+ * https://stackoverflow.com/questions/70028907/narrowing-an-object-of-type-unknown
+ */
+export function has(object, key) {
+    return typeof object === "object" && object !== null && key in object;
+}
 /**
  * Mini - the data object can be filled with url.data
  * @example
@@ -37,7 +52,7 @@ export class Mini {
                     this.form.formData.get("formName") === this.form.formName) {
                     return cb();
                 }
-                else if (this.form.formJson &&
+                else if (has(this.form.formJson, "formName") &&
                     this.form.formJson.formName === this.form.formName) {
                     return cb();
                 }
@@ -188,6 +203,22 @@ export class url {
                 addUrl(entryUrl, entryHandler);
             }
     }
+    /**
+     * use this to remove routes.
+     * @param urlPath - the route to remove
+     * @example
+     * ``` js
+     * let perma_link_defined_by_editor_or_admin_user_that_changed = "/haha"
+     * url.remove(perma_link_defined_by_editor_or_admin_user_that_changed);
+     * // add new url after removing the old one (that might come from a sqlite db)
+     * url.set("/huhu", (mini)=> mini.html`huhu`)
+     * ```
+     */
+    static remove(urlPath) {
+        for (const u of url.generateVariations(urlPath)) {
+            url.direct_handlers_html.delete(u);
+        }
+    }
     /**
      * wrap your handlers in this if you mutate something to prevent CSRF issues.
      * @param handler - normal html handler with mini as the argument

package/package.json

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