@sigmx/hono 0.1.0 → 0.2.0

package/README.md

@@ -13,7 +13,7 @@ import { serveClient } from '@sigmx/hono/node';
 
 const app = new Hono();
 app.use(sigmx());
-app.get('/sigmx.js', serveClient()); // the script-tag build from node_modules; skip it if you bundle
+app.get('/sigmx.js', serveClient()); // the script-tag build from node_modules; or serveClient({ path }) for your own bundle
 
 app.get('/api/towns', async (c) => {
   const { q = '' } = await c.var.sigmx.signals();
@@ -56,7 +56,7 @@ If you define your own `app.onError`, return `error.getResponse()` for `HTTPExce
 
 ## Serving the client
 
-`serveClient()` from `@sigmx/hono/node` reads `sigmx.standalone.js` from the installed `sigmx` package and serves it with an ETag and `cache-control`. It needs a filesystem, so it is a separate entry for Node, Bun and Deno; on Workers, bundle the client with your app instead. Pass `{ file, maxAge }` to serve another file from sigmx's `dist` or change the cache lifetime.
+`serveClient()` from `@sigmx/hono/node` reads `sigmx.standalone.js` from the installed `sigmx` package and serves it with an ETag and `cache-control`. It needs a filesystem, so it is a separate entry for Node, Bun and Deno; on Workers, bundle the client with your app instead. Pass `{ file, maxAge }` to serve another file from sigmx's `dist` or change the cache lifetime. Pass `path` to serve a bundle you built yourself (for example with `sigmxAuto()` from `sigmx/vite`) with the same headers: `serveClient({ path: 'public/sigmx.js' })`.
 
 ## JSX
 

package/dist/index.js

@@ -1,7 +1,7 @@
 import { createMiddleware } from 'hono/factory';
 import { HTTPException } from 'hono/http-exception';
 import { streamSSE } from 'hono/streaming';
-import { executeScript, formatEvent, patchElements, patchSignals, removeElements, removeSignals, SIGNALS_KEY, SSE_HEADERS, validateSignals, } from 'sigmx/server';
+import { executeScript, fieldsToObject, formatEvent, patchElements, patchSignals, removeElements, removeSignals, SIGNALS_KEY, SSE_HEADERS, validateSignals, } from 'sigmx/server';
 export { EVENT_PATCH_ELEMENTS, EVENT_PATCH_SIGNALS, executeScript, formatEvent, patchElements, patchSignals, removeElements, removeSignals, SIGNALS_KEY, SSE_HEADERS, } from 'sigmx/server';
 /**
  * Thrown by `signals()` when the payload cannot be parsed (400) or fails validation (422). It is an
@@ -68,14 +68,16 @@ const readSignals = async (c, schema) => {
     try {
         if (method === 'GET' || method === 'DELETE') {
             const q = c.req.query(SIGNALS_KEY);
-            raw = q ? JSON.parse(q) : {};
+            raw = q
+                ? JSON.parse(q)
+                : fieldsToObject(Object.entries(c.req.queries()).map(([k, v]) => [k, v.length > 1 ? v : v[0]]));
         }
         else if (type.includes('application/json')) {
             const text = await c.req.text();
             raw = text ? JSON.parse(text) : {};
         }
         else if (type.includes('form')) {
-            raw = await c.req.parseBody();
+            raw = await c.req.parseBody({ all: true });
         }
         else {
             raw = {};
@@ -84,6 +86,8 @@ const readSignals = async (c, schema) => {
     catch (e) {
         throw new SignalsError(`could not parse signals: ${e.message}`, [], 400);
     }
+    if (typeof raw !== 'object' || raw === null || Array.isArray(raw))
+        throw new SignalsError('signals must be an object', [], 400);
     try {
         return await validateSignals(raw, schema);
     }
@@ -100,8 +104,6 @@ const contextFor = (c) => ({
             c.header('sigmx-selector', o.selector);
         if (o.mode)
             c.header('sigmx-mode', o.mode);
-        if (o.useViewTransition)
-            c.header('sigmx-use-view-transition', 'true');
         return c.html(body, o.status ?? 200);
     },
     json: (signals, o = {}) => {

package/dist/node.d.ts

@@ -2,12 +2,20 @@ import type { Handler } from 'hono';
 export interface ServeClientOptions {
     /** File inside sigmx's `dist` to serve (default `sigmx.standalone.js`, every plugin, minified). */
     file?: string;
+    /**
+     * Serve this file instead of one from sigmx's `dist`: a bundle you built yourself, for example with
+     * `sigmxAuto()` from `sigmx/vite` so that only the plugins your markup uses ship. Absolute, or
+     * relative to the working directory.
+     */
+    path?: string;
     /** `max-age` in seconds for the `cache-control` header (default one hour); an ETag handles the rest. */
     maxAge?: number;
 }
 /**
- * A route handler that serves the client from `node_modules/sigmx` with an ETag, so no bundler is needed:
+ * A route handler that serves the client with an ETag: the script-tag build from `node_modules/sigmx`
+ * when no bundler is involved, or your own bundle via `path`:
  *
  *     app.get('/sigmx.js', serveClient())
+ *     app.get('/sigmx.js', serveClient({ path: 'public/sigmx.js' }))
  */
 export declare const serveClient: (o?: ServeClientOptions) => Handler;

package/dist/node.js

@@ -3,17 +3,19 @@ import { readFile } from 'node:fs/promises';
 import { createRequire } from 'node:module';
 import { dirname, join } from 'node:path';
 /**
- * A route handler that serves the client from `node_modules/sigmx` with an ETag, so no bundler is needed:
+ * A route handler that serves the client with an ETag: the script-tag build from `node_modules/sigmx`
+ * when no bundler is involved, or your own bundle via `path`:
  *
  *     app.get('/sigmx.js', serveClient())
+ *     app.get('/sigmx.js', serveClient({ path: 'public/sigmx.js' }))
  */
 export const serveClient = (o = {}) => {
     let cached;
     const load = () => {
         cached ??= (async () => {
-            const require = createRequire(import.meta.url);
-            const dist = join(dirname(require.resolve('sigmx/package.json')), 'dist');
-            const body = await readFile(join(dist, o.file ?? 'sigmx.standalone.js'), 'utf8');
+            const file = o.path ??
+                join(dirname(createRequire(import.meta.url).resolve('sigmx/package.json')), 'dist', o.file ?? 'sigmx.standalone.js');
+            const body = await readFile(file, 'utf8');
             const etag = `"${createHash('sha1').update(body).digest('base64url').slice(0, 16)}"`;
             return { body, etag };
         })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmx/hono",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Hono middleware for sigmx: read signals from the request, answer with HTML, JSON or a stream of patches, serve the client.",
   "keywords": [
     "hono",
@@ -57,6 +57,6 @@
   },
   "peerDependencies": {
     "hono": ">=4.6.0",
-    "sigmx": "^0.1.0"
+    "sigmx": "^0.2.0"
   }
 }