@farcaster/snap 1.5.1 → 2.0.0

package/dist/ui/button.d.ts

@@ -1,34 +1,48 @@
 import { z } from "zod";
-export declare const actionButtonProps: z.ZodObject<{
-    label: z.ZodString;
-    action: z.ZodEnum<{
-        post: "post";
-        link: "link";
-        mini_app: "mini_app";
-        client: "client";
-    }>;
-    target: z.ZodOptional<z.ZodString>;
-    client_action: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    style: z.ZodOptional<z.ZodEnum<{
-        primary: "primary";
-        secondary: "secondary";
-    }>>;
-}, z.core.$strip>;
-export type ActionButtonProps = z.infer<typeof actionButtonProps>;
-/** Same schema as `actionButtonProps` (legacy export name). */
+export declare const BUTTON_VARIANTS: readonly ["default", "secondary", "outline", "ghost"];
+export declare const BUTTON_MAX_LABEL_CHARS = 30;
 export declare const buttonProps: z.ZodObject<{
     label: z.ZodString;
-    action: z.ZodEnum<{
-        post: "post";
-        link: "link";
-        mini_app: "mini_app";
-        client: "client";
-    }>;
-    target: z.ZodOptional<z.ZodString>;
-    client_action: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    style: z.ZodOptional<z.ZodEnum<{
-        primary: "primary";
+    variant: z.ZodOptional<z.ZodEnum<{
+        default: "default";
         secondary: "secondary";
+        outline: "outline";
+        ghost: "ghost";
+    }>>;
+    icon: z.ZodOptional<z.ZodEnum<{
+        check: "check";
+        repeat: "repeat";
+        "arrow-right": "arrow-right";
+        "arrow-left": "arrow-left";
+        "external-link": "external-link";
+        "chevron-right": "chevron-right";
+        x: "x";
+        "alert-triangle": "alert-triangle";
+        info: "info";
+        clock: "clock";
+        heart: "heart";
+        "message-circle": "message-circle";
+        share: "share";
+        user: "user";
+        users: "users";
+        star: "star";
+        trophy: "trophy";
+        zap: "zap";
+        flame: "flame";
+        gift: "gift";
+        image: "image";
+        play: "play";
+        pause: "pause";
+        wallet: "wallet";
+        coins: "coins";
+        plus: "plus";
+        minus: "minus";
+        "refresh-cw": "refresh-cw";
+        bookmark: "bookmark";
+        "thumbs-up": "thumbs-up";
+        "thumbs-down": "thumbs-down";
+        "trending-up": "trending-up";
+        "trending-down": "trending-down";
     }>>;
 }, z.core.$strip>;
-export type ButtonProps = ActionButtonProps;
+export type ButtonProps = z.infer<typeof buttonProps>;

package/dist/ui/button.js

@@ -1,11 +1,9 @@
 import { z } from "zod";
-import { BUTTON_ACTION_VALUES, BUTTON_STYLE_VALUES } from "../constants.js";
-export const actionButtonProps = z.object({
-    label: z.string(),
-    action: z.enum(BUTTON_ACTION_VALUES),
-    target: z.string().optional(),
-    client_action: z.record(z.string(), z.unknown()).optional(),
-    style: z.enum(BUTTON_STYLE_VALUES).optional(),
+import { ICON_NAMES } from "./icon.js";
+export const BUTTON_VARIANTS = ["default", "secondary", "outline", "ghost"];
+export const BUTTON_MAX_LABEL_CHARS = 30;
+export const buttonProps = z.object({
+    label: z.string().min(1).max(BUTTON_MAX_LABEL_CHARS),
+    variant: z.enum(BUTTON_VARIANTS).optional(),
+    icon: z.enum(ICON_NAMES).optional(),
 });
-/** Same schema as `actionButtonProps` (legacy export name). */
-export const buttonProps = actionButtonProps;

package/dist/ui/catalog.d.ts

@@ -1,7 +1,9 @@
 import { z } from "zod";
 /**
- * Basic catalog: one json-render component per snap element type, plus ActionButton for snap buttons.
- * Does not validate cross-field rules (media count, height budget); snap JSON still goes through `@farcaster/snap` validation.
+ * json-render catalog for snap elements.
+ *
+ * Component keys match the snap wire-format `type` strings.
+ * Action names are used directly in `on.press` bindings.
  */
 export declare const snapJsonRenderCatalog: import("@json-render/core").Catalog<{
     spec: import("@json-render/core").SchemaType<"object", {
@@ -32,56 +34,9 @@ export declare const snapJsonRenderCatalog: import("@json-render/core").Catalog<
     }>;
 }, {
     components: {
-        Text: {
+        badge: {
             props: z.ZodObject<{
-                style: z.ZodEnum<{
-                    title: "title";
-                    body: "body";
-                    caption: "caption";
-                    label: "label";
-                }>;
-                content: z.ZodString;
-                align: z.ZodOptional<z.ZodEnum<{
-                    left: "left";
-                    center: "center";
-                    right: "right";
-                }>>;
-            }, z.core.$strip>;
-            description: string;
-        };
-        Image: {
-            props: z.ZodObject<{
-                url: z.ZodString;
-                aspect: z.ZodEnum<{
-                    "1:1": "1:1";
-                    "16:9": "16:9";
-                    "4:3": "4:3";
-                    "3:4": "3:4";
-                    "9:16": "9:16";
-                }>;
-                alt: z.ZodOptional<z.ZodString>;
-            }, z.core.$strip>;
-            description: string;
-        };
-        Divider: {
-            props: z.ZodObject<{}, z.core.$strip>;
-            description: string;
-        };
-        Spacer: {
-            props: z.ZodObject<{
-                size: z.ZodDefault<z.ZodEnum<{
-                    small: "small";
-                    medium: "medium";
-                    large: "large";
-                }>>;
-            }, z.core.$strip>;
-            description: string;
-        };
-        Progress: {
-            props: z.ZodObject<{
-                value: z.ZodNumber;
-                max: z.ZodNumber;
-                label: z.ZodOptional<z.ZodString>;
+                label: z.ZodString;
                 color: z.ZodOptional<z.ZodEnum<{
                     gray: "gray";
                     blue: "blue";
@@ -93,112 +48,193 @@ export declare const snapJsonRenderCatalog: import("@json-render/core").Catalog<
                     pink: "pink";
                     accent: "accent";
                 }>>;
+                icon: z.ZodOptional<z.ZodEnum<{
+                    check: "check";
+                    repeat: "repeat";
+                    "arrow-right": "arrow-right";
+                    "arrow-left": "arrow-left";
+                    "external-link": "external-link";
+                    "chevron-right": "chevron-right";
+                    x: "x";
+                    "alert-triangle": "alert-triangle";
+                    info: "info";
+                    clock: "clock";
+                    heart: "heart";
+                    "message-circle": "message-circle";
+                    share: "share";
+                    user: "user";
+                    users: "users";
+                    star: "star";
+                    trophy: "trophy";
+                    zap: "zap";
+                    flame: "flame";
+                    gift: "gift";
+                    image: "image";
+                    play: "play";
+                    pause: "pause";
+                    wallet: "wallet";
+                    coins: "coins";
+                    plus: "plus";
+                    minus: "minus";
+                    "refresh-cw": "refresh-cw";
+                    bookmark: "bookmark";
+                    "thumbs-up": "thumbs-up";
+                    "thumbs-down": "thumbs-down";
+                    "trending-up": "trending-up";
+                    "trending-down": "trending-down";
+                }>>;
             }, z.core.$strip>;
             description: string;
         };
-        List: {
+        button: {
             props: z.ZodObject<{
-                style: z.ZodOptional<z.ZodEnum<{
-                    ordered: "ordered";
-                    unordered: "unordered";
-                    plain: "plain";
+                label: z.ZodString;
+                variant: z.ZodOptional<z.ZodEnum<{
+                    default: "default";
+                    secondary: "secondary";
+                    outline: "outline";
+                    ghost: "ghost";
+                }>>;
+                icon: z.ZodOptional<z.ZodEnum<{
+                    check: "check";
+                    repeat: "repeat";
+                    "arrow-right": "arrow-right";
+                    "arrow-left": "arrow-left";
+                    "external-link": "external-link";
+                    "chevron-right": "chevron-right";
+                    x: "x";
+                    "alert-triangle": "alert-triangle";
+                    info: "info";
+                    clock: "clock";
+                    heart: "heart";
+                    "message-circle": "message-circle";
+                    share: "share";
+                    user: "user";
+                    users: "users";
+                    star: "star";
+                    trophy: "trophy";
+                    zap: "zap";
+                    flame: "flame";
+                    gift: "gift";
+                    image: "image";
+                    play: "play";
+                    pause: "pause";
+                    wallet: "wallet";
+                    coins: "coins";
+                    plus: "plus";
+                    minus: "minus";
+                    "refresh-cw": "refresh-cw";
+                    bookmark: "bookmark";
+                    "thumbs-up": "thumbs-up";
+                    "thumbs-down": "thumbs-down";
+                    "trending-up": "trending-up";
+                    "trending-down": "trending-down";
                 }>>;
-                items: z.ZodArray<z.ZodObject<{
-                    content: z.ZodString;
-                    trailing: z.ZodOptional<z.ZodString>;
-                }, z.core.$strip>>;
             }, z.core.$strip>;
             description: string;
         };
-        Grid: {
+        switch: {
             props: z.ZodObject<{
-                cols: z.ZodNumber;
-                rows: z.ZodNumber;
-                cells: z.ZodArray<z.ZodObject<{
-                    row: z.ZodNumber;
-                    col: z.ZodNumber;
-                    color: z.ZodOptional<z.ZodString>;
-                    content: z.ZodOptional<z.ZodString>;
-                }, z.core.$strip>>;
-                cellSize: z.ZodOptional<z.ZodEnum<{
-                    auto: "auto";
-                    square: "square";
-                }>>;
-                gap: z.ZodOptional<z.ZodEnum<{
-                    small: "small";
-                    medium: "medium";
-                    none: "none";
-                }>>;
-                interactive: z.ZodOptional<z.ZodBoolean>;
+                name: z.ZodString;
+                label: z.ZodOptional<z.ZodString>;
+                defaultChecked: z.ZodOptional<z.ZodBoolean>;
             }, z.core.$strip>;
             description: string;
         };
-        TextInput: {
+        toggle_group: {
             props: z.ZodObject<{
                 name: z.ZodString;
-                placeholder: z.ZodOptional<z.ZodString>;
-                maxLength: z.ZodOptional<z.ZodNumber>;
+                label: z.ZodOptional<z.ZodString>;
+                multiple: z.ZodOptional<z.ZodBoolean>;
+                orientation: z.ZodOptional<z.ZodEnum<{
+                    horizontal: "horizontal";
+                    vertical: "vertical";
+                }>>;
+                defaultValue: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+                options: z.ZodArray<z.ZodString>;
+                variant: z.ZodOptional<z.ZodEnum<{
+                    default: "default";
+                    outline: "outline";
+                }>>;
             }, z.core.$strip>;
             description: string;
         };
-        Slider: {
+        input: {
             props: z.ZodObject<{
                 name: z.ZodString;
-                min: z.ZodNumber;
-                max: z.ZodNumber;
-                step: z.ZodOptional<z.ZodNumber>;
-                value: z.ZodOptional<z.ZodNumber>;
+                type: z.ZodOptional<z.ZodEnum<{
+                    number: "number";
+                    text: "text";
+                }>>;
                 label: z.ZodOptional<z.ZodString>;
-                minLabel: z.ZodOptional<z.ZodString>;
-                maxLabel: z.ZodOptional<z.ZodString>;
+                placeholder: z.ZodOptional<z.ZodString>;
+                defaultValue: z.ZodOptional<z.ZodString>;
+                maxLength: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>;
             description: string;
         };
-        ButtonGroup: {
-            props: z.ZodPipe<z.ZodObject<{
-                name: z.ZodString;
-                options: z.ZodArray<z.ZodString>;
-                style: z.ZodOptional<z.ZodEnum<{
-                    row: "row";
-                    stack: "stack";
-                    grid: "grid";
+        item: {
+            props: z.ZodObject<{
+                title: z.ZodString;
+                description: z.ZodOptional<z.ZodString>;
+                variant: z.ZodOptional<z.ZodEnum<{
+                    default: "default";
+                    outline: "outline";
+                    muted: "muted";
                 }>>;
-            }, z.core.$strip>, z.ZodTransform<{
-                style: "row" | "stack" | "grid";
-                name: string;
-                options: string[];
-            }, {
-                name: string;
-                options: string[];
-                style?: "row" | "stack" | "grid" | undefined;
-            }>>;
+            }, z.core.$strip>;
             description: string;
         };
-        Toggle: {
+        item_group: {
             props: z.ZodObject<{
-                name: z.ZodString;
-                label: z.ZodString;
-                value: z.ZodDefault<z.ZodBoolean>;
+                border: z.ZodOptional<z.ZodBoolean>;
+                separator: z.ZodOptional<z.ZodBoolean>;
+                gap: z.ZodOptional<z.ZodEnum<{
+                    sm: "sm";
+                    md: "md";
+                    none: "none";
+                    lg: "lg";
+                }>>;
             }, z.core.$strip>;
             description: string;
         };
-        BarChart: {
+        icon: {
             props: z.ZodObject<{
-                bars: z.ZodArray<z.ZodObject<{
-                    label: z.ZodString;
-                    value: z.ZodNumber;
-                    color: z.ZodOptional<z.ZodEnum<{
-                        gray: "gray";
-                        blue: "blue";
-                        red: "red";
-                        amber: "amber";
-                        green: "green";
-                        teal: "teal";
-                        purple: "purple";
-                        pink: "pink";
-                    }>>;
-                }, z.core.$strip>>;
-                max: z.ZodOptional<z.ZodNumber>;
+                name: z.ZodEnum<{
+                    check: "check";
+                    repeat: "repeat";
+                    "arrow-right": "arrow-right";
+                    "arrow-left": "arrow-left";
+                    "external-link": "external-link";
+                    "chevron-right": "chevron-right";
+                    x: "x";
+                    "alert-triangle": "alert-triangle";
+                    info: "info";
+                    clock: "clock";
+                    heart: "heart";
+                    "message-circle": "message-circle";
+                    share: "share";
+                    user: "user";
+                    users: "users";
+                    star: "star";
+                    trophy: "trophy";
+                    zap: "zap";
+                    flame: "flame";
+                    gift: "gift";
+                    image: "image";
+                    play: "play";
+                    pause: "pause";
+                    wallet: "wallet";
+                    coins: "coins";
+                    plus: "plus";
+                    minus: "minus";
+                    "refresh-cw": "refresh-cw";
+                    bookmark: "bookmark";
+                    "thumbs-up": "thumbs-up";
+                    "thumbs-down": "thumbs-down";
+                    "trending-up": "trending-up";
+                    "trending-down": "trending-down";
+                }>;
                 color: z.ZodOptional<z.ZodEnum<{
                     gray: "gray";
                     blue: "blue";
@@ -210,69 +246,158 @@ export declare const snapJsonRenderCatalog: import("@json-render/core").Catalog<
                     pink: "pink";
                     accent: "accent";
                 }>>;
+                size: z.ZodOptional<z.ZodEnum<{
+                    sm: "sm";
+                    md: "md";
+                }>>;
             }, z.core.$strip>;
             description: string;
         };
-        Group: {
+        image: {
             props: z.ZodObject<{
-                layout: z.ZodEnum<{
-                    row: "row";
+                url: z.ZodString;
+                aspect: z.ZodEnum<{
+                    "1:1": "1:1";
+                    "16:9": "16:9";
+                    "4:3": "4:3";
+                    "3:4": "3:4";
+                    "9:16": "9:16";
                 }>;
+                alt: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>;
             description: string;
         };
-        Stack: {
-            props: z.ZodObject<{}, z.core.$strip>;
+        progress: {
+            props: z.ZodObject<{
+                value: z.ZodNumber;
+                max: z.ZodNumber;
+                label: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
             description: string;
         };
-        ActionButton: {
+        separator: {
             props: z.ZodObject<{
-                label: z.ZodString;
-                action: z.ZodEnum<{
-                    post: "post";
-                    link: "link";
-                    mini_app: "mini_app";
-                    client: "client";
-                }>;
-                target: z.ZodOptional<z.ZodString>;
-                client_action: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-                style: z.ZodOptional<z.ZodEnum<{
-                    primary: "primary";
-                    secondary: "secondary";
+                orientation: z.ZodOptional<z.ZodEnum<{
+                    horizontal: "horizontal";
+                    vertical: "vertical";
+                }>>;
+            }, z.core.$strip>;
+            description: string;
+        };
+        slider: {
+            props: z.ZodObject<{
+                name: z.ZodString;
+                min: z.ZodNumber;
+                max: z.ZodNumber;
+                step: z.ZodOptional<z.ZodNumber>;
+                defaultValue: z.ZodOptional<z.ZodNumber>;
+                label: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            description: string;
+        };
+        stack: {
+            props: z.ZodObject<{
+                direction: z.ZodOptional<z.ZodEnum<{
+                    horizontal: "horizontal";
+                    vertical: "vertical";
+                }>>;
+                gap: z.ZodOptional<z.ZodEnum<{
+                    sm: "sm";
+                    md: "md";
+                    none: "none";
+                    lg: "lg";
+                }>>;
+                justify: z.ZodOptional<z.ZodEnum<{
+                    start: "start";
+                    center: "center";
+                    end: "end";
+                    between: "between";
+                    around: "around";
+                }>>;
+            }, z.core.$strip>;
+            description: string;
+        };
+        text: {
+            props: z.ZodObject<{
+                content: z.ZodString;
+                size: z.ZodOptional<z.ZodEnum<{
+                    sm: "sm";
+                    md: "md";
+                    lg: "lg";
+                }>>;
+                weight: z.ZodOptional<z.ZodEnum<{
+                    bold: "bold";
+                    medium: "medium";
+                    normal: "normal";
+                }>>;
+                align: z.ZodOptional<z.ZodEnum<{
+                    center: "center";
+                    left: "left";
+                    right: "right";
                 }>>;
             }, z.core.$strip>;
             description: string;
         };
     };
     actions: {
-        snap_post: {
+        submit: {
             description: string;
             params: z.ZodObject<{
-                button_index: z.ZodNumber;
                 target: z.ZodString;
-                label: z.ZodOptional<z.ZodString>;
-                style: z.ZodOptional<z.ZodEnum<{
-                    primary: "primary";
-                    secondary: "secondary";
-                }>>;
             }, z.core.$strip>;
         };
-        snap_link: {
+        open_url: {
             description: string;
             params: z.ZodObject<{
                 target: z.ZodString;
             }, z.core.$strip>;
         };
-        snap_mini_app: {
+        open_mini_app: {
             description: string;
             params: z.ZodObject<{
                 target: z.ZodString;
             }, z.core.$strip>;
         };
-        snap_client: {
+        view_cast: {
+            description: string;
+            params: z.ZodObject<{
+                hash: z.ZodString;
+            }, z.core.$strip>;
+        };
+        view_profile: {
+            description: string;
+            params: z.ZodObject<{
+                fid: z.ZodNumber;
+            }, z.core.$strip>;
+        };
+        compose_cast: {
+            description: string;
+            params: z.ZodObject<{
+                text: z.ZodOptional<z.ZodString>;
+                channelKey: z.ZodOptional<z.ZodString>;
+                embeds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            }, z.core.$strip>;
+        };
+        view_token: {
+            description: string;
+            params: z.ZodObject<{
+                token: z.ZodString;
+            }, z.core.$strip>;
+        };
+        send_token: {
+            description: string;
+            params: z.ZodObject<{
+                token: z.ZodString;
+                amount: z.ZodOptional<z.ZodString>;
+                recipientFid: z.ZodOptional<z.ZodNumber>;
+                recipientAddress: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+        };
+        swap_token: {
             description: string;
             params: z.ZodObject<{
-                client_action: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                sellToken: z.ZodOptional<z.ZodString>;
+                buyToken: z.ZodOptional<z.ZodString>;
             }, z.core.$strip>;
         };
     };