@farcaster/frame-core 0.0.21 → 0.0.23

package/esm/actions/AddFrame.js

@@ -0,0 +1,19 @@
+import * as Errors from '../errors'
+/**
+ * Thrown when the frame does not have a valid domain manifest.
+ */
+export class InvalidDomainManifest extends Errors.BaseError {
+  name = 'AddFrame.InvalidDomainManifest'
+  constructor() {
+    super('Invalid domain manifest')
+  }
+}
+/**
+ * Thrown when add frame action was rejected by the user.
+ */
+export class RejectedByUser extends Errors.BaseError {
+  name = 'AddFrame.RejectedByUser'
+  constructor() {
+    super('Add frame rejected by user')
+  }
+}

package/esm/actions/SignIn.d.ts

@@ -0,0 +1,43 @@
+import * as Errors from '../errors'
+import type { OneOf } from '../internal/types'
+export type SignInOptions = {
+  /**
+   * A random string used to prevent replay attacks.
+   */
+  nonce: string
+  /**
+   * Start time at which the signature becomes valid.
+   * ISO 8601 datetime.
+   */
+  notBefore?: string
+  /**
+   * Expiration time at which the signature is no longer valid.
+   * ISO 8601 datetime.
+   */
+  expirationTime?: string
+}
+export type SignInResult = {
+  signature: string
+  message: string
+}
+export type SignIn = (options: SignInOptions) => Promise<SignInResult>
+type RejectedByUserJsonError = {
+  type: 'rejected_by_user'
+}
+export type SignInJsonError = RejectedByUserJsonError
+export type SignInJsonResult = OneOf<
+  | {
+      result: SignInResult
+    }
+  | {
+      error: SignInJsonError
+    }
+>
+export type WireSignIn = (options: SignInOptions) => Promise<SignInJsonResult>
+/**
+ * Thrown when a sign in action was rejected.
+ */
+export declare class RejectedByUser extends Errors.BaseError {
+  readonly name = 'SignIn.RejectedByUser'
+  constructor()
+}

package/esm/actions/SignIn.js

@@ -0,0 +1,10 @@
+import * as Errors from '../errors'
+/**
+ * Thrown when a sign in action was rejected.
+ */
+export class RejectedByUser extends Errors.BaseError {
+  name = 'SignIn.RejectedByUser'
+  constructor() {
+    super('Sign in rejected by user')
+  }
+}

package/esm/actions/index.d.ts

@@ -0,0 +1,2 @@
+export * as AddFrame from './AddFrame'
+export * as SignIn from './SignIn'

package/esm/actions/index.js

@@ -0,0 +1,2 @@
+export * as AddFrame from './AddFrame'
+export * as SignIn from './SignIn'

package/esm/context.d.ts

@@ -0,0 +1,76 @@
+import type { FrameNotificationDetails } from './schemas'
+export type CastEmbedLocationContext = {
+  type: 'cast_embed'
+  embed: string
+  cast: {
+    fid: number
+    hash: string
+  }
+}
+export type NotificationLocationContext = {
+  type: 'notification'
+  notification: {
+    notificationId: string
+    title: string
+    body: string
+  }
+}
+export type LauncherLocationContext = {
+  type: 'launcher'
+}
+export type ChannelLocationContext = {
+  type: 'channel'
+  channel: {
+    /**
+     * Channel key identifier
+     */
+    key: string
+    /**
+     * Channel name
+     */
+    name: string
+    /**
+     * Channel profile image URL
+     */
+    imageUrl?: string
+  }
+}
+export type LocationContext =
+  | CastEmbedLocationContext
+  | NotificationLocationContext
+  | LauncherLocationContext
+  | ChannelLocationContext
+export type AccountLocation = {
+  placeId: string
+  /**
+   * Human-readable string describing the location
+   */
+  description: string
+}
+export type UserContext = {
+  fid: number
+  username?: string
+  displayName?: string
+  /**
+   * Profile image URL
+   */
+  pfpUrl?: string
+  location?: AccountLocation
+}
+export type SafeAreaInsets = {
+  top: number
+  bottom: number
+  left: number
+  right: number
+}
+export type ClientContext = {
+  clientFid: number
+  added: boolean
+  notificationDetails?: FrameNotificationDetails
+  safeAreaInsets?: SafeAreaInsets
+}
+export type FrameContext = {
+  client: ClientContext
+  user: UserContext
+  location?: LocationContext
+}

package/esm/context.js

@@ -0,0 +1 @@
+export {}

package/esm/errors.d.ts

@@ -1,10 +1,12 @@
-export declare class BaseError<cause extends Error | undefined = undefined> extends Error {
-    name: string;
-    cause: cause;
-    constructor(message: string, options?: BaseError.Options<cause>);
+export declare class BaseError<
+  cause extends Error | undefined = undefined,
+> extends Error {
+  name: string
+  cause: cause
+  constructor(message: string, options?: BaseError.Options<cause>)
 }
 export declare namespace BaseError {
-    type Options<cause extends Error | undefined = Error | undefined> = {
-        cause?: cause | undefined;
-    };
+  type Options<cause extends Error | undefined = Error | undefined> = {
+    cause?: cause | undefined
+  }
 }

package/esm/errors.js

@@ -1,8 +1,8 @@
 export class BaseError extends Error {
-    name = "BaseError";
-    cause;
-    constructor(message, options = {}) {
-        super(message, options.cause ? { cause: options.cause } : undefined);
-        this.cause = options.cause;
-    }
+  name = 'BaseError'
+  cause
+  constructor(message, options = {}) {
+    super(message, options.cause ? { cause: options.cause } : undefined)
+    this.cause = options.cause
+  }
 }

package/esm/index.d.ts

@@ -1,3 +1,4 @@
-export * as SignIn from "./actions/signIn";
-export * from "./types";
-export * from "./schemas";
+export * from './actions'
+export * as Context from './context'
+export * from './types'
+export * from './schemas'

package/esm/index.js

@@ -1,3 +1,4 @@
-export * as SignIn from "./actions/signIn";
-export * from "./types";
-export * from "./schemas";
+export * from './actions'
+export * as Context from './context'
+export * from './types'
+export * from './schemas'

package/esm/internal/types.d.ts

@@ -1,7 +1,19 @@
-export type Compute<type> = {
-    [key in keyof type]: type[key];
-} & unknown;
-export type OneOf<union extends object, fallback extends object | undefined = undefined, keys extends KeyofUnion<union> = KeyofUnion<union>> = union extends infer item ? Compute<item & {
-    [key in Exclude<keys, keyof item>]?: fallback extends object ? key extends keyof fallback ? fallback[key] : undefined : undefined;
-}> : never;
-export type KeyofUnion<type> = type extends type ? keyof type : never;
+type Compute<type> = {
+  [key in keyof type]: type[key]
+} & unknown
+type KeyofUnion<type> = type extends type ? keyof type : never
+export type OneOf<
+  union extends object,
+  fallback extends object | undefined = undefined,
+  keys extends KeyofUnion<union> = KeyofUnion<union>,
+> = union extends infer item
+  ? Compute<
+      item & {
+        [key in Exclude<keys, keyof item>]?: fallback extends object
+          ? key extends keyof fallback
+            ? fallback[key]
+            : undefined
+          : undefined
+      }
+    >
+  : never

package/esm/internal/types.js

@@ -1 +1 @@
-export {};
+export {}

package/esm/schemas/embeds.d.ts

@@ -1,177 +1,239 @@
-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.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.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 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.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;
+import type { 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.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.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 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.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;
+      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.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;
+      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.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;
+          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;
+          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;
+      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;
+      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;
+      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>;
+      title: string
+      action: {
+        type: 'launch_frame'
+        name: string
+        url: string
+        splashImageUrl?: string | undefined
+        splashBackgroundColor?: string | undefined
+      }
+    }
+  }
+>
+export type FrameEmbedNext = z.infer<typeof frameEmbedNextSchema>