@farcaster/frame-core 0.0.17 → 0.0.19

package/dist/actions/signIn.d.ts

@@ -0,0 +1,40 @@
+import * as Errors from '../errors';
+import { 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>;
+export type RejectedByUserError = {
+    type: 'rejected_by_user';
+};
+export type JsonSignInError = RejectedByUserError;
+export type WireSignInResponse = OneOf<{
+    result: SignInResult;
+} | {
+    error: JsonSignInError;
+}>;
+export type WireSignIn = (options: SignInOptions) => Promise<WireSignInResponse>;
+/**
+ * Thrown when a sign in action was rejected.
+ */
+export declare class RejectedByUser extends Errors.BaseError {
+    readonly name = "SignIn.RejectedByUser";
+    constructor();
+}

package/dist/actions/signIn.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    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 __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.RejectedByUser = void 0;
+const Errors = __importStar(require("../errors"));
+/**
+ * Thrown when a sign in action was rejected.
+ */
+class RejectedByUser extends Errors.BaseError {
+    name = 'SignIn.RejectedByUser';
+    constructor() {
+        super("Sign in rejected by user");
+    }
+}
+exports.RejectedByUser = RejectedByUser;

package/dist/errors.d.ts

@@ -0,0 +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 namespace BaseError {
+    type Options<cause extends Error | undefined = Error | undefined> = {
+        cause?: cause | undefined;
+    };
+}

package/dist/errors.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseError = void 0;
+class BaseError extends Error {
+    name = "BaseError";
+    cause;
+    constructor(message, options = {}) {
+        super(message, options.cause ? { cause: options.cause } : undefined);
+        this.cause = options.cause;
+    }
+}
+exports.BaseError = BaseError;

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+export * as SignIn from "./actions/signIn";
 export * from "./types";
 export * from "./schemas";

package/dist/index.js

@@ -10,9 +10,33 @@ 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 __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;
+    };
+})();
 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);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignIn = void 0;
+exports.SignIn = __importStar(require("./actions/signIn"));
 __exportStar(require("./types"), exports);
 __exportStar(require("./schemas"), exports);

package/dist/internal/types.d.ts

@@ -0,0 +1,7 @@
+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;

package/dist/internal/types.js

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

package/dist/schemas/events.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export declare const eventFrameAddedPayloadSchema: z.ZodObject<{
+export declare const eventFrameAddedSchema: z.ZodObject<{
     event: z.ZodLiteral<"frame_added">;
     notificationDetails: z.ZodOptional<z.ZodObject<{
         url: z.ZodString;
@@ -24,16 +24,16 @@ export declare const eventFrameAddedPayloadSchema: z.ZodObject<{
         token: string;
     } | undefined;
 }>;
-export type EventFrameAddedPayload = z.infer<typeof eventFrameAddedPayloadSchema>;
-export declare const eventFrameRemovedPayloadSchema: z.ZodObject<{
+export type EventFrameAdded = z.infer<typeof eventFrameAddedSchema>;
+export declare const eventFrameRemovedSchema: 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<{
+export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>;
+export declare const eventNotificationsEnabledSchema: z.ZodObject<{
     event: z.ZodLiteral<"notifications_enabled">;
     notificationDetails: z.ZodObject<{
         url: z.ZodString;
@@ -58,16 +58,16 @@ export declare const eventNotificationsEnabledPayloadSchema: z.ZodObject<{
         token: string;
     };
 }>;
-export type EventNotificationsEnabledPayload = z.infer<typeof eventNotificationsEnabledPayloadSchema>;
-export declare const notificationsDisabledPayloadSchema: z.ZodObject<{
+export type EventNotificationsEnabled = z.infer<typeof eventNotificationsEnabledSchema>;
+export declare const notificationsDisabledSchema: 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<{
+export type EventNotificationsDisabled = z.infer<typeof notificationsDisabledSchema>;
+export declare const serverEventSchema: z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
     event: z.ZodLiteral<"frame_added">;
     notificationDetails: z.ZodOptional<z.ZodObject<{
         url: z.ZodString;
@@ -128,4 +128,4 @@ export declare const eventPayloadSchema: z.ZodDiscriminatedUnion<"event", [z.Zod
 }, {
     event: "notifications_disabled";
 }>]>;
-export type FrameEvent = z.infer<typeof eventPayloadSchema>;
+export type FrameServerEvent = z.infer<typeof serverEventSchema>;

package/dist/schemas/events.js

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.eventPayloadSchema = exports.notificationsDisabledPayloadSchema = exports.eventNotificationsEnabledPayloadSchema = exports.eventFrameRemovedPayloadSchema = exports.eventFrameAddedPayloadSchema = void 0;
+exports.serverEventSchema = exports.notificationsDisabledSchema = exports.eventNotificationsEnabledSchema = exports.eventFrameRemovedSchema = exports.eventFrameAddedSchema = void 0;
 const zod_1 = require("zod");
 const notifications_1 = require("./notifications");
-exports.eventFrameAddedPayloadSchema = zod_1.z.object({
+exports.eventFrameAddedSchema = zod_1.z.object({
     event: zod_1.z.literal("frame_added"),
     notificationDetails: notifications_1.notificationDetailsSchema.optional(),
 });
-exports.eventFrameRemovedPayloadSchema = zod_1.z.object({
+exports.eventFrameRemovedSchema = zod_1.z.object({
     event: zod_1.z.literal("frame_removed"),
 });
-exports.eventNotificationsEnabledPayloadSchema = zod_1.z.object({
+exports.eventNotificationsEnabledSchema = zod_1.z.object({
     event: zod_1.z.literal("notifications_enabled"),
     notificationDetails: notifications_1.notificationDetailsSchema.required(),
 });
-exports.notificationsDisabledPayloadSchema = zod_1.z.object({
+exports.notificationsDisabledSchema = zod_1.z.object({
     event: zod_1.z.literal("notifications_disabled"),
 });
-exports.eventPayloadSchema = zod_1.z.discriminatedUnion("event", [
-    exports.eventFrameAddedPayloadSchema,
-    exports.eventFrameRemovedPayloadSchema,
-    exports.eventNotificationsEnabledPayloadSchema,
-    exports.notificationsDisabledPayloadSchema,
+exports.serverEventSchema = zod_1.z.discriminatedUnion("event", [
+    exports.eventFrameAddedSchema,
+    exports.eventFrameRemovedSchema,
+    exports.eventNotificationsEnabledSchema,
+    exports.notificationsDisabledSchema,
 ]);

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from "ox";
-import { FrameNotificationDetails } from "./schemas";
+import { FrameNotificationDetails, EventFrameAdded, EventFrameRemoved, EventNotificationsEnabled, EventNotificationsDisabled } from "./schemas";
+import * as SignIn from "./actions/signIn";
 export type SetPrimaryButton = (options: {
     text: string;
     loading?: boolean;
@@ -42,6 +43,7 @@ export type FrameContext = {
          * Profile image URL
          */
         pfpUrl?: string;
+        location?: AccountLocation;
     };
     location?: FrameLocationContext;
     client: {
@@ -50,12 +52,13 @@ export type FrameContext = {
         notificationDetails?: FrameNotificationDetails;
     };
 };
+export type AddFrameRejectedReason = "invalid_domain_manifest" | "rejected_by_user";
 export type AddFrameResult = {
     added: true;
     notificationDetails?: FrameNotificationDetails;
 } | {
     added: false;
-    reason: "invalid_domain_manifest" | "rejected_by_user";
+    reason: AddFrameRejectedReason;
 };
 export type AddFrame = () => Promise<AddFrameResult>;
 export type ReadyOptions = {
@@ -68,11 +71,39 @@ export type ReadyOptions = {
     disableNativeGestures: boolean;
 };
 export declare const DEFAULT_READY_OPTIONS: ReadyOptions;
+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 WireFrameHost = {
+    context: FrameContext;
+    close: () => void;
+    ready: (options?: Partial<ReadyOptions>) => void;
+    openUrl: (url: string) => void;
+    signIn: SignIn.WireSignIn;
+    setPrimaryButton: SetPrimaryButton;
+    ethProviderRequest: EthProviderRequest;
+    ethProviderRequestV2: RpcTransport;
+    addFrame: AddFrame;
+};
 export type FrameHost = {
     context: FrameContext;
     close: () => void;
     ready: (options?: Partial<ReadyOptions>) => void;
     openUrl: (url: string) => void;
+    signIn: SignIn.SignIn;
     setPrimaryButton: SetPrimaryButton;
     ethProviderRequest: EthProviderRequest;
     ethProviderRequestV2: RpcTransport;
@@ -106,3 +137,11 @@ export type EthProviderWireEvent = {
 export type EmitEthProvider = <event extends EthProviderWireEvent["event"]>(event: event, params: Extract<EthProviderWireEvent, {
     event: event;
 }>["params"]) => void;
+export type EventFrameAddRejected = {
+    event: "frame_add_rejected";
+    reason: AddFrameRejectedReason;
+};
+export type EventPrimaryButtonClicked = {
+    event: "primary_button_clicked";
+};
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked;

package/esm/actions/signIn.d.ts

@@ -0,0 +1,40 @@
+import * as Errors from '../errors';
+import { 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>;
+export type RejectedByUserError = {
+    type: 'rejected_by_user';
+};
+export type JsonSignInError = RejectedByUserError;
+export type WireSignInResponse = OneOf<{
+    result: SignInResult;
+} | {
+    error: JsonSignInError;
+}>;
+export type WireSignIn = (options: SignInOptions) => Promise<WireSignInResponse>;
+/**
+ * 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/errors.d.ts

@@ -0,0 +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 namespace BaseError {
+    type Options<cause extends Error | undefined = Error | undefined> = {
+        cause?: cause | undefined;
+    };
+}

package/esm/errors.js

@@ -0,0 +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;
+    }
+}

package/esm/index.d.ts

@@ -1,2 +1,3 @@
+export * as SignIn from "./actions/signIn";
 export * from "./types";
 export * from "./schemas";

package/esm/index.js

@@ -1,2 +1,3 @@
+export * as SignIn from "./actions/signIn";
 export * from "./types";
 export * from "./schemas";

package/esm/internal/types.d.ts

@@ -0,0 +1,7 @@
+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;

package/esm/internal/types.js

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

package/esm/schemas/events.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export declare const eventFrameAddedPayloadSchema: z.ZodObject<{
+export declare const eventFrameAddedSchema: z.ZodObject<{
     event: z.ZodLiteral<"frame_added">;
     notificationDetails: z.ZodOptional<z.ZodObject<{
         url: z.ZodString;
@@ -24,16 +24,16 @@ export declare const eventFrameAddedPayloadSchema: z.ZodObject<{
         token: string;
     } | undefined;
 }>;
-export type EventFrameAddedPayload = z.infer<typeof eventFrameAddedPayloadSchema>;
-export declare const eventFrameRemovedPayloadSchema: z.ZodObject<{
+export type EventFrameAdded = z.infer<typeof eventFrameAddedSchema>;
+export declare const eventFrameRemovedSchema: 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<{
+export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>;
+export declare const eventNotificationsEnabledSchema: z.ZodObject<{
     event: z.ZodLiteral<"notifications_enabled">;
     notificationDetails: z.ZodObject<{
         url: z.ZodString;
@@ -58,16 +58,16 @@ export declare const eventNotificationsEnabledPayloadSchema: z.ZodObject<{
         token: string;
     };
 }>;
-export type EventNotificationsEnabledPayload = z.infer<typeof eventNotificationsEnabledPayloadSchema>;
-export declare const notificationsDisabledPayloadSchema: z.ZodObject<{
+export type EventNotificationsEnabled = z.infer<typeof eventNotificationsEnabledSchema>;
+export declare const notificationsDisabledSchema: 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<{
+export type EventNotificationsDisabled = z.infer<typeof notificationsDisabledSchema>;
+export declare const serverEventSchema: z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
     event: z.ZodLiteral<"frame_added">;
     notificationDetails: z.ZodOptional<z.ZodObject<{
         url: z.ZodString;
@@ -128,4 +128,4 @@ export declare const eventPayloadSchema: z.ZodDiscriminatedUnion<"event", [z.Zod
 }, {
     event: "notifications_disabled";
 }>]>;
-export type FrameEvent = z.infer<typeof eventPayloadSchema>;
+export type FrameServerEvent = z.infer<typeof serverEventSchema>;

package/esm/schemas/events.js

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