@farcaster/miniapp-core 0.3.7 → 0.3.9

package/dist/actions/SignManifest.d.ts

@@ -0,0 +1,51 @@
+import * as Errors from '../errors.ts';
+import type { OneOf } from '../internal/types.ts';
+export type SignManifestOptions = {
+    domain: string;
+};
+export type SignManifestResult = {
+    header: string;
+    payload: string;
+    signature: string;
+};
+export type SignManifest = (options: SignManifestOptions) => Promise<SignManifestResult>;
+type RejectedByUserJsonError = {
+    type: 'rejected_by_user';
+};
+type InvalidDomainJsonError = {
+    type: 'invalid_domain';
+};
+type GenericErrorJsonError = {
+    type: 'generic_error';
+    message?: string;
+};
+export type SignManifestJsonError = RejectedByUserJsonError | InvalidDomainJsonError | GenericErrorJsonError;
+export type SignManifestRejectedReason = SignManifestJsonError['type'];
+export type SignManifestJsonResult = OneOf<{
+    result: SignManifestResult;
+} | {
+    error: SignManifestJsonError;
+}>;
+export type WireSignManifest = (options: SignManifestOptions) => Promise<SignManifestJsonResult>;
+/**
+ * Thrown when sign manifest action was rejected by the user.
+ */
+export declare class RejectedByUser extends Errors.BaseError {
+    readonly name = "SignManifest.RejectedByUser";
+    constructor();
+}
+/**
+ * Thrown when the provided domain is invalid.
+ */
+export declare class InvalidDomain extends Errors.BaseError {
+    readonly name = "SignManifest.InvalidDomain";
+    constructor();
+}
+/**
+ * Thrown when manifest signing fails for generic reasons.
+ */
+export declare class GenericError extends Errors.BaseError {
+    readonly name = "SignManifest.GenericError";
+    constructor(message?: string);
+}
+export {};

package/dist/actions/SignManifest.js

@@ -0,0 +1,67 @@
+"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.GenericError = exports.InvalidDomain = exports.RejectedByUser = void 0;
+const Errors = __importStar(require("../errors.js"));
+/**
+ * Thrown when sign manifest action was rejected by the user.
+ */
+class RejectedByUser extends Errors.BaseError {
+    name = 'SignManifest.RejectedByUser';
+    constructor() {
+        super('Sign manifest rejected by user');
+    }
+}
+exports.RejectedByUser = RejectedByUser;
+/**
+ * Thrown when the provided domain is invalid.
+ */
+class InvalidDomain extends Errors.BaseError {
+    name = 'SignManifest.InvalidDomain';
+    constructor() {
+        super('Invalid domain provided');
+    }
+}
+exports.InvalidDomain = InvalidDomain;
+/**
+ * Thrown when manifest signing fails for generic reasons.
+ */
+class GenericError extends Errors.BaseError {
+    name = 'SignManifest.GenericError';
+    constructor(message = 'Manifest signing failed') {
+        super(message);
+    }
+}
+exports.GenericError = GenericError;

package/dist/actions/index.d.ts

@@ -6,6 +6,7 @@ export * as Ready from './Ready.ts';
 export * as RequestCameraAndMicrophoneAccess from './RequestCameraAndMicrophoneAccess.ts';
 export * as SendToken from './SendToken.ts';
 export * as SignIn from './SignIn.ts';
+export * as SignManifest from './SignManifest.ts';
 export * as SwapToken from './SwapToken.ts';
 export * as ViewCast from './ViewCast.ts';
 export * as ViewProfile from './ViewProfile.ts';

package/dist/actions/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewToken = exports.ViewProfile = exports.ViewCast = exports.SwapToken = exports.SignIn = exports.SendToken = exports.RequestCameraAndMicrophoneAccess = exports.Ready = exports.OpenMiniApp = exports.Haptics = exports.ComposeCast = exports.AddMiniApp = void 0;
+exports.ViewToken = exports.ViewProfile = exports.ViewCast = exports.SwapToken = exports.SignManifest = exports.SignIn = exports.SendToken = exports.RequestCameraAndMicrophoneAccess = exports.Ready = exports.OpenMiniApp = exports.Haptics = exports.ComposeCast = exports.AddMiniApp = void 0;
 exports.AddMiniApp = __importStar(require("./AddMiniApp.js"));
 exports.ComposeCast = __importStar(require("./ComposeCast.js"));
 exports.Haptics = __importStar(require("./Haptics.js"));
@@ -42,6 +42,7 @@ exports.Ready = __importStar(require("./Ready.js"));
 exports.RequestCameraAndMicrophoneAccess = __importStar(require("./RequestCameraAndMicrophoneAccess.js"));
 exports.SendToken = __importStar(require("./SendToken.js"));
 exports.SignIn = __importStar(require("./SignIn.js"));
+exports.SignManifest = __importStar(require("./SignManifest.js"));
 exports.SwapToken = __importStar(require("./SwapToken.js"));
 exports.ViewCast = __importStar(require("./ViewCast.js"));
 exports.ViewProfile = __importStar(require("./ViewProfile.js"));

package/dist/schemas/events.d.ts

@@ -25,32 +25,6 @@ export declare const eventMiniAppAddedSchema: z.ZodObject<{
     } | undefined;
 }>;
 export type EventMiniAppAdded = z.infer<typeof eventMiniAppAddedSchema>;
-export declare const eventFrameAddedSchema: z.ZodObject<{
-    event: z.ZodLiteral<"frame_added">;
-    notificationDetails: z.ZodOptional<z.ZodObject<{
-        url: z.ZodString;
-        token: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        token: string;
-    }, {
-        url: string;
-        token: string;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    event: "frame_added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}, {
-    event: "frame_added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}>;
-export type EventFrameAdded = z.infer<typeof eventFrameAddedSchema>;
 export declare const eventMiniAppRemovedSchema: z.ZodObject<{
     event: z.ZodLiteral<"miniapp_removed">;
 }, "strip", z.ZodTypeAny, {
@@ -59,14 +33,6 @@ export declare const eventMiniAppRemovedSchema: z.ZodObject<{
     event: "miniapp_removed";
 }>;
 export type EventMiniAppRemoved = z.infer<typeof eventMiniAppRemovedSchema>;
-export declare const eventFrameRemovedSchema: z.ZodObject<{
-    event: z.ZodLiteral<"frame_removed">;
-}, "strip", z.ZodTypeAny, {
-    event: "frame_removed";
-}, {
-    event: "frame_removed";
-}>;
-export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>;
 export declare const eventNotificationsEnabledSchema: z.ZodObject<{
     event: z.ZodLiteral<"notifications_enabled">;
     notificationDetails: z.ZodObject<{
@@ -161,35 +127,5 @@ export declare const serverEventSchema: z.ZodDiscriminatedUnion<"event", [z.ZodO
     event: "notifications_disabled";
 }, {
     event: "notifications_disabled";
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"frame_added">;
-    notificationDetails: z.ZodOptional<z.ZodObject<{
-        url: z.ZodString;
-        token: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        token: string;
-    }, {
-        url: string;
-        token: string;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    event: "frame_added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}, {
-    event: "frame_added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"frame_removed">;
-}, "strip", z.ZodTypeAny, {
-    event: "frame_removed";
-}, {
-    event: "frame_removed";
 }>]>;
 export type MiniAppServerEvent = z.infer<typeof serverEventSchema>;

package/dist/schemas/events.js

@@ -1,22 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serverEventSchema = exports.notificationsDisabledSchema = exports.eventNotificationsEnabledSchema = exports.eventFrameRemovedSchema = exports.eventMiniAppRemovedSchema = exports.eventFrameAddedSchema = exports.eventMiniAppAddedSchema = void 0;
+exports.serverEventSchema = exports.notificationsDisabledSchema = exports.eventNotificationsEnabledSchema = exports.eventMiniAppRemovedSchema = exports.eventMiniAppAddedSchema = void 0;
 const zod_1 = require("zod");
 const notifications_ts_1 = require("./notifications.js");
 exports.eventMiniAppAddedSchema = zod_1.z.object({
     event: zod_1.z.literal('miniapp_added'),
     notificationDetails: notifications_ts_1.notificationDetailsSchema.optional(),
 });
-exports.eventFrameAddedSchema = zod_1.z.object({
-    event: zod_1.z.literal('frame_added'),
-    notificationDetails: notifications_ts_1.notificationDetailsSchema.optional(),
-});
 exports.eventMiniAppRemovedSchema = zod_1.z.object({
     event: zod_1.z.literal('miniapp_removed'),
 });
-exports.eventFrameRemovedSchema = zod_1.z.object({
-    event: zod_1.z.literal('frame_removed'),
-});
 exports.eventNotificationsEnabledSchema = zod_1.z.object({
     event: zod_1.z.literal('notifications_enabled'),
     notificationDetails: notifications_ts_1.notificationDetailsSchema.required(),
@@ -29,7 +22,4 @@ exports.serverEventSchema = zod_1.z.discriminatedUnion('event', [
     exports.eventMiniAppRemovedSchema,
     exports.eventNotificationsEnabledSchema,
     exports.notificationsDisabledSchema,
-    // Remove after compatibility period
-    exports.eventFrameAddedSchema,
-    exports.eventFrameRemovedSchema,
 ]);