@farcaster/snap-hono 1.0.0 → 1.1.0

package/dist/index.js

@@ -1,5 +1,7 @@
 import { cors } from "hono/cors";
-import { parseRequest, sendResponse, MEDIA_TYPE, } from "@farcaster/snap";
+import { MEDIA_TYPE } from "@farcaster/snap";
+import { parseRequest } from "@farcaster/snap/server";
+import { payloadToResponse } from "./payloadToResponse";
 /**
  * Register GET and POST snap handlers on `app` at `options.path` (default `/`).
  *
@@ -19,13 +21,13 @@ export function registerSnapHandler(app, snapFn, options = {}) {
     app.get(path, async (c) => {
         const accept = c.req.header("Accept");
         if (!clientWantsSnapResponse(accept)) {
-            return c.text(fallbackText, 200);
+            return c.text(fallbackText, 200, { Vary: "Accept" });
         }
         const response = await snapFn({
             action: { type: "get" },
             request: c.req.raw,
         });
-        return sendResponse(response);
+        return payloadToResponse(response);
     });
     app.post(path, async (c) => {
         const raw = c.req.raw;
@@ -53,7 +55,7 @@ export function registerSnapHandler(app, snapFn, options = {}) {
             }
         }
         const response = await snapFn({ action: parsed.action, request: raw });
-        return sendResponse(response);
+        return payloadToResponse(response);
     });
 }
 function clientWantsSnapResponse(accept) {

package/dist/payloadToResponse.d.ts

@@ -0,0 +1,8 @@
+import { type SnapResponse } from "@farcaster/snap";
+/**
+ * Validate a snap root object, then return a JSON Response for the client.
+ * Sets `Content-Type: application/vnd.farcaster.snap+json` and `Vary: Accept`.
+ *
+ * On validation failure returns JSON `{ "error": "...", "issues": [...] }` with status 400.
+ */
+export declare function payloadToResponse(payload: SnapResponse): Response;

package/dist/payloadToResponse.js

@@ -0,0 +1,29 @@
+import { MEDIA_TYPE, rootSchema, validatePage, } from "@farcaster/snap";
+/**
+ * Validate a snap root object, then return a JSON Response for the client.
+ * Sets `Content-Type: application/vnd.farcaster.snap+json` and `Vary: Accept`.
+ *
+ * On validation failure returns JSON `{ "error": "...", "issues": [...] }` with status 400.
+ */
+export function payloadToResponse(payload) {
+    const validation = validatePage(payload);
+    if (!validation.valid) {
+        return new Response(JSON.stringify({
+            error: "invalid snap page",
+            issues: validation.issues,
+        }), {
+            status: 400,
+            headers: {
+                "Content-Type": "application/json; charset=utf-8",
+            },
+        });
+    }
+    const finalized = rootSchema.parse(payload);
+    return new Response(JSON.stringify(finalized), {
+        status: 200,
+        headers: {
+            "Content-Type": `${MEDIA_TYPE}; charset=utf-8`,
+            Vary: "Accept",
+        },
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/snap-hono",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Hono integration for Farcaster Snap servers",
   "repository": {
     "type": "git",
@@ -26,10 +26,9 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@farcaster/snap": "1.0.0"
+    "@farcaster/snap": "1.2.0"
   },
   "peerDependencies": {
-    "@farcaster/snap": "^1.0.0",
     "hono": ">=4.0.0"
   },
   "devDependencies": {

package/src/index.ts

@@ -1,12 +1,8 @@
 import type { Hono } from "hono";
 import { cors } from "hono/cors";
-import {
-  parseRequest,
-  sendResponse,
-  MEDIA_TYPE,
-  type ParseRequestOptions,
-  type SnapFunction,
-} from "@farcaster/snap";
+import { MEDIA_TYPE, type SnapFunction } from "@farcaster/snap";
+import { parseRequest } from "@farcaster/snap/server";
+import { payloadToResponse } from "./payloadToResponse";
 
 export type SnapHandlerOptions = {
   /**
@@ -54,14 +50,14 @@ export function registerSnapHandler(
   app.get(path, async (c) => {
     const accept = c.req.header("Accept");
     if (!clientWantsSnapResponse(accept)) {
-      return c.text(fallbackText, 200);
+      return c.text(fallbackText, 200, { Vary: "Accept" });
     }
 
     const response = await snapFn({
       action: { type: "get" },
       request: c.req.raw,
     });
-    return sendResponse(response);
+    return payloadToResponse(response);
   });
 
   app.post(path, async (c) => {
@@ -98,7 +94,7 @@ export function registerSnapHandler(
 
     const response = await snapFn({ action: parsed.action, request: raw });
 
-    return sendResponse(response);
+    return payloadToResponse(response);
   });
 }
 

package/src/payloadToResponse.ts

@@ -0,0 +1,39 @@
+import {
+  MEDIA_TYPE,
+  rootSchema,
+  type SnapResponse,
+  validatePage,
+} from "@farcaster/snap";
+
+/**
+ * Validate a snap root object, then return a JSON Response for the client.
+ * Sets `Content-Type: application/vnd.farcaster.snap+json` and `Vary: Accept`.
+ *
+ * On validation failure returns JSON `{ "error": "...", "issues": [...] }` with status 400.
+ */
+export function payloadToResponse(payload: SnapResponse): Response {
+  const validation = validatePage(payload);
+  if (!validation.valid) {
+    return new Response(
+      JSON.stringify({
+        error: "invalid snap page",
+        issues: validation.issues,
+      }),
+      {
+        status: 400,
+        headers: {
+          "Content-Type": "application/json; charset=utf-8",
+        },
+      },
+    );
+  }
+
+  const finalized = rootSchema.parse(payload);
+  return new Response(JSON.stringify(finalized), {
+    status: 200,
+    headers: {
+      "Content-Type": `${MEDIA_TYPE}; charset=utf-8`,
+      Vary: "Accept",
+    },
+  });
+}