@farcaster/frame-core 0.0.20 → 0.0.22

package/dist/actions/AddFrame.d.ts

@@ -0,0 +1,36 @@
+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>;
+type InvalidDomainManifestJsonError = {
+    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>;
+/**
+ * Thrown when the frame does not have a valid domain manifest.
+ */
+export declare class InvalidDomainManifest extends Errors.BaseError {
+    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();
+}
+export {};

package/dist/actions/AddFrame.js

@@ -0,0 +1,57 @@
+"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 = exports.InvalidDomainManifest = void 0;
+const Errors = __importStar(require("../errors"));
+/**
+ * Thrown when the frame does not have a valid domain manifest.
+ */
+class InvalidDomainManifest extends Errors.BaseError {
+    name = 'AddFrame.InvalidDomainManifest';
+    constructor() {
+        super('Invalid domain manifest');
+    }
+}
+exports.InvalidDomainManifest = InvalidDomainManifest;
+/**
+ * Thrown when add frame action was rejected by the user.
+ */
+class RejectedByUser extends Errors.BaseError {
+    name = 'AddFrame.RejectedByUser';
+    constructor() {
+        super('Add frame rejected by user');
+    }
+}
+exports.RejectedByUser = RejectedByUser;

package/dist/actions/{signIn.d.ts → SignIn.d.ts}

@@ -1,5 +1,5 @@
 import * as Errors from '../errors';
-import { OneOf } from '../internal/types';
+import type { OneOf } from '../internal/types';
 export type SignInOptions = {
     /**
      * A random string used to prevent replay attacks.
@@ -21,16 +21,16 @@ export type SignInResult = {
     message: string;
 };
 export type SignIn = (options: SignInOptions) => Promise<SignInResult>;
-export type RejectedByUserError = {
+type RejectedByUserJsonError = {
     type: 'rejected_by_user';
 };
-export type JsonSignInError = RejectedByUserError;
-export type WireSignInResponse = OneOf<{
+export type SignInJsonError = RejectedByUserJsonError;
+export type SignInJsonResult = OneOf<{
     result: SignInResult;
 } | {
-    error: JsonSignInError;
+    error: SignInJsonError;
 }>;
-export type WireSignIn = (options: SignInOptions) => Promise<WireSignInResponse>;
+export type WireSignIn = (options: SignInOptions) => Promise<SignInJsonResult>;
 /**
  * Thrown when a sign in action was rejected.
  */
@@ -38,3 +38,4 @@ export declare class RejectedByUser extends Errors.BaseError {
     readonly name = "SignIn.RejectedByUser";
     constructor();
 }
+export {};

package/dist/actions/{signIn.js → SignIn.js}

@@ -41,7 +41,7 @@ const Errors = __importStar(require("../errors"));
 class RejectedByUser extends Errors.BaseError {
     name = 'SignIn.RejectedByUser';
     constructor() {
-        super("Sign in rejected by user");
+        super('Sign in rejected by user');
     }
 }
 exports.RejectedByUser = RejectedByUser;

package/dist/actions/index.d.ts

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

package/dist/actions/index.js

@@ -0,0 +1,38 @@
+"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.SignIn = exports.AddFrame = void 0;
+exports.AddFrame = __importStar(require("./AddFrame"));
+exports.SignIn = __importStar(require("./SignIn"));

package/dist/errors.js

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

package/dist/index.d.ts

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

package/dist/index.js

@@ -10,33 +10,10 @@ 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("./actions"), exports);
 __exportStar(require("./schemas"), exports);
+__exportStar(require("./types"), exports);

package/dist/internal/types.d.ts

@@ -1,7 +1,8 @@
-export type Compute<type> = {
+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;
-export type KeyofUnion<type> = type extends type ? keyof type : never;
+export {};

package/dist/schemas/embeds.d.ts

@@ -1,4 +1,4 @@
-import { z } from "zod";
+import { z } from 'zod';
 export declare const actionLaunchFrameSchema: z.ZodObject<{
     type: z.ZodLiteral<"launch_frame">;
     name: z.ZodString;

package/dist/schemas/embeds.js

@@ -4,13 +4,13 @@ exports.safeParseFrameEmbed = exports.frameEmbedNextSchema = exports.buttonSchem
 const zod_1 = require("zod");
 const shared_1 = require("./shared");
 exports.actionLaunchFrameSchema = zod_1.z.object({
-    type: zod_1.z.literal("launch_frame"),
+    type: zod_1.z.literal('launch_frame'),
     name: shared_1.frameNameSchema,
     url: shared_1.secureUrlSchema,
     splashImageUrl: shared_1.secureUrlSchema.optional(),
     splashBackgroundColor: shared_1.hexColorSchema.optional(),
 });
-exports.actionSchema = zod_1.z.discriminatedUnion("type", [
+exports.actionSchema = zod_1.z.discriminatedUnion('type', [
     exports.actionLaunchFrameSchema,
 ]);
 exports.buttonSchema = zod_1.z.object({
@@ -18,7 +18,7 @@ exports.buttonSchema = zod_1.z.object({
     action: exports.actionSchema,
 });
 exports.frameEmbedNextSchema = zod_1.z.object({
-    version: zod_1.z.literal("next"),
+    version: zod_1.z.literal('next'),
     imageUrl: shared_1.secureUrlSchema,
     button: exports.buttonSchema,
 });

package/dist/schemas/events.d.ts

@@ -1,4 +1,4 @@
-import { z } from "zod";
+import { z } from 'zod';
 export declare const eventFrameAddedSchema: z.ZodObject<{
     event: z.ZodLiteral<"frame_added">;
     notificationDetails: z.ZodOptional<z.ZodObject<{

package/dist/schemas/events.js

@@ -4,20 +4,20 @@ exports.serverEventSchema = exports.notificationsDisabledSchema = exports.eventN
 const zod_1 = require("zod");
 const notifications_1 = require("./notifications");
 exports.eventFrameAddedSchema = zod_1.z.object({
-    event: zod_1.z.literal("frame_added"),
+    event: zod_1.z.literal('frame_added'),
     notificationDetails: notifications_1.notificationDetailsSchema.optional(),
 });
 exports.eventFrameRemovedSchema = zod_1.z.object({
-    event: zod_1.z.literal("frame_removed"),
+    event: zod_1.z.literal('frame_removed'),
 });
 exports.eventNotificationsEnabledSchema = zod_1.z.object({
-    event: zod_1.z.literal("notifications_enabled"),
+    event: zod_1.z.literal('notifications_enabled'),
     notificationDetails: notifications_1.notificationDetailsSchema.required(),
 });
 exports.notificationsDisabledSchema = zod_1.z.object({
-    event: zod_1.z.literal("notifications_disabled"),
+    event: zod_1.z.literal('notifications_disabled'),
 });
-exports.serverEventSchema = zod_1.z.discriminatedUnion("event", [
+exports.serverEventSchema = zod_1.z.discriminatedUnion('event', [
     exports.eventFrameAddedSchema,
     exports.eventFrameRemovedSchema,
     exports.eventNotificationsEnabledSchema,

package/dist/schemas/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./embeds";
-export * from "./events";
-export * from "./shared";
-export * from "./manifest";
-export * from "./notifications";
+export * from './embeds';
+export * from './events';
+export * from './shared';
+export * from './manifest';
+export * from './notifications';

package/dist/schemas/manifest.d.ts

@@ -1,4 +1,4 @@
-import { z } from "zod";
+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;

package/dist/schemas/manifest.js

@@ -8,10 +8,10 @@ exports.domainFrameConfigSchema = zod_1.z.object({
     // backwards compatibilty. next should always resolve to the most recent
     // schema version.
     version: zod_1.z.union([
-        zod_1.z.literal("0.0.0"),
-        zod_1.z.literal("0.0.1"),
-        zod_1.z.literal("1"),
-        zod_1.z.literal('next')
+        zod_1.z.literal('0.0.0'),
+        zod_1.z.literal('0.0.1'),
+        zod_1.z.literal('1'),
+        zod_1.z.literal('next'),
     ]),
     name: shared_1.frameNameSchema,
     iconUrl: shared_1.secureUrlSchema,

package/dist/schemas/notifications.d.ts

@@ -1,4 +1,4 @@
-import { z } from "zod";
+import { z } from 'zod';
 export declare const notificationDetailsSchema: z.ZodObject<{
     url: z.ZodString;
     token: z.ZodString;

package/dist/schemas/shared.d.ts

@@ -1,4 +1,4 @@
-import { z } from "zod";
+import { z } from 'zod';
 export declare const secureUrlSchema: z.ZodString;
 export declare const frameNameSchema: z.ZodString;
 export declare const buttonTitleSchema: z.ZodString;

package/dist/schemas/shared.js

@@ -5,14 +5,14 @@ const zod_1 = require("zod");
 exports.secureUrlSchema = zod_1.z
     .string()
     .url()
-    .startsWith("https://", { message: "Must be an https url" })
+    .startsWith('https://', { message: 'Must be an https url' })
     .max(512);
 exports.frameNameSchema = zod_1.z.string().max(32);
 exports.buttonTitleSchema = zod_1.z.string().max(32);
 exports.hexColorSchema = zod_1.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.",
+    message: 'Invalid hex color code. It should be in the format #RRGGBB or #RGB.',
 });
 exports.encodedJsonFarcasterSignatureSchema = zod_1.z.object({
     header: zod_1.z.string(),
@@ -21,6 +21,6 @@ exports.encodedJsonFarcasterSignatureSchema = zod_1.z.object({
 });
 exports.jsonFarcasterSignatureHeaderSchema = zod_1.z.object({
     fid: zod_1.z.number(),
-    type: zod_1.z.literal("app_key"),
-    key: zod_1.z.string().startsWith("0x"),
+    type: zod_1.z.literal('app_key'),
+    key: zod_1.z.string().startsWith('0x'),
 });

package/dist/types.d.ts

@@ -1,12 +1,13 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from "ox";
-import { FrameNotificationDetails, EventFrameAdded, EventFrameRemoved, EventNotificationsEnabled, EventNotificationsDisabled } from "./schemas";
-import * as SignIn from "./actions/signIn";
-export type SetPrimaryButton = (options: {
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
+import type { AddFrame, SignIn } from './actions';
+import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled, FrameNotificationDetails } from './schemas';
+export type SetPrimaryButtonOptions = {
     text: string;
     loading?: boolean;
     disabled?: boolean;
     hidden?: boolean;
-}) => void;
+};
+export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
 export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>;
 export type AccountLocation = {
     placeId: string;
@@ -16,14 +17,15 @@ export type AccountLocation = {
     description: string;
 };
 export type FrameLocationContextCastEmbed = {
-    type: "cast_embed";
+    type: 'cast_embed';
+    embed: string;
     cast: {
         fid: number;
         hash: string;
     };
 };
 export type FrameLocationContextNotification = {
-    type: "notification";
+    type: 'notification';
     notification: {
         notificationId: string;
         title: string;
@@ -31,7 +33,7 @@ export type FrameLocationContextNotification = {
     };
 };
 export type FrameLocationContextLauncher = {
-    type: "launcher";
+    type: 'launcher';
 };
 export type FrameLocationContext = FrameLocationContextCastEmbed | FrameLocationContextNotification | FrameLocationContextLauncher;
 export type SafeAreaInsets = {
@@ -59,15 +61,6 @@ export type FrameContext = {
         safeAreaInsets?: SafeAreaInsets;
     };
 };
-export type AddFrameRejectedReason = "invalid_domain_manifest" | "rejected_by_user";
-export type AddFrameResult = {
-    added: true;
-    notificationDetails?: FrameNotificationDetails;
-} | {
-    added: false;
-    reason: AddFrameRejectedReason;
-};
-export type AddFrame = () => Promise<AddFrameResult>;
 export type ReadyOptions = {
     /**
      * Disable native gestures. Use this option if your frame uses gestures
@@ -103,7 +96,8 @@ export type WireFrameHost = {
     setPrimaryButton: SetPrimaryButton;
     ethProviderRequest: EthProviderRequest;
     ethProviderRequestV2: RpcTransport;
-    addFrame: AddFrame;
+    eip6963RequestProvider: () => void;
+    addFrame: AddFrame.WireAddFrame;
 };
 export type FrameHost = {
     context: FrameContext;
@@ -114,10 +108,15 @@ export type FrameHost = {
     setPrimaryButton: SetPrimaryButton;
     ethProviderRequest: EthProviderRequest;
     ethProviderRequestV2: RpcTransport;
-    addFrame: AddFrame;
+    /**
+     * Receive forwarded eip6963:requestProvider events from the frame document.
+     * Hosts must emit an EventEip6963AnnounceProvider in response.
+     */
+    eip6963RequestProvider: () => void;
+    addFrame: AddFrame.AddFrame;
 };
 export type FrameEthProviderEventData = {
-    type: "frame_eth_provider_event";
+    type: 'frame_eth_provider_event';
 } & EthProviderWireEvent;
 export type RpcTransport = (request: RpcRequest.RpcRequest) => Promise<RpcResponse.RpcResponse>;
 export type ProviderRpcError = {
@@ -126,29 +125,42 @@ export type ProviderRpcError = {
     message?: string;
 };
 export type EthProviderWireEvent = {
-    event: "accountsChanged";
+    event: 'accountsChanged';
     params: [readonly Address.Address[]];
 } | {
-    event: "chainChanged";
+    event: 'chainChanged';
     params: [string];
 } | {
-    event: "connect";
+    event: 'connect';
     params: [Provider.ConnectInfo];
 } | {
-    event: "disconnect";
+    event: 'disconnect';
     params: [ProviderRpcError];
 } | {
-    event: "message";
+    event: 'message';
     params: [Provider.Message];
 };
-export type EmitEthProvider = <event extends EthProviderWireEvent["event"]>(event: event, params: Extract<EthProviderWireEvent, {
+export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(event: event, params: Extract<EthProviderWireEvent, {
     event: event;
-}>["params"]) => void;
+}>['params']) => void;
 export type EventFrameAddRejected = {
-    event: "frame_add_rejected";
-    reason: AddFrameRejectedReason;
+    event: 'frame_add_rejected';
+    reason: AddFrame.AddFrameRejectedReason;
 };
 export type EventPrimaryButtonClicked = {
-    event: "primary_button_clicked";
+    event: 'primary_button_clicked';
+};
+/**
+ * Metadata of the EIP-1193 Provider.
+ */
+export interface EIP6963ProviderInfo {
+    icon: `data:image/${string}`;
+    name: string;
+    rdns: string;
+    uuid: string;
+}
+export type EventEip6963AnnounceProvider = {
+    event: 'eip6963:announceProvider';
+    info: EIP6963ProviderInfo;
 };
-export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked;
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | EventEip6963AnnounceProvider;

package/esm/actions/AddFrame.d.ts

@@ -0,0 +1,40 @@
+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>
+type InvalidDomainManifestJsonError = {
+  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>
+/**
+ * Thrown when the frame does not have a valid domain manifest.
+ */
+export declare class InvalidDomainManifest extends Errors.BaseError {
+  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()
+}

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'