@backtickjs/hono 0.2.6 → 0.2.7

package/dist/index.d.ts

@@ -5,6 +5,19 @@ declare module "hono" {
         <T extends [T] extends [SplicesAs<T>] ? unknown : Spliceable>(input: T): Promise<Response>;
     }
 }
+/** A web app manifest: what the phone uses of an app before and around it. */
+export interface Manifest {
+    name?: string;
+    short_name?: string;
+    icons?: {
+        src: string;
+        sizes?: string;
+        type?: string;
+    }[];
+    theme_color?: string;
+    background_color?: string;
+    display?: "fullscreen" | "standalone" | "minimal-ui" | "browser";
+}
 /**
  * Hono's renderer for Backtick screens: under it, `context.render(input)`
  * answers with `input` bundled for the modules the client sent in
@@ -13,7 +26,14 @@ declare module "hono" {
  *     app.use(backtick());
  *     app.get("/", (context) => context.render(<Home />));
  *
- * A client without a module the screen needs gets a 426, and any other
- * refusal of the bundler's a 400, each with `{ name, message }`.
+ * The status is the context's, so `context.status(404)` makes a not-found
+ * screen, and screens are `no-store`: each opens as its latest copy. A client
+ * without a module the screen needs gets a 426, and any other refusal of the
+ * bundler's a 400, each with `{ name, message }`.
+ *
+ * `manifest` is the app's web app manifest, at `/manifest.webmanifest` and in
+ * `x-backtick-manifest` on every screen, so it's as fresh as they are.
  */
-export declare function backtick(): MiddlewareHandler;
+export declare function backtick(options?: {
+    manifest?: Manifest;
+}): MiddlewareHandler;

package/dist/index.js

@@ -7,11 +7,24 @@ import { bundler, BundlerError } from "@backtickjs/bundler";
  *     app.use(backtick());
  *     app.get("/", (context) => context.render(<Home />));
  *
- * A client without a module the screen needs gets a 426, and any other
- * refusal of the bundler's a 400, each with `{ name, message }`.
+ * The status is the context's, so `context.status(404)` makes a not-found
+ * screen, and screens are `no-store`: each opens as its latest copy. A client
+ * without a module the screen needs gets a 426, and any other refusal of the
+ * bundler's a 400, each with `{ name, message }`.
+ *
+ * `manifest` is the app's web app manifest, at `/manifest.webmanifest` and in
+ * `x-backtick-manifest` on every screen, so it's as fresh as they are.
  */
-export function backtick() {
+export function backtick(options = {}) {
+    const { manifest } = options;
+    const json = JSON.stringify(manifest);
     return async (context, next) => {
+        if (manifest !== undefined &&
+            context.req.path === "/manifest.webmanifest") {
+            return context.body(json, 200, {
+                "content-type": "application/manifest+json",
+            });
+        }
         context.setRenderer(async (input) => {
             let modules;
             try {
@@ -24,7 +37,12 @@ export function backtick() {
             try {
                 const build = await bundler.build({ input, modules });
                 const { code } = build.generate({ format: "cjs" });
-                return context.body(code, 200, { "content-type": "text/javascript" });
+                context.header("content-type", "text/javascript");
+                context.header("cache-control", "no-store");
+                if (manifest !== undefined) {
+                    context.header("x-backtick-manifest", encodeURIComponent(json));
+                }
+                return context.body(code);
             }
             catch (error) {
                 if (error instanceof BundlerError) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAgB,MAAM,qBAAqB,CAAC;AAc1E;;;;;;;;;;GAUG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAC7B,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAClC,IAAI,OAAgB,CAAC;YACrB,IAAI,CAAC;gBACH,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,IAAI,CAAC,CAAC;YACzE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAoB,CAAC;gBAC/C,OAAO,OAAO,CAAC,IAAI,CACjB,EAAE,IAAI,EAAE,OAAO,EAAE,kCAAkC,OAAO,EAAE,EAAE,EAC9D,GAAG,CACJ,CAAC;YACJ,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;gBACtD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBACnD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC,CAAC;YACxE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;oBAClC,OAAO,OAAO,CAAC,IAAI,CACjB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,EAC5C,KAAK,CAAC,IAAI,KAAK,uBAAuB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CACnD,CAAC;gBACJ,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,EAAE,CAAC;IACf,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAgB,MAAM,qBAAqB,CAAC;AAwB1E;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,QAAQ,CACtB,UAAmC,EAAE;IAErC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAC7B,IACE,QAAQ,KAAK,SAAS;YACtB,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,uBAAuB,EAC5C,CAAC;YACD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE;gBAC7B,cAAc,EAAE,2BAA2B;aAC5C,CAAC,CAAC;QACL,CAAC;QACD,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YAClC,IAAI,OAAgB,CAAC;YACrB,IAAI,CAAC;gBACH,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,IAAI,CAAC,CAAC;YACzE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAoB,CAAC;gBAC/C,OAAO,OAAO,CAAC,IAAI,CACjB,EAAE,IAAI,EAAE,OAAO,EAAE,kCAAkC,OAAO,EAAE,EAAE,EAC9D,GAAG,CACJ,CAAC;YACJ,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;gBACtD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;gBACnD,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAC;gBAClD,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;gBAC5C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,OAAO,CAAC,MAAM,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;gBAClE,CAAC;gBACD,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;oBAClC,OAAO,OAAO,CAAC,IAAI,CACjB,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,EAC5C,KAAK,CAAC,IAAI,KAAK,uBAAuB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CACnD,CAAC;gBACJ,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,EAAE,CAAC;IACf,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backtickjs/hono",
-  "version": "0.2.6",
+  "version": "0.2.7",
   "description": "Hono routes as Backtick screens: a route's answer is its server components, bundled for the client that asked",
   "keywords": [
     "backtick",
@@ -37,8 +37,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@backtickjs/bundler": "^0.2.6",
-    "@backtickjs/core": "^0.2.6"
+    "@backtickjs/bundler": "0.2.7",
+    "@backtickjs/core": "0.2.7"
   },
   "peerDependencies": {
     "hono": "^4.13.13"

package/src/index.ts

@@ -12,6 +12,16 @@ declare module "hono" {
   }
 }
 
+/** A web app manifest: what the phone uses of an app before and around it. */
+export interface Manifest {
+  name?: string;
+  short_name?: string;
+  icons?: { src: string; sizes?: string; type?: string }[];
+  theme_color?: string;
+  background_color?: string;
+  display?: "fullscreen" | "standalone" | "minimal-ui" | "browser";
+}
+
 /**
  * Hono's renderer for Backtick screens: under it, `context.render(input)`
  * answers with `input` bundled for the modules the client sent in
@@ -20,11 +30,28 @@ declare module "hono" {
  *     app.use(backtick());
  *     app.get("/", (context) => context.render(<Home />));
  *
- * A client without a module the screen needs gets a 426, and any other
- * refusal of the bundler's a 400, each with `{ name, message }`.
+ * The status is the context's, so `context.status(404)` makes a not-found
+ * screen, and screens are `no-store`: each opens as its latest copy. A client
+ * without a module the screen needs gets a 426, and any other refusal of the
+ * bundler's a 400, each with `{ name, message }`.
+ *
+ * `manifest` is the app's web app manifest, at `/manifest.webmanifest` and in
+ * `x-backtick-manifest` on every screen, so it's as fresh as they are.
  */
-export function backtick(): MiddlewareHandler {
+export function backtick(
+  options: { manifest?: Manifest } = {},
+): MiddlewareHandler {
+  const { manifest } = options;
+  const json = JSON.stringify(manifest);
   return async (context, next) => {
+    if (
+      manifest !== undefined &&
+      context.req.path === "/manifest.webmanifest"
+    ) {
+      return context.body(json, 200, {
+        "content-type": "application/manifest+json",
+      });
+    }
     context.setRenderer(async (input) => {
       let modules: Modules;
       try {
@@ -39,7 +66,12 @@ export function backtick(): MiddlewareHandler {
       try {
         const build = await bundler.build({ input, modules });
         const { code } = build.generate({ format: "cjs" });
-        return context.body(code, 200, { "content-type": "text/javascript" });
+        context.header("content-type", "text/javascript");
+        context.header("cache-control", "no-store");
+        if (manifest !== undefined) {
+          context.header("x-backtick-manifest", encodeURIComponent(json));
+        }
+        return context.body(code);
       } catch (error) {
         if (error instanceof BundlerError) {
           return context.json(