@farcaster/frame-core 0.0.22 → 0.0.24

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/context.d.ts

@@ -0,0 +1,72 @@
+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/dist/context.js

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -10,10 +10,34 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Context = void 0;
 __exportStar(require("./actions"), exports);
-__exportStar(require("./schemas"), exports);
+exports.Context = __importStar(require("./context"));
 __exportStar(require("./types"), exports);
+__exportStar(require("./schemas"), exports);

package/dist/types.d.ts

@@ -1,6 +1,7 @@
 import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
-import type { AddFrame, SignIn } from './actions';
-import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled, FrameNotificationDetails } from './schemas';
+import type { AddFrame, SignIn, ViewProfile } from './actions';
+import type { FrameContext } from './context';
+import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
 export type SetPrimaryButtonOptions = {
     text: string;
     loading?: boolean;
@@ -9,58 +10,6 @@ export type SetPrimaryButtonOptions = {
 };
 export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
 export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>;
-export type AccountLocation = {
-    placeId: string;
-    /**
-     * Human-readable string describing the location
-     */
-    description: string;
-};
-export type FrameLocationContextCastEmbed = {
-    type: 'cast_embed';
-    embed: string;
-    cast: {
-        fid: number;
-        hash: string;
-    };
-};
-export type FrameLocationContextNotification = {
-    type: 'notification';
-    notification: {
-        notificationId: string;
-        title: string;
-        body: string;
-    };
-};
-export type FrameLocationContextLauncher = {
-    type: 'launcher';
-};
-export type FrameLocationContext = FrameLocationContextCastEmbed | FrameLocationContextNotification | FrameLocationContextLauncher;
-export type SafeAreaInsets = {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-};
-export type FrameContext = {
-    user: {
-        fid: number;
-        username?: string;
-        displayName?: string;
-        /**
-         * Profile image URL
-         */
-        pfpUrl?: string;
-        location?: AccountLocation;
-    };
-    location?: FrameLocationContext;
-    client: {
-        clientFid: number;
-        added: boolean;
-        notificationDetails?: FrameNotificationDetails;
-        safeAreaInsets?: SafeAreaInsets;
-    };
-};
 export type ReadyOptions = {
     /**
      * Disable native gestures. Use this option if your frame uses gestures
@@ -98,6 +47,7 @@ export type WireFrameHost = {
     ethProviderRequestV2: RpcTransport;
     eip6963RequestProvider: () => void;
     addFrame: AddFrame.WireAddFrame;
+    viewProfile: ViewProfile.ViewProfile;
 };
 export type FrameHost = {
     context: FrameContext;
@@ -114,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

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

package/esm/index.js

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

package/esm/internal/types.d.ts

@@ -1,19 +1,8 @@
 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
+    [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;
+export {};

package/esm/internal/types.js

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