@farcaster/frame-core 0.0.28 → 0.0.29

package/esm/schemas/manifest.d.ts

@@ -1,112 +1,156 @@
-import { z } from 'zod';
-export declare const domainFrameConfigSchema: z.ZodObject<{
-    version: z.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
-    name: z.ZodString;
-    iconUrl: z.ZodString;
-    homeUrl: z.ZodString;
-    imageUrl: z.ZodOptional<z.ZodString>;
-    buttonTitle: z.ZodOptional<z.ZodString>;
-    splashImageUrl: z.ZodOptional<z.ZodString>;
-    splashBackgroundColor: z.ZodOptional<z.ZodString>;
-    webhookUrl: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    version: "next" | "0.0.0" | "0.0.1" | "1";
-    iconUrl: string;
-    homeUrl: string;
-    splashImageUrl?: string | undefined;
-    splashBackgroundColor?: string | undefined;
-    imageUrl?: string | undefined;
-    buttonTitle?: string | undefined;
-    webhookUrl?: string | undefined;
-}, {
-    name: string;
-    version: "next" | "0.0.0" | "0.0.1" | "1";
-    iconUrl: string;
-    homeUrl: string;
-    splashImageUrl?: string | undefined;
-    splashBackgroundColor?: string | undefined;
-    imageUrl?: string | undefined;
-    buttonTitle?: string | undefined;
-    webhookUrl?: string | undefined;
-}>;
-export declare const domainManifestSchema: 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.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
-        name: z.ZodString;
-        iconUrl: z.ZodString;
-        homeUrl: z.ZodString;
-        imageUrl: z.ZodOptional<z.ZodString>;
-        buttonTitle: z.ZodOptional<z.ZodString>;
-        splashImageUrl: z.ZodOptional<z.ZodString>;
-        splashBackgroundColor: z.ZodOptional<z.ZodString>;
-        webhookUrl: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
-        iconUrl: string;
-        homeUrl: string;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-        imageUrl?: string | undefined;
-        buttonTitle?: string | undefined;
-        webhookUrl?: string | undefined;
-    }, {
-        name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
-        iconUrl: string;
-        homeUrl: string;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-        imageUrl?: string | undefined;
-        buttonTitle?: string | undefined;
-        webhookUrl?: string | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
+import type { z } from 'zod'
+export declare const domainFrameConfigSchema: z.ZodObject<
+  {
+    version: z.ZodUnion<
+      [
+        z.ZodLiteral<'0.0.0'>,
+        z.ZodLiteral<'0.0.1'>,
+        z.ZodLiteral<'1'>,
+        z.ZodLiteral<'next'>,
+      ]
+    >
+    name: z.ZodString
+    iconUrl: z.ZodString
+    homeUrl: z.ZodString
+    imageUrl: z.ZodOptional<z.ZodString>
+    buttonTitle: z.ZodOptional<z.ZodString>
+    splashImageUrl: z.ZodOptional<z.ZodString>
+    splashBackgroundColor: z.ZodOptional<z.ZodString>
+    webhookUrl: z.ZodOptional<z.ZodString>
+  },
+  'strip',
+  z.ZodTypeAny,
+  {
+    name: string
+    version: 'next' | '0.0.0' | '0.0.1' | '1'
+    iconUrl: string
+    homeUrl: string
+    splashImageUrl?: string | undefined
+    splashBackgroundColor?: string | undefined
+    imageUrl?: string | undefined
+    buttonTitle?: string | undefined
+    webhookUrl?: string | undefined
+  },
+  {
+    name: string
+    version: 'next' | '0.0.0' | '0.0.1' | '1'
+    iconUrl: string
+    homeUrl: string
+    splashImageUrl?: string | undefined
+    splashBackgroundColor?: string | undefined
+    imageUrl?: string | undefined
+    buttonTitle?: string | undefined
+    webhookUrl?: string | undefined
+  }
+>
+export declare const domainManifestSchema: 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.ZodUnion<
+            [
+              z.ZodLiteral<'0.0.0'>,
+              z.ZodLiteral<'0.0.1'>,
+              z.ZodLiteral<'1'>,
+              z.ZodLiteral<'next'>,
+            ]
+          >
+          name: z.ZodString
+          iconUrl: z.ZodString
+          homeUrl: z.ZodString
+          imageUrl: z.ZodOptional<z.ZodString>
+          buttonTitle: z.ZodOptional<z.ZodString>
+          splashImageUrl: z.ZodOptional<z.ZodString>
+          splashBackgroundColor: z.ZodOptional<z.ZodString>
+          webhookUrl: z.ZodOptional<z.ZodString>
+        },
+        'strip',
+        z.ZodTypeAny,
+        {
+          name: string
+          version: 'next' | '0.0.0' | '0.0.1' | '1'
+          iconUrl: string
+          homeUrl: string
+          splashImageUrl?: string | undefined
+          splashBackgroundColor?: string | undefined
+          imageUrl?: string | undefined
+          buttonTitle?: string | undefined
+          webhookUrl?: string | undefined
+        },
+        {
+          name: string
+          version: 'next' | '0.0.0' | '0.0.1' | '1'
+          iconUrl: string
+          homeUrl: string
+          splashImageUrl?: string | undefined
+          splashBackgroundColor?: string | undefined
+          imageUrl?: string | undefined
+          buttonTitle?: string | undefined
+          webhookUrl?: string | undefined
+        }
+      >
+    >
+  },
+  'strip',
+  z.ZodTypeAny,
+  {
     accountAssociation: {
-        header: string;
-        payload: string;
-        signature: string;
-    };
-    frame?: {
-        name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
-        iconUrl: string;
-        homeUrl: string;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-        imageUrl?: string | undefined;
-        buttonTitle?: string | undefined;
-        webhookUrl?: string | undefined;
-    } | undefined;
-}, {
+      header: string
+      payload: string
+      signature: string
+    }
+    frame?:
+      | {
+          name: string
+          version: 'next' | '0.0.0' | '0.0.1' | '1'
+          iconUrl: string
+          homeUrl: string
+          splashImageUrl?: string | undefined
+          splashBackgroundColor?: string | undefined
+          imageUrl?: string | undefined
+          buttonTitle?: string | undefined
+          webhookUrl?: string | undefined
+        }
+      | undefined
+  },
+  {
     accountAssociation: {
-        header: string;
-        payload: string;
-        signature: string;
-    };
-    frame?: {
-        name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
-        iconUrl: string;
-        homeUrl: string;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-        imageUrl?: string | undefined;
-        buttonTitle?: string | undefined;
-        webhookUrl?: string | undefined;
-    } | undefined;
-}>;
+      header: string
+      payload: string
+      signature: string
+    }
+    frame?:
+      | {
+          name: string
+          version: 'next' | '0.0.0' | '0.0.1' | '1'
+          iconUrl: string
+          homeUrl: string
+          splashImageUrl?: string | undefined
+          splashBackgroundColor?: string | undefined
+          imageUrl?: string | undefined
+          buttonTitle?: string | undefined
+          webhookUrl?: string | undefined
+        }
+      | undefined
+  }
+>

package/esm/schemas/manifest.js

@@ -1,25 +1,31 @@
-import { z } from 'zod';
-import { buttonTitleSchema, encodedJsonFarcasterSignatureSchema, frameNameSchema, hexColorSchema, secureUrlSchema, } from './shared';
+import { z } from 'zod'
+import {
+  buttonTitleSchema,
+  encodedJsonFarcasterSignatureSchema,
+  frameNameSchema,
+  hexColorSchema,
+  secureUrlSchema,
+} from './shared'
 export const domainFrameConfigSchema = z.object({
-    // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
-    // backwards compatibilty. next should always resolve to the most recent
-    // schema version.
-    version: z.union([
-        z.literal('0.0.0'),
-        z.literal('0.0.1'),
-        z.literal('1'),
-        z.literal('next'),
-    ]),
-    name: frameNameSchema,
-    iconUrl: secureUrlSchema,
-    homeUrl: secureUrlSchema,
-    imageUrl: secureUrlSchema.optional(),
-    buttonTitle: buttonTitleSchema.optional(),
-    splashImageUrl: secureUrlSchema.optional(),
-    splashBackgroundColor: hexColorSchema.optional(),
-    webhookUrl: secureUrlSchema.optional(),
-});
+  // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
+  // backwards compatibilty. next should always resolve to the most recent
+  // schema version.
+  version: z.union([
+    z.literal('0.0.0'),
+    z.literal('0.0.1'),
+    z.literal('1'),
+    z.literal('next'),
+  ]),
+  name: frameNameSchema,
+  iconUrl: secureUrlSchema,
+  homeUrl: secureUrlSchema,
+  imageUrl: secureUrlSchema.optional(),
+  buttonTitle: buttonTitleSchema.optional(),
+  splashImageUrl: secureUrlSchema.optional(),
+  splashBackgroundColor: hexColorSchema.optional(),
+  webhookUrl: secureUrlSchema.optional(),
+})
 export const domainManifestSchema = z.object({
-    accountAssociation: encodedJsonFarcasterSignatureSchema,
-    frame: domainFrameConfigSchema.optional(),
-});
+  accountAssociation: encodedJsonFarcasterSignatureSchema,
+  frame: domainFrameConfigSchema.optional(),
+})

package/esm/schemas/notifications.d.ts

@@ -1,60 +1,88 @@
-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, {
+import type { 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[];
-    };
-}, {
+      successfulTokens: string[]
+      invalidTokens: string[]
+      rateLimitedTokens: string[]
+    }
+  },
+  {
     result: {
-        successfulTokens: string[];
-        invalidTokens: string[];
-        rateLimitedTokens: string[];
-    };
-}>;
-export type SendNotificationResponse = z.infer<typeof sendNotificationResponseSchema>;
+      successfulTokens: string[]
+      invalidTokens: string[]
+      rateLimitedTokens: string[]
+    }
+  }
+>
+export type SendNotificationResponse = z.infer<
+  typeof sendNotificationResponseSchema
+>

package/esm/schemas/notifications.js

@@ -1,20 +1,20 @@
-import { z } from 'zod';
-import { secureUrlSchema } from './shared';
+import { z } from 'zod'
+import { secureUrlSchema } from './shared'
 export const notificationDetailsSchema = z.object({
-    url: z.string(),
-    token: z.string(),
-});
+  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),
-});
+  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()),
-    }),
-});
+  result: z.object({
+    successfulTokens: z.array(z.string()),
+    invalidTokens: z.array(z.string()),
+    rateLimitedTokens: z.array(z.string()),
+  }),
+})

package/esm/schemas/shared.d.ts

@@ -1,35 +1,53 @@
-import { z } from 'zod';
-export declare const secureUrlSchema: z.ZodString;
-export declare const frameNameSchema: z.ZodString;
-export declare const buttonTitleSchema: z.ZodString;
-export declare const caip19TokenSchema: z.ZodString;
-export declare const hexColorSchema: z.ZodString;
-export declare const aspectRatioSchema: z.ZodUnion<[z.ZodLiteral<"1:1">, z.ZodLiteral<"3:2">]>;
-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>;
+import type { z } from 'zod'
+export declare const secureUrlSchema: z.ZodString
+export declare const frameNameSchema: z.ZodString
+export declare const buttonTitleSchema: z.ZodString
+export declare const caip19TokenSchema: z.ZodString
+export declare const hexColorSchema: z.ZodString
+export declare const aspectRatioSchema: z.ZodUnion<
+  [z.ZodLiteral<'1:1'>, z.ZodLiteral<'3:2'>]
+>
+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/esm/schemas/shared.js

@@ -1,28 +1,30 @@
-import { z } from 'zod';
+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 buttonTitleSchema = z.string().max(32);
-const CAIP_19_REGEX = /^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\/(?:[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}(?:\/[-.%a-zA-Z0-9]{1,78})?|native)$/;
+  .string()
+  .url()
+  .startsWith('https://', { message: 'Must be an https url' })
+  .max(512)
+export const frameNameSchema = z.string().max(32)
+export const buttonTitleSchema = z.string().max(32)
+const CAIP_19_REGEX =
+  /^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\/(?:[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}(?:\/[-.%a-zA-Z0-9]{1,78})?|native)$/
 export const caip19TokenSchema = z
-    .string()
-    .regex(CAIP_19_REGEX, { message: 'Invalid CAIP-19 asset ID' });
+  .string()
+  .regex(CAIP_19_REGEX, { message: 'Invalid CAIP-19 asset ID' })
 export const hexColorSchema = z
-    .string()
-    .regex(/^#([0-9A-F]{3}|[0-9A-F]{6})$/i, {
-    message: 'Invalid hex color code. It should be in the format #RRGGBB or #RGB.',
-});
-export const aspectRatioSchema = z.union([z.literal('1:1'), z.literal('3:2')]);
+  .string()
+  .regex(/^#([0-9A-F]{3}|[0-9A-F]{6})$/i, {
+    message:
+      'Invalid hex color code. It should be in the format #RRGGBB or #RGB.',
+  })
+export const aspectRatioSchema = z.union([z.literal('1:1'), z.literal('3:2')])
 export const encodedJsonFarcasterSignatureSchema = z.object({
-    header: z.string(),
-    payload: z.string(),
-    signature: z.string(),
-});
+  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'),
-});
+  fid: z.number(),
+  type: z.literal('app_key'),
+  key: z.string().startsWith('0x'),
+})