@farcaster/snap 1.1.0 → 1.2.0

package/dist/constants.d.ts

@@ -1,6 +1,6 @@
 export declare const POST_GRID_TAP_KEY: "grid_tap";
 export declare const SPEC_VERSION: "1.0";
-export declare const MEDIA_TYPE: "application/json+farcaster-snap";
+export declare const MEDIA_TYPE: "application/vnd.farcaster.snap+json";
 export declare const LIMITS: {
     readonly maxElementsPerPage: 5;
     readonly maxButtonsPerPage: 4;

package/dist/constants.js

@@ -1,6 +1,6 @@
 export const POST_GRID_TAP_KEY = "grid_tap";
 export const SPEC_VERSION = "1.0";
-export const MEDIA_TYPE = "application/json+farcaster-snap";
+export const MEDIA_TYPE = "application/vnd.farcaster.snap+json";
 export const LIMITS = {
     maxElementsPerPage: 5,
     maxButtonsPerPage: 4,

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-export { verifyJFSRequestBody } from "./verify.js";
 export { POST_GRID_TAP_KEY, PAGE_ROOT_TYPE, ELEMENT_TYPE, MEDIA_TYPE, DEFAULT_THEME_ACCENT, DEFAULT_LIST_STYLE, DEFAULT_SLIDER_STEP, PALETTE_COLOR, PALETTE_COLOR_VALUES, PALETTE_LIGHT_HEX, PALETTE_DARK_HEX, type PaletteColor, } from "./constants.js";
 export { rootSchema, firstPageRootSchema, payloadSchema, type SnapAction, type SnapContext, type SnapResponse, type SnapFunction, type SnapPayload, } from "./schemas.js";
-export { parseRequest, sendResponse, type ParseRequestError, type ParseRequestOptions, type ParseRequestResult, type SendResponseOptions, } from "./http.js";
 export { validatePage, validateFirstPage, type ValidationResult, } from "./validator.js";

package/dist/index.js

@@ -1,5 +1,3 @@
-export { verifyJFSRequestBody } from "./verify.js";
 export { POST_GRID_TAP_KEY, PAGE_ROOT_TYPE, ELEMENT_TYPE, MEDIA_TYPE, DEFAULT_THEME_ACCENT, DEFAULT_LIST_STYLE, DEFAULT_SLIDER_STEP, PALETTE_COLOR, PALETTE_COLOR_VALUES, PALETTE_LIGHT_HEX, PALETTE_DARK_HEX, } from "./constants.js";
 export { rootSchema, firstPageRootSchema, payloadSchema, } from "./schemas.js";
-export { parseRequest, sendResponse, } from "./http.js";
 export { validatePage, validateFirstPage, } from "./validator.js";

package/dist/schemas.d.ts

@@ -1405,11 +1405,11 @@ export type SnapResponse = z.infer<typeof rootSchema>;
 export type SnapPage = SnapResponse["page"];
 export type SnapPayload = z.infer<typeof payloadSchema>;
 declare const snapPostActionSchema: z.ZodObject<{
+    fid: z.ZodNumber;
     inputs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodObject<{
         row: z.ZodNumber;
         col: z.ZodNumber;
     }, z.core.$strict>]>>>;
-    fid: z.ZodNumber;
     timestamp: z.ZodNumber;
     type: z.ZodLiteral<"post">;
     buttonIndex: z.ZodNumber;

package/dist/server/index.d.ts

@@ -0,0 +1,3 @@
+export { verifyJFSRequestBody, decodePayload } from "./verify.js";
+export { DEFAULT_SNAP_HUB_HTTP_BASE_URL, getActiveEd25519SignerKeysFromHubHttp, } from "./hubs.js";
+export { parseRequest, type ParseRequestError, type ParseRequestOptions, type ParseRequestResult, } from "./parseRequest.js";

package/dist/server/index.js

@@ -0,0 +1,3 @@
+export { verifyJFSRequestBody, decodePayload } from "./verify.js";
+export { DEFAULT_SNAP_HUB_HTTP_BASE_URL, getActiveEd25519SignerKeysFromHubHttp, } from "./hubs.js";
+export { parseRequest, } from "./parseRequest.js";

package/dist/{http.d.ts → server/parseRequest.d.ts}

@@ -1,4 +1,4 @@
-import { type SnapAction, type SnapResponse, type SnapPage } from "./schemas.js";
+import { type SnapAction } from "../schemas.js";
 import { z } from "zod";
 export type ParseRequestError = {
     type: "method_not_allowed";
@@ -35,14 +35,3 @@ export type ParseRequestResult = {
  * - `POST`: the body must be JSON in JFS form (`header` / `payload` / `signature`) even if JFS verification is skipped.
  */
 export declare function parseRequest(request: Request, options?: ParseRequestOptions): Promise<ParseRequestResult>;
-export type SendResponseOptions = ResponseInit & {
-    /** When false, invalid pages return 500 instead of 400. Default true. */
-    clientErrorOnInvalid?: boolean;
-};
-/**
- * Validate a snap root or bare `page` object, then return a JSON Response for the client.
- * Sets `Content-Type: application/json+farcaster-snap`.
- *
- * On validation failure returns JSON `{ "error": "...", "issues": [...] }` with status 400 or 500.
- */
-export declare function sendResponse(payload: SnapResponse | SnapPage, init?: SendResponseOptions): Response;

package/dist/{http.js → server/parseRequest.js}

@@ -1,19 +1,8 @@
-import { MEDIA_TYPE, SPEC_VERSION } from "./constants.js";
+import { payloadSchema } from "../schemas.js";
 import { decodePayload, verifyJFSRequestBody } from "./verify.js";
-import { payloadSchema, rootSchema, } from "./schemas.js";
-import { validatePage } from "./validator.js";
 import { z } from "zod";
 /** Default replay window per SPEC.md § Replay Protection (5 minutes). */
 const DEFAULT_SNAP_POST_MAX_SKEW_SECONDS = 300;
-function isRecord(v) {
-    return v !== null && typeof v === "object" && !Array.isArray(v);
-}
-function normalizeToRoot(payload) {
-    if (isRecord(payload) && "version" in payload && "page" in payload) {
-        return payload;
-    }
-    return { version: SPEC_VERSION, page: payload };
-}
 const requestBodySchema = z.object({
     header: z.string(),
     payload: z.string(),
@@ -100,47 +89,3 @@ export async function parseRequest(request, options = {}) {
         },
     };
 }
-/**
- * Validate a snap root or bare `page` object, then return a JSON Response for the client.
- * Sets `Content-Type: application/json+farcaster-snap`.
- *
- * On validation failure returns JSON `{ "error": "...", "issues": [...] }` with status 400 or 500.
- */
-export function sendResponse(payload, init) {
-    const rootUnknown = normalizeToRoot(payload);
-    const validation = validatePage(rootUnknown);
-    const clientError = init?.clientErrorOnInvalid !== false;
-    const status = init?.status;
-    if (!validation.valid) {
-        const errStatus = clientError ? 400 : 500;
-        return new Response(JSON.stringify({
-            error: clientError
-                ? "invalid snap page"
-                : "server produced an invalid snap page",
-            issues: validation.issues,
-        }), {
-            status: status ?? errStatus,
-            headers: {
-                "Content-Type": "application/json; charset=utf-8",
-                ...normalizeHeaders(init?.headers),
-            },
-        });
-    }
-    const finalized = rootSchema.parse(rootUnknown);
-    const headers = new Headers(init?.headers);
-    headers.set("Content-Type", `${MEDIA_TYPE}; charset=utf-8`);
-    return new Response(JSON.stringify(finalized), {
-        ...init,
-        status: status ?? init?.status ?? 200,
-        headers,
-    });
-}
-function normalizeHeaders(h) {
-    if (h === undefined)
-        return {};
-    const out = {};
-    new Headers(h).forEach((value, key) => {
-        out[key] = value;
-    });
-    return out;
-}

package/dist/verify.test.js

@@ -1,5 +1,5 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { verifyJFSRequestBody } from "./verify.js";
+import { verifyJFSRequestBody } from "./server/verify.js";
 const validRequestBody = `{
   "header":"eyJmaWQiOjI2MTMxOSwidHlwZSI6ImFwcF9rZXkiLCJrZXkiOiIweGY0ZGQyNjczYTUzMjEwYzQ3ZGYzZjFmNTk0NjZlZTdhMTM3ZmQxOGQ5NTVjMmU2OGExMmQwOTE2MGE2NmMyMTUifQ",
   "payload":"eyJmaWQiOjI2MTMxOSwiaW5wdXRzIjp7ImRpc3BsYXkiOiJJU08gKFVUQykifSwiYnV0dG9uX2luZGV4IjowLCJ0aW1lc3RhbXAiOjE3NzQ2OTMyMTN9",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/snap",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Farcaster Snaps 🫰",
   "repository": {
     "type": "git",
@@ -16,10 +16,10 @@
       "import": "./dist/index.js",
       "default": "./dist/index.js"
     },
-    "./constants": {
-      "types": "./dist/constants.d.ts",
-      "import": "./dist/constants.js",
-      "default": "./dist/constants.js"
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "import": "./dist/server/index.js",
+      "default": "./dist/server/index.js"
     }
   },
   "files": [

package/src/constants.ts

@@ -2,7 +2,7 @@ export const POST_GRID_TAP_KEY = "grid_tap" as const;
 
 export const SPEC_VERSION = "1.0" as const;
 
-export const MEDIA_TYPE = "application/json+farcaster-snap" as const;
+export const MEDIA_TYPE = "application/vnd.farcaster.snap+json" as const;
 
 export const LIMITS = {
   maxElementsPerPage: 5,

package/src/index.ts

@@ -1,4 +1,3 @@
-export { verifyJFSRequestBody } from "./verify";
 export {
   POST_GRID_TAP_KEY,
   PAGE_ROOT_TYPE,
@@ -23,14 +22,6 @@ export {
   type SnapFunction,
   type SnapPayload,
 } from "./schemas";
-export {
-  parseRequest,
-  sendResponse,
-  type ParseRequestError,
-  type ParseRequestOptions,
-  type ParseRequestResult,
-  type SendResponseOptions,
-} from "./http";
 export {
   validatePage,
   validateFirstPage,

package/src/{hubs.ts → server/hubs.ts}

@@ -304,7 +304,9 @@ export async function getActiveEd25519SignerKeysFromHubHttp(
   options?: FetchSignerKeysFromHubHttpOptions,
 ): Promise<FetchSignerKeysResult> {
   const base = stripHubHttpBaseUrlTrailingSlash(httpBaseUrl);
-  const url = `${base}/v1/onChainSignersByFid?fid=${encodeURIComponent(String(fid))}`;
+  const url = `${base}/v1/onChainSignersByFid?fid=${encodeURIComponent(
+    String(fid),
+  )}`;
   const fetchImpl = options?.fetchFn ?? globalThis.fetch;
   if (typeof fetchImpl !== "function") {
     return {

package/src/server/index.ts

@@ -0,0 +1,11 @@
+export { verifyJFSRequestBody, decodePayload } from "./verify";
+export {
+  DEFAULT_SNAP_HUB_HTTP_BASE_URL,
+  getActiveEd25519SignerKeysFromHubHttp,
+} from "./hubs";
+export {
+  parseRequest,
+  type ParseRequestError,
+  type ParseRequestOptions,
+  type ParseRequestResult,
+} from "./parseRequest";

package/src/{http.ts → server/parseRequest.ts}

@@ -1,13 +1,5 @@
-import { MEDIA_TYPE, SPEC_VERSION } from "./constants";
+import { payloadSchema, type SnapAction } from "../schemas";
 import { decodePayload, verifyJFSRequestBody } from "./verify";
-import {
-  payloadSchema,
-  rootSchema,
-  type SnapAction,
-  type SnapResponse,
-  type SnapPage,
-} from "./schemas";
-import { validatePage } from "./validator";
 import { z } from "zod";
 
 /** Default replay window per SPEC.md § Replay Protection (5 minutes). */
@@ -46,17 +38,6 @@ export type ParseRequestResult =
   | { success: true; action: SnapAction }
   | { success: false; error: ParseRequestError };
 
-function isRecord(v: unknown): v is Record<string, unknown> {
-  return v !== null && typeof v === "object" && !Array.isArray(v);
-}
-
-function normalizeToRoot(payload: unknown): unknown {
-  if (isRecord(payload) && "version" in payload && "page" in payload) {
-    return payload;
-  }
-  return { version: SPEC_VERSION, page: payload };
-}
-
 const requestBodySchema = z.object({
   header: z.string(),
   payload: z.string(),
@@ -156,62 +137,3 @@ export async function parseRequest(
     },
   };
 }
-
-export type SendResponseOptions = ResponseInit & {
-  /** When false, invalid pages return 500 instead of 400. Default true. */
-  clientErrorOnInvalid?: boolean;
-};
-
-/**
- * Validate a snap root or bare `page` object, then return a JSON Response for the client.
- * Sets `Content-Type: application/json+farcaster-snap`.
- *
- * On validation failure returns JSON `{ "error": "...", "issues": [...] }` with status 400 or 500.
- */
-export function sendResponse(
-  payload: SnapResponse | SnapPage,
-  init?: SendResponseOptions,
-): Response {
-  const rootUnknown = normalizeToRoot(payload);
-  const validation = validatePage(rootUnknown);
-  const clientError = init?.clientErrorOnInvalid !== false;
-  const status = init?.status;
-
-  if (!validation.valid) {
-    const errStatus = clientError ? 400 : 500;
-    return new Response(
-      JSON.stringify({
-        error: clientError
-          ? "invalid snap page"
-          : "server produced an invalid snap page",
-        issues: validation.issues,
-      }),
-      {
-        status: status ?? errStatus,
-        headers: {
-          "Content-Type": "application/json; charset=utf-8",
-          ...normalizeHeaders(init?.headers),
-        },
-      },
-    );
-  }
-
-  const finalized = rootSchema.parse(rootUnknown);
-  const headers = new Headers(init?.headers);
-  headers.set("Content-Type", `${MEDIA_TYPE}; charset=utf-8`);
-
-  return new Response(JSON.stringify(finalized), {
-    ...init,
-    status: status ?? init?.status ?? 200,
-    headers,
-  });
-}
-
-function normalizeHeaders(h: HeadersInit | undefined): Record<string, string> {
-  if (h === undefined) return {};
-  const out: Record<string, string> = {};
-  new Headers(h).forEach((value, key) => {
-    out[key] = value;
-  });
-  return out;
-}

package/src/verify.test.ts

@@ -1,5 +1,5 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { verifyJFSRequestBody } from "./verify";
+import { verifyJFSRequestBody } from "./server/verify";
 
 const validRequestBody = `{
   "header":"eyJmaWQiOjI2MTMxOSwidHlwZSI6ImFwcF9rZXkiLCJrZXkiOiIweGY0ZGQyNjczYTUzMjEwYzQ3ZGYzZjFmNTk0NjZlZTdhMTM3ZmQxOGQ5NTVjMmU2OGExMmQwOTE2MGE2NmMyMTUifQ",