@bwalletx/connect 0.1.0 → 0.3.0

package/dist/manifest-Caj_Raqm.d.ts

@@ -0,0 +1,81 @@
+/**
+ * bApp manifest: /.well-known/bapp.json. One file declares the app's five scoped slots, its drawer
+ * (Home + sections) and its like-to-fund config. The web bar draws from it; inside bWalletX the
+ * wallet's native dock reads the same file. Every path is same-origin: no URLs, no schemes.
+ */
+declare const SLOT_IDS: readonly ["wallet", "exchange", "b", "feed", "chat"];
+type SlotId = (typeof SLOT_IDS)[number];
+interface BappSlot {
+    /** Same-origin path, e.g. "/feed". Required when enabled, except for "b" (the agent). */
+    path?: string;
+    /** Optional rename ("Market"); the icon and position never change. */
+    label?: string;
+    /** false = shown greyed out and not clickable. Slots are never hidden. */
+    enabled: boolean;
+}
+interface BappDrawerItem {
+    label: string;
+    path: string;
+    /** Optional same-origin icon path. */
+    icon?: string;
+}
+interface BappLikeConfig {
+    /** Which fields of a feed item hold the id, token (BSV-21 id / $TICKER), payee, title and media. */
+    fields: {
+        id: string;
+        token: string;
+        payee?: string;
+        title?: string;
+        media?: string;
+    };
+    /** Price of one Like in US cents. Default 1 (one PNEE). */
+    amountCents: number;
+    /** Pay in PNEE (the wallet's USD-cent token) when held, else BSV. Default "PNEE". */
+    currency: 'PNEE' | 'BSV';
+    /** Daily cap in US cents. Default 100 ($1), never more. */
+    dailyCapCents: number;
+}
+interface BappTheme {
+    /** Active/accent colour, #RRGGBB. Default #FFD24D. */
+    accent?: string;
+}
+interface BappManifest {
+    version: 1;
+    name: string;
+    /** Same-origin path to a square icon. */
+    icon: string;
+    /** The app's Home (first drawer item). Default "/". */
+    home: string;
+    theme?: BappTheme;
+    slots: Record<SlotId, BappSlot>;
+    drawer: BappDrawerItem[];
+    like?: BappLikeConfig;
+}
+type ValidationResult = {
+    ok: true;
+    manifest: BappManifest;
+    errors: [];
+} | {
+    ok: false;
+    errors: string[];
+    manifest?: undefined;
+};
+declare const WELL_KNOWN_PATH = "/.well-known/bapp.json";
+declare const LIKE_DEFAULT_CENTS = 1;
+declare const LIKE_MAX_DAILY_CENTS = 100;
+/**
+ * A same-origin path: starts with one "/", no "//" (protocol-relative), no backslashes, no control
+ * characters, no scheme. Query and hash are allowed.
+ */
+declare function isSameOriginPath(p: unknown): p is string;
+/** Validate and normalise a parsed bapp.json. Never throws. */
+declare function validateManifest(input: unknown): ValidationResult;
+/** Same as validateManifest but throws with every error listed. */
+declare function parseManifest(input: unknown): BappManifest;
+/** Fetch and validate /.well-known/bapp.json (same origin). */
+declare function loadManifest(path?: string, fetchImpl?: typeof fetch): Promise<BappManifest>;
+/** The path a slot points at, or null when disabled / no path. */
+declare function slotPath(m: BappManifest, slot: SlotId): string | null;
+declare const isSlotId: (v: unknown) => v is SlotId;
+
+export { type BappManifest as B, LIKE_DEFAULT_CENTS as L, type SlotId as S, type ValidationResult as V, WELL_KNOWN_PATH as W, type BappDrawerItem as a, type BappLikeConfig as b, type BappSlot as c, type BappTheme as d, LIKE_MAX_DAILY_CENTS as e, SLOT_IDS as f, isSlotId as g, isSameOriginPath as i, loadManifest as l, parseManifest as p, slotPath as s, validateManifest as v };