PersistentAI API Documentation / @persistent-ai/fireflow-types / MiniAppManifestSchema

Variable: MiniAppManifestSchema

const MiniAppManifestSchema: ZodObject<{ appId: ZodString; auth: ZodObject<{ allowedProviders: ZodOptional<ZodArray<ZodString, "many">>; mode: ZodLiteral<"authenticated">; telegram: ZodOptional<ZodObject<{ botTokenSecret: ZodString; }, "strip", ZodTypeAny, { botTokenSecret: string; }, { botTokenSecret: string; }>>; }, "strip", ZodTypeAny, { allowedProviders?: string[]; mode: "authenticated"; telegram?: { botTokenSecret: string; }; }, { allowedProviders?: string[]; mode: "authenticated"; telegram?: { botTokenSecret: string; }; }>; description: ZodOptional<ZodString>; display: ZodOptional<ZodObject<{ favicon: ZodOptional<ZodString>; maxWidth: ZodOptional<ZodString>; theme: ZodOptional<ZodEnum<["light", "dark", "auto"]>>; title: ZodOptional<ZodString>; }, "strip", ZodTypeAny, { favicon?: string; maxWidth?: string; theme?: "light" | "dark" | "auto"; title?: string; }, { favicon?: string; maxWidth?: string; theme?: "light" | "dark" | "auto"; title?: string; }>>; execution: ZodOptional<ZodObject<{ eventName: ZodOptional<ZodString>; renderEventKey: ZodOptional<ZodString>; renderTimeout: ZodOptional<ZodNumber>; sessionMode: ZodOptional<ZodEnum<["per-request", "persistent"]>>; }, "strip", ZodTypeAny, { eventName?: string; renderEventKey?: string; renderTimeout?: number; sessionMode?: "per-request" | "persistent"; }, { eventName?: string; renderEventKey?: string; renderTimeout?: number; sessionMode?: "per-request" | "persistent"; }>>; flowPath: ZodString; icon: ZodOptional<ZodString>; meta: ZodOptional<ZodObject<{ createdAt: ZodOptional<ZodString>; tags: ZodOptional<ZodArray<ZodString, "many">>; updatedAt: ZodOptional<ZodString>; }, "strip", ZodTypeAny, { createdAt?: string; tags?: string[]; updatedAt?: string; }, { createdAt?: string; tags?: string[]; updatedAt?: string; }>>; name: ZodString; type: ZodLiteral<"ffapp">; version: ZodString; vfs: ZodOptional<ZodObject<{ rules: ZodOptional<ZodArray<ZodObject<{ access: ZodEnum<[..., ...]>; prefix: ZodString; }, "strip", ZodTypeAny, { access: "read" | "read-write"; prefix: string; }, { access: "read" | "read-write"; prefix: string; }>, "many">>; }, "strip", ZodTypeAny, { rules?: object[]; }, { rules?: object[]; }>>; }, "strip", ZodTypeAny, { appId: string; auth: { allowedProviders?: string[]; mode: "authenticated"; telegram?: { botTokenSecret: string; }; }; description?: string; display?: { favicon?: string; maxWidth?: string; theme?: "light" | "dark" | "auto"; title?: string; }; execution?: { eventName?: string; renderEventKey?: string; renderTimeout?: number; sessionMode?: "per-request" | "persistent"; }; flowPath: string; icon?: string; meta?: { createdAt?: string; tags?: string[]; updatedAt?: string; }; name: string; type: "ffapp"; version: string; vfs?: { rules?: object[]; }; }, { appId: string; auth: { allowedProviders?: string[]; mode: "authenticated"; telegram?: { botTokenSecret: string; }; }; description?: string; display?: { favicon?: string; maxWidth?: string; theme?: "light" | "dark" | "auto"; title?: string; }; execution?: { eventName?: string; renderEventKey?: string; renderTimeout?: number; sessionMode?: "per-request" | "persistent"; }; flowPath: string; icon?: string; meta?: { createdAt?: string; tags?: string[]; updatedAt?: string; }; name: string; type: "ffapp"; version: string; vfs?: { rules?: object[]; }; }>

Defined in: packages/fireflow-types/src/miniapp/manifest.ts:16

Zod schema for .ffapp/manifest.json.

See

docs/design/032-miniapp-generative-ui.md Section 2.3