@farcaster/frame-core 0.0.10 → 0.0.12

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from "./types";
+export * from "./schemas";

package/dist/index.js

@@ -1 +1,2 @@
 export * from "./types";
+export * from "./schemas";

package/dist/schemas/embeds.d.ts

@@ -0,0 +1,178 @@
+import { z } from 'zod';
+export declare const actionLaunchFrameSchema: z.ZodObject<{
+    type: z.ZodLiteral<"launch_frame">;
+    name: z.ZodString;
+    url: z.ZodString;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "launch_frame";
+    name: string;
+    url: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}, {
+    type: "launch_frame";
+    name: string;
+    url: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}>;
+export declare const actionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"launch_frame">;
+    name: z.ZodString;
+    url: z.ZodString;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "launch_frame";
+    name: string;
+    url: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}, {
+    type: "launch_frame";
+    name: string;
+    url: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}>]>;
+export declare const buttonTitleSchema: z.ZodString;
+export declare const buttonSchema: z.ZodObject<{
+    title: z.ZodString;
+    action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"launch_frame">;
+        name: z.ZodString;
+        url: z.ZodString;
+        splashImageUrl: z.ZodOptional<z.ZodString>;
+        splashBackgroundColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "launch_frame";
+        name: string;
+        url: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    }, {
+        type: "launch_frame";
+        name: string;
+        url: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    action: {
+        type: "launch_frame";
+        name: string;
+        url: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    };
+}, {
+    title: string;
+    action: {
+        type: "launch_frame";
+        name: string;
+        url: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    };
+}>;
+export declare const frameEmbedNextSchema: z.ZodObject<{
+    version: z.ZodLiteral<"next">;
+    imageUrl: z.ZodString;
+    button: z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"launch_frame">;
+            name: z.ZodString;
+            url: z.ZodString;
+            splashImageUrl: z.ZodOptional<z.ZodString>;
+            splashBackgroundColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        }, {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        }>]>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    }, {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    };
+}, {
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    };
+}>;
+export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.SafeParseReturnType<{
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    };
+}, {
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url: string;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    };
+}>;
+export type FrameEmbedNext = z.infer<typeof frameEmbedNextSchema>;

package/dist/schemas/embeds.js

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+import { colorValueSchema, frameNameSchema, secureUrlSchema } from './shared';
+export const actionLaunchFrameSchema = z.object({
+    type: z.literal('launch_frame'),
+    name: frameNameSchema,
+    url: secureUrlSchema,
+    splashImageUrl: secureUrlSchema.optional(),
+    splashBackgroundColor: colorValueSchema.optional(),
+});
+export const actionSchema = z.discriminatedUnion('type', [actionLaunchFrameSchema]);
+export const buttonTitleSchema = z.string().max(32);
+export const buttonSchema = z.object({
+    title: buttonTitleSchema,
+    action: actionSchema,
+});
+export const frameEmbedNextSchema = z.object({
+    version: z.literal('next'),
+    imageUrl: secureUrlSchema,
+    button: buttonSchema,
+});
+export const safeParseFrameEmbed = (rawResponse) => frameEmbedNextSchema.safeParse(rawResponse);

package/dist/schemas/events.d.ts

@@ -0,0 +1,131 @@
+import { z } from 'zod';
+export declare const eventFrameAddedPayloadSchema: z.ZodObject<{
+    event: z.ZodLiteral<"frame_added">;
+    notificationDetails: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        token: string;
+    }, {
+        url: string;
+        token: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    event: "frame_added";
+    notificationDetails?: {
+        url: string;
+        token: string;
+    } | undefined;
+}, {
+    event: "frame_added";
+    notificationDetails?: {
+        url: string;
+        token: string;
+    } | undefined;
+}>;
+export type EventFrameAddedPayload = z.infer<typeof eventFrameAddedPayloadSchema>;
+export declare const eventFrameRemovedPayloadSchema: z.ZodObject<{
+    event: z.ZodLiteral<"frame_removed">;
+}, "strip", z.ZodTypeAny, {
+    event: "frame_removed";
+}, {
+    event: "frame_removed";
+}>;
+export type EventFrameRemovedPayload = z.infer<typeof eventFrameRemovedPayloadSchema>;
+export declare const eventNotificationsEnabledPayloadSchema: z.ZodObject<{
+    event: z.ZodLiteral<"notifications_enabled">;
+    notificationDetails: z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        token: string;
+    }, {
+        url: string;
+        token: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    event: "notifications_enabled";
+    notificationDetails: {
+        url: string;
+        token: string;
+    };
+}, {
+    event: "notifications_enabled";
+    notificationDetails: {
+        url: string;
+        token: string;
+    };
+}>;
+export type EventNotificationsEnabledPayload = z.infer<typeof eventNotificationsEnabledPayloadSchema>;
+export declare const notificationsDisabledPayloadSchema: z.ZodObject<{
+    event: z.ZodLiteral<"notifications_disabled">;
+}, "strip", z.ZodTypeAny, {
+    event: "notifications_disabled";
+}, {
+    event: "notifications_disabled";
+}>;
+export type EventNotificationsDisabledPayload = z.infer<typeof notificationsDisabledPayloadSchema>;
+export declare const eventPayloadSchema: z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
+    event: z.ZodLiteral<"frame_added">;
+    notificationDetails: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        token: string;
+    }, {
+        url: string;
+        token: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    event: "frame_added";
+    notificationDetails?: {
+        url: string;
+        token: string;
+    } | undefined;
+}, {
+    event: "frame_added";
+    notificationDetails?: {
+        url: string;
+        token: string;
+    } | undefined;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"frame_removed">;
+}, "strip", z.ZodTypeAny, {
+    event: "frame_removed";
+}, {
+    event: "frame_removed";
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"notifications_enabled">;
+    notificationDetails: z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        token: string;
+    }, {
+        url: string;
+        token: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    event: "notifications_enabled";
+    notificationDetails: {
+        url: string;
+        token: string;
+    };
+}, {
+    event: "notifications_enabled";
+    notificationDetails: {
+        url: string;
+        token: string;
+    };
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"notifications_disabled">;
+}, "strip", z.ZodTypeAny, {
+    event: "notifications_disabled";
+}, {
+    event: "notifications_disabled";
+}>]>;
+export type FrameEvent = z.infer<typeof eventPayloadSchema>;

package/dist/schemas/events.js

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+import { notificationDetailsSchema } from './notifications';
+export const eventFrameAddedPayloadSchema = z.object({
+    event: z.literal("frame_added"),
+    notificationDetails: notificationDetailsSchema.optional(),
+});
+export const eventFrameRemovedPayloadSchema = z.object({
+    event: z.literal("frame_removed"),
+});
+export const eventNotificationsEnabledPayloadSchema = z.object({
+    event: z.literal("notifications_enabled"),
+    notificationDetails: notificationDetailsSchema.required(),
+});
+export const notificationsDisabledPayloadSchema = z.object({
+    event: z.literal("notifications_disabled"),
+});
+export const eventPayloadSchema = z.discriminatedUnion("event", [
+    eventFrameAddedPayloadSchema,
+    eventFrameRemovedPayloadSchema,
+    eventNotificationsEnabledPayloadSchema,
+    notificationsDisabledPayloadSchema,
+]);

package/dist/schemas/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./embeds";
+export * from "./events";
+export * from "./shared";
+export * from "./manifest";
+export * from "./notifications";

package/dist/schemas/index.js

@@ -0,0 +1,5 @@
+export * from "./embeds";
+export * from "./events";
+export * from "./shared";
+export * from "./manifest";
+export * from "./notifications";

package/dist/schemas/manifest.d.ts

@@ -0,0 +1,96 @@
+import { z } from 'zod';
+export declare const domainFrameConfig: z.ZodObject<{
+    version: z.ZodString;
+    name: z.ZodString;
+    iconUrl: z.ZodString;
+    homeUrl: z.ZodString;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+    webhookUrl: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    version: string;
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    webhookUrl?: string | undefined;
+}, {
+    name: string;
+    version: string;
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    webhookUrl?: string | undefined;
+}>;
+export declare const domainManifest: z.ZodObject<{
+    accountAssociation: z.ZodObject<{
+        header: z.ZodString;
+        payload: z.ZodString;
+        signature: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        header: string;
+        payload: string;
+        signature: string;
+    }, {
+        header: string;
+        payload: string;
+        signature: string;
+    }>;
+    frame: z.ZodOptional<z.ZodObject<{
+        version: z.ZodString;
+        name: z.ZodString;
+        iconUrl: z.ZodString;
+        homeUrl: z.ZodString;
+        splashImageUrl: z.ZodOptional<z.ZodString>;
+        splashBackgroundColor: z.ZodOptional<z.ZodOptional<z.ZodString>>;
+        webhookUrl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        version: string;
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        webhookUrl?: string | undefined;
+    }, {
+        name: string;
+        version: string;
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        webhookUrl?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    accountAssociation: {
+        header: string;
+        payload: string;
+        signature: string;
+    };
+    frame?: {
+        name: string;
+        version: string;
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        webhookUrl?: string | undefined;
+    } | undefined;
+}, {
+    accountAssociation: {
+        header: string;
+        payload: string;
+        signature: string;
+    };
+    frame?: {
+        name: string;
+        version: string;
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        webhookUrl?: string | undefined;
+    } | undefined;
+}>;

package/dist/schemas/manifest.js

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+import { secureUrlSchema, frameNameSchema, colorValueSchema, encodedJsonFarcasterSignatureSchema } from './shared';
+export const domainFrameConfig = z.object({
+    version: z.string(),
+    name: frameNameSchema,
+    iconUrl: secureUrlSchema,
+    homeUrl: secureUrlSchema,
+    splashImageUrl: secureUrlSchema.optional(),
+    splashBackgroundColor: colorValueSchema.optional(),
+    webhookUrl: secureUrlSchema.optional()
+});
+export const domainManifest = z.object({
+    accountAssociation: encodedJsonFarcasterSignatureSchema,
+    frame: domainFrameConfig.optional(),
+});

package/dist/schemas/notifications.d.ts

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+export declare const notificationDetailsSchema: z.ZodObject<{
+    url: z.ZodString;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    token: string;
+}, {
+    url: string;
+    token: string;
+}>;
+export type FrameNotificationDetails = z.infer<typeof notificationDetailsSchema>;
+export declare const sendNotificationRequestSchema: z.ZodObject<{
+    notificationId: z.ZodString;
+    title: z.ZodString;
+    body: z.ZodString;
+    targetUrl: z.ZodString;
+    tokens: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    notificationId: string;
+    body: string;
+    targetUrl: string;
+    tokens: string[];
+}, {
+    title: string;
+    notificationId: string;
+    body: string;
+    targetUrl: string;
+    tokens: string[];
+}>;
+export type SendNotificationRequest = z.infer<typeof sendNotificationRequestSchema>;
+export declare const sendNotificationResponseSchema: z.ZodObject<{
+    result: z.ZodObject<{
+        successfulTokens: z.ZodArray<z.ZodString, "many">;
+        invalidTokens: z.ZodArray<z.ZodString, "many">;
+        rateLimitedTokens: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    }, {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    result: {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    };
+}, {
+    result: {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    };
+}>;
+export type SendNotificationResponse = z.infer<typeof sendNotificationResponseSchema>;

package/dist/schemas/notifications.js

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+import { secureUrlSchema } from './shared';
+export const notificationDetailsSchema = z.object({
+    url: z.string(),
+    token: z.string(),
+});
+export const sendNotificationRequestSchema = z.object({
+    notificationId: z.string().max(128),
+    title: z.string().max(32),
+    body: z.string().max(128),
+    targetUrl: secureUrlSchema,
+    tokens: z.string().array().max(100),
+});
+export const sendNotificationResponseSchema = z.object({
+    result: z.object({
+        successfulTokens: z.array(z.string()),
+        invalidTokens: z.array(z.string()),
+        rateLimitedTokens: z.array(z.string()),
+    }),
+});

package/dist/schemas/shared.d.ts

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+export declare const secureUrlSchema: z.ZodString;
+export declare const frameNameSchema: z.ZodString;
+export declare const colorValueSchema: z.ZodOptional<z.ZodString>;
+export declare const encodedJsonFarcasterSignatureSchema: z.ZodObject<{
+    header: z.ZodString;
+    payload: z.ZodString;
+    signature: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    header: string;
+    payload: string;
+    signature: string;
+}, {
+    header: string;
+    payload: string;
+    signature: string;
+}>;
+export type EncodedJsonFarcasterSignatureSchema = z.infer<typeof encodedJsonFarcasterSignatureSchema>;
+export declare const jsonFarcasterSignatureHeaderSchema: z.ZodObject<{
+    fid: z.ZodNumber;
+    type: z.ZodLiteral<"app_key">;
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "app_key";
+    fid: number;
+    key: string;
+}, {
+    type: "app_key";
+    fid: number;
+    key: string;
+}>;
+export type JsonFarcasterSignatureHeaderSchema = z.infer<typeof jsonFarcasterSignatureHeaderSchema>;

package/dist/schemas/shared.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export const secureUrlSchema = z.string().url().startsWith('https://', { message: 'Must be an https url' }).max(512);
+export const frameNameSchema = z.string().max(32);
+export const colorValueSchema = z.string().max(9).optional();
+export const encodedJsonFarcasterSignatureSchema = z.object({
+    header: z.string(),
+    payload: z.string(),
+    signature: z.string(),
+});
+export const jsonFarcasterSignatureHeaderSchema = z.object({
+    fid: z.number(),
+    type: z.literal("app_key"),
+    key: z.string().startsWith("0x"),
+});