@farcaster/snap-hono 1.1.8 → 1.2.0

package/dist/index.d.ts

@@ -20,12 +20,12 @@ export type SnapHandlerOptions = {
 /**
  * Register GET and POST snap handlers on `app` at `options.path` (default `/`).
  *
- * - GET  → calls `snapFn({ action: { type: "get" }, request })` and returns the response.
+ * - GET  → calls `snapFn(ctx)` with `ctx.action.type === "get"` and returns the response.
  * - POST → parses the JFS-shaped JSON body; verifies it via {@link verifyJFSRequestBody} unless
- *          `skipJFSVerification` is true, then calls `snapFn({ action, request })` and returns the response.
+ *          `skipJFSVerification` is true, then calls `snapFn(ctx)` with the parsed post action and returns the response.
  *
  * All parsing, schema validation, signature verification, and error responses
- * are handled automatically. `SnapContext.request` is the raw `Request` so handlers
+ * are handled automatically. `ctx.request` is the raw `Request` so handlers
  * can read query params, headers, or the URL when needed.
  */
 export declare function registerSnapHandler(app: Hono, snapFn: SnapFunction, options?: SnapHandlerOptions): void;

package/dist/index.js

@@ -6,12 +6,12 @@ import { renderSnapPage } from "./renderSnapPage.js";
 /**
  * Register GET and POST snap handlers on `app` at `options.path` (default `/`).
  *
- * - GET  → calls `snapFn({ action: { type: "get" }, request })` and returns the response.
+ * - GET  → calls `snapFn(ctx)` with `ctx.action.type === "get"` and returns the response.
  * - POST → parses the JFS-shaped JSON body; verifies it via {@link verifyJFSRequestBody} unless
- *          `skipJFSVerification` is true, then calls `snapFn({ action, request })` and returns the response.
+ *          `skipJFSVerification` is true, then calls `snapFn(ctx)` with the parsed post action and returns the response.
  *
  * All parsing, schema validation, signature verification, and error responses
- * are handled automatically. `SnapContext.request` is the raw `Request` so handlers
+ * are handled automatically. `ctx.request` is the raw `Request` so handlers
  * can read query params, headers, or the URL when needed.
  */
 export function registerSnapHandler(app, snapFn, options = {}) {

package/dist/payloadToResponse.d.ts

@@ -1,9 +1,9 @@
-import { type SnapResponseInput } from "@farcaster/snap";
+import { type SnapHandlerResult } from "@farcaster/snap";
 type PayloadToResponseOptions = {
     resourcePath: string;
     mediaTypes: string[];
 };
-export declare function payloadToResponse(payload: SnapResponseInput, options?: Partial<PayloadToResponseOptions>): Response;
+export declare function payloadToResponse(payload: SnapHandlerResult, options?: Partial<PayloadToResponseOptions>): Response;
 export declare function snapHeaders(resourcePath: string, currentMediaType: string, availableMediaTypes: string[]): {
     "Content-Type": string;
     Vary: string;

package/dist/payloadToResponse.js

@@ -1,9 +1,9 @@
-import { MEDIA_TYPE, rootSchema, validatePage, } from "@farcaster/snap";
+import { MEDIA_TYPE, validateSnapResponse, snapResponseSchema, } from "@farcaster/snap";
 const DEFAULT_LINK_MEDIA_TYPES = [MEDIA_TYPE, "text/html"];
 export function payloadToResponse(payload, options = {}) {
     const resourcePath = options.resourcePath ?? "/";
     const mediaTypes = options.mediaTypes ?? [...DEFAULT_LINK_MEDIA_TYPES];
-    const validation = validatePage(payload);
+    const validation = validateSnapResponse(payload);
     if (!validation.valid) {
         return new Response(JSON.stringify({
             error: "invalid snap page",
@@ -15,7 +15,7 @@ export function payloadToResponse(payload, options = {}) {
             },
         });
     }
-    const finalized = rootSchema.parse(payload);
+    const finalized = snapResponseSchema.parse(payload);
     return new Response(JSON.stringify(finalized), {
         status: 200,
         headers: {

package/dist/renderSnapPage.d.ts

@@ -1,2 +1,2 @@
-import type { SnapResponseInput } from "@farcaster/snap";
-export declare function renderSnapPage(snap: SnapResponseInput, snapOrigin: string): string;
+import type { SnapHandlerResult } from "@farcaster/snap";
+export declare function renderSnapPage(snap: SnapHandlerResult, snapOrigin: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/snap-hono",
-  "version": "1.1.8",
+  "version": "1.2.0",
   "description": "Hono integration for Farcaster Snap servers",
   "repository": {
     "type": "git",
@@ -26,7 +26,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@farcaster/snap": "1.3.3"
+    "@farcaster/snap": "1.4.0"
   },
   "peerDependencies": {
     "hono": ">=4.0.0"

package/src/index.ts

@@ -28,12 +28,12 @@ export type SnapHandlerOptions = {
 /**
  * Register GET and POST snap handlers on `app` at `options.path` (default `/`).
  *
- * - GET  → calls `snapFn({ action: { type: "get" }, request })` and returns the response.
+ * - GET  → calls `snapFn(ctx)` with `ctx.action.type === "get"` and returns the response.
  * - POST → parses the JFS-shaped JSON body; verifies it via {@link verifyJFSRequestBody} unless
- *          `skipJFSVerification` is true, then calls `snapFn({ action, request })` and returns the response.
+ *          `skipJFSVerification` is true, then calls `snapFn(ctx)` with the parsed post action and returns the response.
  *
  * All parsing, schema validation, signature verification, and error responses
- * are handled automatically. `SnapContext.request` is the raw `Request` so handlers
+ * are handled automatically. `ctx.request` is the raw `Request` so handlers
  * can read query params, headers, or the URL when needed.
  */
 export function registerSnapHandler(

package/src/payloadToResponse.ts

@@ -1,8 +1,8 @@
 import {
   MEDIA_TYPE,
-  rootSchema,
-  type SnapResponseInput,
-  validatePage,
+  type SnapHandlerResult,
+  validateSnapResponse,
+  snapResponseSchema,
 } from "@farcaster/snap";
 
 type PayloadToResponseOptions = {
@@ -13,13 +13,13 @@ type PayloadToResponseOptions = {
 const DEFAULT_LINK_MEDIA_TYPES = [MEDIA_TYPE, "text/html"] as const;
 
 export function payloadToResponse(
-  payload: SnapResponseInput,
+  payload: SnapHandlerResult,
   options: Partial<PayloadToResponseOptions> = {},
 ): Response {
   const resourcePath = options.resourcePath ?? "/";
   const mediaTypes = options.mediaTypes ?? [...DEFAULT_LINK_MEDIA_TYPES];
 
-  const validation = validatePage(payload);
+  const validation = validateSnapResponse(payload);
   if (!validation.valid) {
     return new Response(
       JSON.stringify({
@@ -35,7 +35,7 @@ export function payloadToResponse(
     );
   }
 
-  const finalized = rootSchema.parse(payload);
+  const finalized = snapResponseSchema.parse(payload);
   return new Response(JSON.stringify(finalized), {
     status: 200,
     headers: {

package/src/renderSnapPage.ts

@@ -1,4 +1,4 @@
-import type { SnapResponseInput } from "@farcaster/snap";
+import type { SnapHandlerResult } from "@farcaster/snap";
 
 const PALETTE: Record<string, string> = {
   gray: "#8F8F8F",
@@ -307,7 +307,10 @@ function renderButtons(
 
 // ─── Main renderer ──────────────────────────────────────
 
-export function renderSnapPage(snap: SnapResponseInput, snapOrigin: string): string {
+export function renderSnapPage(
+  snap: SnapHandlerResult,
+  snapOrigin: string,
+): string {
   const page = snap.page;
   const accent = accentHex(page.theme?.accent);