@farcaster/frame-core 0.0.23 → 0.0.25

package/dist/actions/ViewProfile.d.ts

@@ -0,0 +1,4 @@
+export type ViewProfileOptions = {
+    fid: number;
+};
+export type ViewProfile = (options: ViewProfileOptions) => Promise<void>;

package/dist/actions/ViewProfile.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/actions/index.d.ts

@@ -1,2 +1,3 @@
 export * as AddFrame from './AddFrame';
+export * as ViewProfile from './ViewProfile';
 export * as SignIn from './SignIn';

package/dist/actions/index.js

@@ -33,6 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SignIn = exports.AddFrame = void 0;
+exports.SignIn = exports.ViewProfile = exports.AddFrame = void 0;
 exports.AddFrame = __importStar(require("./AddFrame"));
+exports.ViewProfile = __importStar(require("./ViewProfile"));
 exports.SignIn = __importStar(require("./SignIn"));

package/dist/schemas/embeds.d.ts

@@ -18,6 +18,16 @@ export declare const actionLaunchFrameSchema: z.ZodObject<{
     splashImageUrl?: string | undefined;
     splashBackgroundColor?: string | undefined;
 }>;
+export declare const actionViewTokenSchema: z.ZodObject<{
+    type: z.ZodLiteral<"view_token">;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "view_token";
+    token: string;
+}, {
+    type: "view_token";
+    token: string;
+}>;
 export declare const actionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<"launch_frame">;
     name: z.ZodString;
@@ -36,6 +46,15 @@ export declare const actionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<
     url: string;
     splashImageUrl?: string | undefined;
     splashBackgroundColor?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"view_token">;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "view_token";
+    token: string;
+}, {
+    type: "view_token";
+    token: string;
 }>]>;
 export declare const buttonSchema: z.ZodObject<{
     title: z.ZodString;
@@ -57,6 +76,15 @@ export declare const buttonSchema: z.ZodObject<{
         url: string;
         splashImageUrl?: string | undefined;
         splashBackgroundColor?: string | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"view_token">;
+        token: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "view_token";
+        token: string;
+    }, {
+        type: "view_token";
+        token: string;
     }>]>;
 }, "strip", z.ZodTypeAny, {
     title: string;
@@ -66,6 +94,9 @@ export declare const buttonSchema: z.ZodObject<{
         url: string;
         splashImageUrl?: string | undefined;
         splashBackgroundColor?: string | undefined;
+    } | {
+        type: "view_token";
+        token: string;
     };
 }, {
     title: string;
@@ -75,6 +106,9 @@ export declare const buttonSchema: z.ZodObject<{
         url: string;
         splashImageUrl?: string | undefined;
         splashBackgroundColor?: string | undefined;
+    } | {
+        type: "view_token";
+        token: string;
     };
 }>;
 export declare const frameEmbedNextSchema: z.ZodObject<{
@@ -100,6 +134,15 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
             url: string;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"view_token">;
+            token: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "view_token";
+            token: string;
+        }, {
+            type: "view_token";
+            token: string;
         }>]>;
     }, "strip", z.ZodTypeAny, {
         title: string;
@@ -109,6 +152,9 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
             url: string;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
         };
     }, {
         title: string;
@@ -118,6 +164,9 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
             url: string;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
         };
     }>;
 }, "strip", z.ZodTypeAny, {
@@ -131,6 +180,9 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
             url: string;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
         };
     };
 }, {
@@ -144,6 +196,9 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
             url: string;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
         };
     };
 }>;
@@ -158,6 +213,9 @@ export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.SafeParseR
             url: string;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
         };
     };
 }, {
@@ -171,6 +229,9 @@ export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.SafeParseR
             url: string;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
         };
     };
 }>;

package/dist/schemas/embeds.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeParseFrameEmbed = exports.frameEmbedNextSchema = exports.buttonSchema = exports.actionSchema = exports.actionLaunchFrameSchema = void 0;
+exports.safeParseFrameEmbed = exports.frameEmbedNextSchema = exports.buttonSchema = exports.actionSchema = exports.actionViewTokenSchema = exports.actionLaunchFrameSchema = void 0;
 const zod_1 = require("zod");
 const shared_1 = require("./shared");
 exports.actionLaunchFrameSchema = zod_1.z.object({
@@ -10,8 +10,13 @@ exports.actionLaunchFrameSchema = zod_1.z.object({
     splashImageUrl: shared_1.secureUrlSchema.optional(),
     splashBackgroundColor: shared_1.hexColorSchema.optional(),
 });
+exports.actionViewTokenSchema = zod_1.z.object({
+    type: zod_1.z.literal('view_token'),
+    token: shared_1.caip19TokenSchema,
+});
 exports.actionSchema = zod_1.z.discriminatedUnion('type', [
     exports.actionLaunchFrameSchema,
+    exports.actionViewTokenSchema,
 ]);
 exports.buttonSchema = zod_1.z.object({
     title: shared_1.buttonTitleSchema,

package/dist/schemas/shared.d.ts

@@ -2,6 +2,7 @@ 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 encodedJsonFarcasterSignatureSchema: z.ZodObject<{
     header: z.ZodString;

package/dist/schemas/shared.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonFarcasterSignatureHeaderSchema = exports.encodedJsonFarcasterSignatureSchema = exports.hexColorSchema = exports.buttonTitleSchema = exports.frameNameSchema = exports.secureUrlSchema = void 0;
+exports.jsonFarcasterSignatureHeaderSchema = exports.encodedJsonFarcasterSignatureSchema = exports.hexColorSchema = exports.caip19TokenSchema = exports.buttonTitleSchema = exports.frameNameSchema = exports.secureUrlSchema = void 0;
 const zod_1 = require("zod");
 exports.secureUrlSchema = zod_1.z
     .string()
@@ -9,6 +9,10 @@ exports.secureUrlSchema = zod_1.z
     .max(512);
 exports.frameNameSchema = zod_1.z.string().max(32);
 exports.buttonTitleSchema = zod_1.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)$/;
+exports.caip19TokenSchema = zod_1.z
+    .string()
+    .regex(CAIP_19_REGEX, { message: 'Invalid CAIP-19 asset ID' });
 exports.hexColorSchema = zod_1.z
     .string()
     .regex(/^#([0-9A-F]{3}|[0-9A-F]{6})$/i, {

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
-import type { AddFrame, SignIn } from './actions';
+import type { AddFrame, SignIn, ViewProfile } from './actions';
 import type { FrameContext } from './context';
 import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
 export type SetPrimaryButtonOptions = {
@@ -47,6 +47,7 @@ export type WireFrameHost = {
     ethProviderRequestV2: RpcTransport;
     eip6963RequestProvider: () => void;
     addFrame: AddFrame.WireAddFrame;
+    viewProfile: ViewProfile.ViewProfile;
 };
 export type FrameHost = {
     context: FrameContext;
@@ -63,6 +64,7 @@ export type FrameHost = {
      */
     eip6963RequestProvider: () => void;
     addFrame: AddFrame.AddFrame;
+    viewProfile: ViewProfile.ViewProfile;
 };
 export type FrameEthProviderEventData = {
     type: 'frame_eth_provider_event';

package/esm/actions/AddFrame.d.ts

@@ -1,40 +1,36 @@
-import * as Errors from '../errors'
-import type { OneOf } from '../internal/types'
-import type { FrameNotificationDetails } from '../schemas'
+import * as Errors from '../errors';
+import type { OneOf } from '../internal/types';
+import type { FrameNotificationDetails } from '../schemas';
 export type AddFrameResult = {
-  notificationDetails?: FrameNotificationDetails
-}
-export type AddFrame = () => Promise<AddFrameResult>
+    notificationDetails?: FrameNotificationDetails;
+};
+export type AddFrame = () => Promise<AddFrameResult>;
 type InvalidDomainManifestJsonError = {
-  type: 'invalid_domain_manifest'
-}
+    type: 'invalid_domain_manifest';
+};
 type RejectedByUserJsonError = {
-  type: 'rejected_by_user'
-}
-export type AddFrameJsonError =
-  | InvalidDomainManifestJsonError
-  | RejectedByUserJsonError
-export type AddFrameRejectedReason = AddFrameJsonError['type']
-export type AddFrameJsonResult = OneOf<
-  | {
-      result: AddFrameResult
-    }
-  | {
-      error: AddFrameJsonError
-    }
->
-export type WireAddFrame = () => Promise<AddFrameJsonResult>
+    type: 'rejected_by_user';
+};
+export type AddFrameJsonError = InvalidDomainManifestJsonError | RejectedByUserJsonError;
+export type AddFrameRejectedReason = AddFrameJsonError['type'];
+export type AddFrameJsonResult = OneOf<{
+    result: AddFrameResult;
+} | {
+    error: AddFrameJsonError;
+}>;
+export type WireAddFrame = () => Promise<AddFrameJsonResult>;
 /**
  * Thrown when the frame does not have a valid domain manifest.
  */
 export declare class InvalidDomainManifest extends Errors.BaseError {
-  readonly name = 'AddFrame.InvalidDomainManifest'
-  constructor()
+    readonly name = "AddFrame.InvalidDomainManifest";
+    constructor();
 }
 /**
  * Thrown when add frame action was rejected by the user.
  */
 export declare class RejectedByUser extends Errors.BaseError {
-  readonly name = 'AddFrame.RejectedByUser'
-  constructor()
+    readonly name = "AddFrame.RejectedByUser";
+    constructor();
 }
+export {};

package/esm/actions/AddFrame.js

@@ -1,19 +1,19 @@
-import * as Errors from '../errors'
+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')
-  }
+    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')
-  }
+    name = 'AddFrame.RejectedByUser';
+    constructor() {
+        super('Add frame rejected by user');
+    }
 }

package/esm/actions/SignIn.d.ts

@@ -1,43 +1,41 @@
-import * as Errors from '../errors'
-import type { OneOf } from '../internal/types'
+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
-}
+    /**
+     * 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>
+    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>
+    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()
+    readonly name = "SignIn.RejectedByUser";
+    constructor();
 }
+export {};

package/esm/actions/SignIn.js

@@ -1,10 +1,10 @@
-import * as Errors from '../errors'
+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')
-  }
+    name = 'SignIn.RejectedByUser';
+    constructor() {
+        super('Sign in rejected by user');
+    }
 }

package/esm/actions/ViewProfile.d.ts

@@ -0,0 +1,4 @@
+export type ViewProfileOptions = {
+    fid: number;
+};
+export type ViewProfile = (options: ViewProfileOptions) => Promise<void>;

package/esm/actions/ViewProfile.js

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

package/esm/actions/index.d.ts

@@ -1,2 +1,3 @@
-export * as AddFrame from './AddFrame'
-export * as SignIn from './SignIn'
+export * as AddFrame from './AddFrame';
+export * as ViewProfile from './ViewProfile';
+export * as SignIn from './SignIn';

package/esm/actions/index.js

@@ -1,2 +1,3 @@
-export * as AddFrame from './AddFrame'
-export * as SignIn from './SignIn'
+export * as AddFrame from './AddFrame';
+export * as ViewProfile from './ViewProfile';
+export * as SignIn from './SignIn';

package/esm/context.d.ts

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

package/esm/context.js

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

package/esm/errors.d.ts

@@ -1,12 +1,10 @@
-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,4 +1,4 @@
-export * from './actions'
-export * as Context from './context'
-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,4 +1,4 @@
-export * from './actions'
-export * as Context from './context'
-export * from './types'
-export * from './schemas'
+export * from './actions';
+export * as Context from './context';
+export * from './types';
+export * from './schemas';