@spirobel/mininext 0.3.0 → 0.3.2

package/dist/html.d.ts

@@ -54,5 +54,20 @@ export declare function isError(submissionResult: any | {
     error: HtmlString;
 };
 declare global {
-    var Reloader: HtmlString | undefined;
+    var Reloader: BasedHtml | HtmlString | undefined;
 }
+/**
+ * The difference between this and HtmlString is that it is fully resolved and only accepts primitive types.
+ * In plain english this means:
+ * It does not accept functions (that will be resolved at request time with (mini)=>mini.html) like mini.html does.
+ */
+export declare class BasedHtml extends String {
+}
+export type BasedHtmlValues = number | string | undefined | null | boolean | BasedHtml | BasedHtml[];
+/**
+ * The difference between this and HtmlString is that it is fully resolved and only accepts primitive types.
+ * @param strings - html literals
+ * @param values - values will get escaped to prevent xss
+ * @returns
+ */
+export declare const basedHtml: (strings: TemplateStringsArray, ...values: BasedHtmlValues[]) => BasedHtml;

package/dist/html.js

@@ -245,3 +245,35 @@ export async function htmlResponder(mini, maybeUnresolved, head = default_head,
 export function isError(submissionResult) {
     return ("error" in submissionResult && submissionResult.error instanceof HtmlString);
 }
+/**
+ * The difference between this and HtmlString is that it is fully resolved and only accepts primitive types.
+ * In plain english this means:
+ * It does not accept functions (that will be resolved at request time with (mini)=>mini.html) like mini.html does.
+ */
+export class BasedHtml extends String {
+}
+//TODO make it so we can embed BasedHtml into mini.html partially resolved html strings
+/**
+ * The difference between this and HtmlString is that it is fully resolved and only accepts primitive types.
+ * @param strings - html literals
+ * @param values - values will get escaped to prevent xss
+ * @returns
+ */
+export const basedHtml = (strings, ...values) => {
+    // Apply escapeHtml to each value before using them in the template string
+    // In case it didn't already get escaped
+    for (const [index, value] of values.entries()) {
+        // we can pass arrays of BasedHtml and they will get flattened automatically
+        if (Array.isArray(value) &&
+            value.every((val) => val instanceof BasedHtml)) {
+            // If the value is an array of BasedHtml objects, flatten it and add to ...values
+            values[index] = value.join("");
+        }
+        else if (!(value instanceof BasedHtml)) {
+            const notEmpty = value || "";
+            // values will be escaped by default
+            values[index] = Bun.escapeHTML(notEmpty + "");
+        }
+    }
+    return new BasedHtml(String.raw({ raw: strings }, ...values));
+};

package/dist/mininext.d.ts

@@ -1,15 +1,15 @@
 /// <reference types="bun-types" />
 /// <reference types="bun-types" />
 import { url, Mini, type HtmlHandler } from "./url";
-import { isError, HtmlString, head, commonHead, cssReset } from "./html";
+import { isError, HtmlString, BasedHtml, head, commonHead, cssReset, basedHtml as html } from "./html";
 import type { Server, WebSocketHandler } from "bun";
 declare global {
     var PROJECT_ROOT: string | undefined;
 }
 declare function build(backendPath?: string): Promise<void>;
-declare const standardDevReloader: HtmlString;
+declare const standardDevReloader: BasedHtml;
 declare function makeEntrypoint(): Promise<{
     fetch: (req: Request, server: Server) => Promise<Response>;
     websocket: WebSocketHandler;
 }>;
-export { url, head, build, makeEntrypoint, isError, HtmlString, type HtmlHandler, Mini, standardDevReloader, commonHead, cssReset, };
+export { html, url, head, build, makeEntrypoint, isError, BasedHtml, HtmlString, type HtmlHandler, Mini, standardDevReloader, commonHead, cssReset, };

package/dist/mininext.js

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

package/dist/url.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="bun-types" />
 import type { Server, WebSocketHandler } from "bun";
 import { html, json, dangerjson, HtmlString } from "./html";
-import type { DangerJsonInHtml, JsonString, JsonStringValues } from "./html";
+import type { BasedHtml, DangerJsonInHtml, JsonString, JsonStringValues } from "./html";
 export type Form = {
     post: boolean;
     urlencoded: boolean;
@@ -193,6 +193,13 @@ export declare class url {
      * @param wsObject the websocketsocket object {@link WebSocketHandler}
      */
     static setWebsocket<T = undefined>(wsObject: WebSocketHandler<T>): void;
+    /**
+     * Send a message to all connected {@link ServerWebSocket} subscribed to a topic
+     * @param topic The topic to publish to
+     * @param message The data to send
+     * @returns 0 if the message was dropped, -1 if backpressure was applied, or the number of bytes sent.
+     */
+    static publishHtml(topic: string, message: BasedHtml): number;
     /**
      * Fetch handler that is called by the server when a request is made to any of the urls.
      * @param {Request} req - The Request object.

package/dist/url.js

@@ -395,6 +395,15 @@ export class url {
     static setWebsocket(wsObject) {
         url.websocket = wsObject;
     }
+    /**
+     * Send a message to all connected {@link ServerWebSocket} subscribed to a topic
+     * @param topic The topic to publish to
+     * @param message The data to send
+     * @returns 0 if the message was dropped, -1 if backpressure was applied, or the number of bytes sent.
+     */
+    static publishHtml(topic, message) {
+        return url.server.publish(topic, message);
+    }
     /**
      * Fetch handler that is called by the server when a request is made to any of the urls.
      * @param {Request} req - The Request object.

package/mininext/html.ts

@@ -295,5 +295,48 @@ export function isError(
 }
 
 declare global {
-  var Reloader: HtmlString | undefined;
+  var Reloader: BasedHtml | HtmlString | undefined;
 }
+/**
+ * The difference between this and HtmlString is that it is fully resolved and only accepts primitive types.
+ * In plain english this means:
+ * It does not accept functions (that will be resolved at request time with (mini)=>mini.html) like mini.html does.
+ */
+export class BasedHtml extends String {}
+export type BasedHtmlValues =
+  | number
+  | string
+  | undefined
+  | null
+  | boolean
+  | BasedHtml
+  | BasedHtml[];
+//TODO make it so we can embed BasedHtml into mini.html partially resolved html strings
+/**
+ * The difference between this and HtmlString is that it is fully resolved and only accepts primitive types.
+ * @param strings - html literals
+ * @param values - values will get escaped to prevent xss
+ * @returns
+ */
+export const basedHtml = (
+  strings: TemplateStringsArray,
+  ...values: BasedHtmlValues[]
+) => {
+  // Apply escapeHtml to each value before using them in the template string
+  // In case it didn't already get escaped
+  for (const [index, value] of values.entries()) {
+    // we can pass arrays of BasedHtml and they will get flattened automatically
+    if (
+      Array.isArray(value) &&
+      value.every((val) => val instanceof BasedHtml)
+    ) {
+      // If the value is an array of BasedHtml objects, flatten it and add to ...values
+      values[index] = value.join("");
+    } else if (!(value instanceof BasedHtml)) {
+      const notEmpty = value || "";
+      // values will be escaped by default
+      values[index] = Bun.escapeHTML(notEmpty + "");
+    }
+  }
+  return new BasedHtml(String.raw({ raw: strings }, ...values));
+};

package/mininext/mininext.ts

@@ -1,5 +1,13 @@
 import { url, Mini, type HtmlHandler } from "./url";
-import { html, isError, HtmlString, head, commonHead, cssReset } from "./html";
+import {
+  isError,
+  HtmlString,
+  BasedHtml,
+  head,
+  commonHead,
+  cssReset,
+  basedHtml as html,
+} from "./html";
 import type { BunPlugin, Server, WebSocketHandler } from "bun";
 import { watch } from "fs/promises";
 import * as path from "path";
@@ -174,11 +182,13 @@ async function makeEntrypoint() {
   };
 }
 export {
+  html,
   url,
   head,
   build,
   makeEntrypoint,
   isError,
+  BasedHtml,
   HtmlString,
   type HtmlHandler,
   Mini,

package/mininext/url.ts

@@ -1,6 +1,11 @@
 import type { Server, WebSocketHandler } from "bun";
 import { htmlResponder, html, json, dangerjson, HtmlString } from "./html";
-import type { DangerJsonInHtml, JsonString, JsonStringValues } from "./html";
+import type {
+  BasedHtml,
+  DangerJsonInHtml,
+  JsonString,
+  JsonStringValues,
+} from "./html";
 export type Form = {
   post: boolean;
   urlencoded: boolean;
@@ -497,7 +502,15 @@ export class url {
   static setWebsocket<T = undefined>(wsObject: WebSocketHandler<T>) {
     url.websocket = wsObject as WebSocketHandler;
   }
-
+  /**
+   * Send a message to all connected {@link ServerWebSocket} subscribed to a topic
+   * @param topic The topic to publish to
+   * @param message The data to send
+   * @returns 0 if the message was dropped, -1 if backpressure was applied, or the number of bytes sent.
+   */
+  static publishHtml(topic: string, message: BasedHtml) {
+    return url.server.publish(topic, message as string);
+  }
   /**
    * Fetch handler that is called by the server when a request is made to any of the urls.
    * @param {Request} req - The Request object.

package/package.json

@@ -12,7 +12,7 @@
 
   },
   "files": ["dist", "mininext"],
-  "version": "0.3.0",
+  "version": "0.3.2",
   "devDependencies": {
     "@types/bun": "latest"
   },