@farcaster/snap 1.9.0 → 1.10.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-export type { Spec as SnapSpec, UIElement as SnapUIElement } from "@json-render/core";
-export { SPEC_VERSION, MEDIA_TYPE, EFFECT_VALUES, } from "./constants.js";
+export type { Spec as SnapSpec, UIElement as SnapUIElement, } from "@json-render/core";
+export { SPEC_VERSION, MEDIA_TYPE, EFFECT_VALUES } from "./constants.js";
 export { DEFAULT_THEME_ACCENT, PALETTE_COLOR, PALETTE_COLOR_ACCENT, PALETTE_COLOR_VALUES, PALETTE_LIGHT_HEX, PALETTE_DARK_HEX, type PaletteColor, } from "./colors.js";
-export { ACTION_TYPE_GET, ACTION_TYPE_POST, snapResponseSchema, payloadSchema, type SnapAction, type SnapContext, type SnapResponse, type SnapHandlerResult, type SnapFunction, type SnapPayload, } from "./schemas.js";
-export { validateSnapResponse, type ValidationResult, } from "./validator.js";
-export { type DataStoreValue, type SnapDataStore, createDefaultDataStore, createInMemoryDataStore, } from "./dataStore.js";
+export { ACTION_TYPE_GET, ACTION_TYPE_POST, snapResponseSchema, payloadSchema, type SnapAction, type SnapContext, type SnapResponse, type SnapHandlerResult, type SnapElementInput, type SnapSpecInput, type SnapFunction, type SnapPayload, } from "./schemas.js";
+export { validateSnapResponse, type ValidationResult } from "./validator.js";
 export { type Middleware, useMiddleware } from "./middleware.js";

package/dist/index.js

@@ -1,6 +1,5 @@
-export { SPEC_VERSION, MEDIA_TYPE, EFFECT_VALUES, } from "./constants.js";
+export { SPEC_VERSION, MEDIA_TYPE, EFFECT_VALUES } from "./constants.js";
 export { DEFAULT_THEME_ACCENT, PALETTE_COLOR, PALETTE_COLOR_ACCENT, PALETTE_COLOR_VALUES, PALETTE_LIGHT_HEX, PALETTE_DARK_HEX, } from "./colors.js";
 export { ACTION_TYPE_GET, ACTION_TYPE_POST, snapResponseSchema, payloadSchema, } from "./schemas.js";
-export { validateSnapResponse, } from "./validator.js";
-export { createDefaultDataStore, createInMemoryDataStore, } from "./dataStore.js";
+export { validateSnapResponse } from "./validator.js";
 export { useMiddleware } from "./middleware.js";

package/dist/schemas.d.ts

@@ -1,6 +1,16 @@
 import { z } from "zod";
 import type { Spec } from "@json-render/core";
-import { type SnapDataStore } from "./dataStore.js";
+import { SPEC_VERSION } from "./constants.js";
+declare const themeAccentSchema: z.ZodEnum<{
+    gray: "gray";
+    blue: "blue";
+    red: "red";
+    amber: "amber";
+    green: "green";
+    teal: "teal";
+    purple: "purple";
+    pink: "pink";
+}>;
 export declare const snapResponseSchema: z.ZodObject<{
     version: z.ZodLiteral<"1.0">;
     theme: z.ZodDefault<z.ZodOptional<z.ZodObject<{
@@ -21,7 +31,40 @@ export declare const snapResponseSchema: z.ZodObject<{
     ui: z.ZodCustom<Spec, Spec>;
 }, z.core.$strict>;
 export type SnapResponse = z.infer<typeof snapResponseSchema>;
-export type SnapHandlerResult = z.input<typeof snapResponseSchema>;
+/**
+ * Permissive element input type for snap handler authors.
+ * Allows dynamic element construction without requiring exact UIElement types.
+ */
+export type SnapElementInput = {
+    type: string;
+    props?: Record<string, unknown>;
+    children?: string[];
+    on?: Record<string, unknown>;
+    [key: string]: unknown;
+};
+/**
+ * Permissive input type for the `ui` field in snap handler return values.
+ * Accepts dynamically-built element maps (e.g. `Record<string, SnapElementInput>`)
+ * without requiring exact UIElement types.
+ */
+export type SnapSpecInput = {
+    root: string;
+    elements: Record<string, SnapElementInput>;
+    state?: Record<string, unknown>;
+};
+/**
+ * Return type for snap handler functions.
+ * Uses permissive input types so handlers can build elements dynamically
+ * without type casts. Runtime validation via the Zod schema still catches invalid shapes.
+ */
+export type SnapHandlerResult = {
+    version: typeof SPEC_VERSION;
+    theme?: {
+        accent?: z.input<typeof themeAccentSchema>;
+    };
+    effects?: z.input<typeof snapResponseSchema>["effects"];
+    ui: SnapSpecInput;
+};
 export declare const payloadSchema: z.ZodObject<{
     fid: z.ZodNumber;
     inputs: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodString>]>>>;
@@ -56,7 +99,6 @@ export type SnapAction = z.infer<typeof snapActionSchema>;
 export type SnapContext = {
     action: SnapAction;
     request: Request;
-    data: SnapDataStore;
 };
 export type SnapFunction = (ctx: SnapContext) => Promise<SnapHandlerResult>;
 export {};

package/dist/schemas.js

@@ -1,6 +1,6 @@
 import { z } from "zod";
-import { EFFECT_VALUES, SPEC_VERSION, } from "./constants.js";
-import { DEFAULT_THEME_ACCENT, PALETTE_COLOR_VALUES, } from "./colors.js";
+import { EFFECT_VALUES, SPEC_VERSION } from "./constants.js";
+import { DEFAULT_THEME_ACCENT, PALETTE_COLOR_VALUES } from "./colors.js";
 // ─── Theme ─────────────────────────────────────────────
 const themeAccentSchema = z.enum(PALETTE_COLOR_VALUES, {
     message: `accent must be a palette color: ${PALETTE_COLOR_VALUES.join(", ")}`,

package/llms.txt

@@ -158,14 +158,14 @@ Plus the special value `"accent"` which references `theme.accent`.
 ```ts
 import { snapJsonRenderCatalog } from "@farcaster/snap/ui";
 import { parseRequest, verifyJFSRequestBody } from "@farcaster/snap/server";
-import { createInMemoryDataStore } from "@farcaster/snap";
+import { withTursoServerless, createInMemoryDataStore } from "@farcaster/snap-turso";
 ```
 
-- `@farcaster/snap` — schemas, types, validation, data store
+- `@farcaster/snap` — schemas, types, validation
 - `@farcaster/snap/ui` — json-render catalog, component schemas
 - `@farcaster/snap/server` — request parsing, JFS verification
 - `@farcaster/snap-hono` — Hono adapter (`registerSnapHandler`)
-- `@farcaster/snap-turso` — Turso data store middleware
+- `@farcaster/snap-turso` — `withTursoServerless`, `DataStore` / `DataStoreValue`, in-memory and Turso helpers
 
 ## Full Documentation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/snap",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Farcaster Snaps 🫰",
   "repository": {
     "type": "git",

package/src/index.ts

@@ -1,9 +1,8 @@
-export type { Spec as SnapSpec, UIElement as SnapUIElement } from "@json-render/core";
-export {
-  SPEC_VERSION,
-  MEDIA_TYPE,
-  EFFECT_VALUES,
-} from "./constants";
+export type {
+  Spec as SnapSpec,
+  UIElement as SnapUIElement,
+} from "@json-render/core";
+export { SPEC_VERSION, MEDIA_TYPE, EFFECT_VALUES } from "./constants";
 export {
   DEFAULT_THEME_ACCENT,
   PALETTE_COLOR,
@@ -22,17 +21,10 @@ export {
   type SnapContext,
   type SnapResponse,
   type SnapHandlerResult,
+  type SnapElementInput,
+  type SnapSpecInput,
   type SnapFunction,
   type SnapPayload,
 } from "./schemas";
-export {
-  validateSnapResponse,
-  type ValidationResult,
-} from "./validator";
-export {
-  type DataStoreValue,
-  type SnapDataStore,
-  createDefaultDataStore,
-  createInMemoryDataStore,
-} from "./dataStore";
+export { validateSnapResponse, type ValidationResult } from "./validator";
 export { type Middleware, useMiddleware } from "./middleware";

package/src/schemas.ts

@@ -1,14 +1,7 @@
 import { z } from "zod";
 import type { Spec } from "@json-render/core";
-import {
-  EFFECT_VALUES,
-  SPEC_VERSION,
-} from "./constants";
-import {
-  DEFAULT_THEME_ACCENT,
-  PALETTE_COLOR_VALUES,
-} from "./colors";
-import { type SnapDataStore } from "./dataStore";
+import { EFFECT_VALUES, SPEC_VERSION } from "./constants";
+import { DEFAULT_THEME_ACCENT, PALETTE_COLOR_VALUES } from "./colors";
 
 // ─── Theme ─────────────────────────────────────────────
 
@@ -43,7 +36,41 @@ export const snapResponseSchema = z
   .strict();
 
 export type SnapResponse = z.infer<typeof snapResponseSchema>;
-export type SnapHandlerResult = z.input<typeof snapResponseSchema>;
+
+/**
+ * Permissive element input type for snap handler authors.
+ * Allows dynamic element construction without requiring exact UIElement types.
+ */
+export type SnapElementInput = {
+  type: string;
+  props?: Record<string, unknown>;
+  children?: string[];
+  on?: Record<string, unknown>;
+  [key: string]: unknown;
+};
+
+/**
+ * Permissive input type for the `ui` field in snap handler return values.
+ * Accepts dynamically-built element maps (e.g. `Record<string, SnapElementInput>`)
+ * without requiring exact UIElement types.
+ */
+export type SnapSpecInput = {
+  root: string;
+  elements: Record<string, SnapElementInput>;
+  state?: Record<string, unknown>;
+};
+
+/**
+ * Return type for snap handler functions.
+ * Uses permissive input types so handlers can build elements dynamically
+ * without type casts. Runtime validation via the Zod schema still catches invalid shapes.
+ */
+export type SnapHandlerResult = {
+  version: typeof SPEC_VERSION;
+  theme?: { accent?: z.input<typeof themeAccentSchema> };
+  effects?: z.input<typeof snapResponseSchema>["effects"];
+  ui: SnapSpecInput;
+};
 
 // ─── POST payload ──────────────────────────────────────
 
@@ -92,7 +119,6 @@ export type SnapAction = z.infer<typeof snapActionSchema>;
 export type SnapContext = {
   action: SnapAction;
   request: Request;
-  data: SnapDataStore;
 };
 
 export type SnapFunction = (ctx: SnapContext) => Promise<SnapHandlerResult>;

package/dist/dataStore.d.ts

@@ -1,9 +0,0 @@
-export type DataStoreValue = string | number | boolean | null | DataStoreValue[] | {
-    [key: string]: DataStoreValue;
-};
-export type SnapDataStore = {
-    get(key: string): Promise<DataStoreValue | null>;
-    set(key: string, value: DataStoreValue): Promise<void>;
-};
-export declare function createDefaultDataStore(): SnapDataStore;
-export declare function createInMemoryDataStore(): SnapDataStore;

package/dist/dataStore.js

@@ -1,22 +0,0 @@
-export function createDefaultDataStore() {
-    const err = new Error("Data store is not configured. Use withTursoServerless() from @farcaster/snap-turso or provide a data store implementation.");
-    return {
-        get(_key) {
-            return Promise.reject(err);
-        },
-        set(_key, _value) {
-            return Promise.reject(err);
-        },
-    };
-}
-export function createInMemoryDataStore() {
-    const data = new Map();
-    return {
-        async get(key) {
-            return data.get(key) ?? null;
-        },
-        async set(key, value) {
-            data.set(key, value);
-        },
-    };
-}

package/src/dataStore.ts

@@ -1,38 +0,0 @@
-export type DataStoreValue =
-  | string
-  | number
-  | boolean
-  | null
-  | DataStoreValue[]
-  | { [key: string]: DataStoreValue };
-
-export type SnapDataStore = {
-  get(key: string): Promise<DataStoreValue | null>;
-  set(key: string, value: DataStoreValue): Promise<void>;
-};
-
-export function createDefaultDataStore(): SnapDataStore {
-  const err = new Error(
-    "Data store is not configured. Use withTursoServerless() from @farcaster/snap-turso or provide a data store implementation.",
-  );
-  return {
-    get(_key: string): Promise<never> {
-      return Promise.reject(err);
-    },
-    set(_key: string, _value: DataStoreValue): Promise<never> {
-      return Promise.reject(err);
-    },
-  };
-}
-
-export function createInMemoryDataStore(): SnapDataStore {
-  const data = new Map<string, DataStoreValue>();
-  return {
-    async get(key: string): Promise<DataStoreValue | null> {
-      return data.get(key) ?? null;
-    },
-    async set(key: string, value: DataStoreValue): Promise<void> {
-      data.set(key, value);
-    },
-  };
-}