@marktiderman/genesis-native 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -1,336 +1,14 @@
-import * as react from 'react';
-import { ReactNode, Component, ComponentType, ErrorInfo } from 'react';
-import { QueryClient, QueryClientConfig } from '@tanstack/react-query';
-import { CanonicalBrand } from '@marktiderman/genesis-design-system';
-import { SupabaseClientInput, DataProvider } from '@marktiderman/genesis-core/provider';
-import { Slots, SlotPropsFor } from '@marktiderman/genesis-core/slots';
-import { KeyboardScrollProps } from '@marktiderman/genesis-ui-native/layouts';
-import { Q as QueryPersistence, a as QueryLifecycleOptions, A as AsyncStorageLike } from './query-DhH3lLFa.js';
-export { b as AppStateLike, D as DAY_MS, N as NetInfoLike, c as connectQueryLifecycle, d as createNativeQueryClient } from './query-DhH3lLFa.js';
-import { U as UpdatesBlock, a as UpdatesSlots } from './block-Dh5ny06W.js';
-
-interface BootStepContext {
-    /**
-     * Aborted when the step times out. Stop work when it fires: a retry waits
-     * for a timed-out run to settle before running the step again.
-     */
-    signal: AbortSignal;
-}
-interface BootStep {
-    /** Unique within the list; names the step in errors. */
-    id: string;
-    run: (context: BootStepContext) => Promise<unknown> | unknown;
-    /** Overrides the boot's `timeoutMs` for this step. */
-    timeoutMs?: number;
-}
-type BootStatus = "idle" | "booting" | "ready" | "failed";
-interface BootState {
-    status: BootStatus;
-    /** Set when `status` is `"failed"`. */
-    error: Error | null;
-    /** The id of the step that failed. */
-    failedStep: string | null;
-    /** Ids of the steps that have finished, in order. */
-    completed: readonly string[];
-}
-interface BootOptions {
-    /** Shortest time the boot takes, so the splash doesn't flash. Default 0. */
-    minimumMs?: number;
-    /** Longest time one step may take. Default 10 000. */
-    timeoutMs?: number;
-}
-interface BootController {
-    getState(): BootState;
-    subscribe(listener: () => void): () => void;
-    /** Run the steps not yet finished. Calling it while a run is in flight returns that run. */
-    start(): Promise<void>;
-    /** After a failure: run again from the step that failed. */
-    retry(): Promise<void>;
-}
-/** Thrown when a step takes longer than its timeout. */
-declare class BootTimeoutError extends Error {
-    readonly step: string;
-    constructor(step: string, ms: number, reason?: string);
-}
-/** The boot controller: runs `steps` once each, in order, with a timeout per step. */
-declare function createBoot(steps: readonly BootStep[], options?: BootOptions): BootController;
-/** Makes a boot readable with `useBoot()`. */
-declare function BootProvider({ boot, children }: {
-    boot: BootController;
-    children: ReactNode;
-}): react.JSX.Element;
-interface UseBootReturn extends BootState {
-    retry: () => void;
-}
-/** The boot's status, and `retry` after a failure. Inside `GenesisNativeApp` or a `BootProvider`. */
-declare function useBoot(): UseBootReturn;
-
-interface FatalScreenProps {
-    error: Error;
-    /** Clears the error and remounts the app below the shell (and re-runs a failed boot). */
-    retry: () => void;
-}
-/** The default fatal screen: what went wrong and "Try again". */
-declare function FatalScreen({ error, retry }: FatalScreenProps): react.JSX.Element;
-/**
- * The last-resort fatal screen: React Native primitives only, no theme, no
- * context, nothing that can itself fail. Shown when the providers could not
- * start, or when the `fatal` slot threw.
- */
-declare function PlainFatalScreen({ error, retry }: FatalScreenProps): react.JSX.Element;
-interface ErrorReport {
-    /** True when the app could not go on (a render error, a failed boot, a fatal global error). */
-    fatal: boolean;
-    source: "boundary" | "global" | "boot" | "rejection";
-    componentStack?: string;
-}
-type OnError = (error: Error, report: ErrorReport) => void;
-interface GenesisErrorBoundaryProps {
-    children?: ReactNode;
-    /** What to render instead of the tree that threw. */
-    fallback: ComponentType<FatalScreenProps>;
-    onError?: OnError;
-    /** Change it to clear a caught error (the tree remounts). */
-    resetKey?: unknown;
-    /** Called by the fallback's retry, after the error is cleared. */
-    onRetry?: () => void;
-}
-interface BoundaryState {
-    error: Error | null;
-}
-/** An error boundary whose fallback gets `{ error, retry }`. */
-declare class GenesisErrorBoundary extends Component<GenesisErrorBoundaryProps, BoundaryState> {
-    state: BoundaryState;
-    static getDerivedStateFromError(error: unknown): BoundaryState;
-    componentDidCatch(error: unknown, info: ErrorInfo): void;
-    componentDidUpdate(previous: GenesisErrorBoundaryProps): void;
-    retry: () => void;
-    render(): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react.JSX.Element | null;
-}
-/** React Native's `ErrorUtils` (a global in every RN app), or a stand-in. */
-interface ErrorUtilsLike {
-    getGlobalHandler(): ((error: unknown, isFatal?: boolean) => void) | undefined;
-    setGlobalHandler(handler: (error: unknown, isFatal?: boolean) => void): void;
-}
-interface GlobalErrorHandlerOptions {
-    errorUtils: ErrorUtilsLike;
-    onError?: OnError;
-    /** A fatal error: show the fatal screen. The previous handler (which would end the app) is not called. */
-    onFatal: (error: Error) => void;
-    /**
-     * True while a fatal screen is already up. Another fatal error then goes to
-     * the previous handler, which ends the app (it restarts clean) rather than
-     * leaving it stuck behind a screen that may itself be broken.
-     */
-    alreadyFatal?: () => boolean;
-}
-/**
- * Route global errors to `onError`. A fatal one goes to `onFatal` instead of
- * React Native's default handler, which would close the app; a non-fatal one
- * still reaches the previous handler (LogBox in development). Returns a
- * function that puts the previous handler back.
- */
-declare function installGlobalErrorHandler({ errorUtils, onError, onFatal, alreadyFatal }: GlobalErrorHandlerOptions): () => void;
-/** `globalThis.ErrorUtils` in a React Native runtime, undefined elsewhere. */
-declare function defaultErrorUtils(): ErrorUtilsLike | undefined;
-/** Hermes's `HermesInternal.enablePromiseRejectionTracker`, or a stand-in. */
-type EnableRejectionTracker = (options: {
-    allRejections: boolean;
-    onUnhandled: (id: number, rejection: unknown) => void;
-    onHandled: (id: number) => void;
-}) => void;
-/**
- * Hermes's rejection tracker, when the app runs on Hermes. React Native sends
- * unhandled rejections to `ExceptionsManager` (LogBox in development), never
- * to `ErrorUtils`' global handler, so without this they never reach `onError`.
- */
-declare function defaultRejectionTracker(): EnableRejectionTracker | undefined;
-/**
- * Report unhandled promise rejections to `onError` (non-fatal). This replaces
- * React Native's own tracker, so each rejection is also written with
- * `console.warn`, which LogBox shows in development as before.
- */
-declare function installRejectionTracker({ enable, onError }: {
-    enable: EnableRejectionTracker;
-    onError: OnError;
-}): void;
-
-/** The parts of a Supabase client the gate uses; a `SupabaseClient` fits. */
-interface AuthClientLike<S = unknown> {
-    auth: {
-        getSession(): Promise<{
-            data: {
-                session: S | null;
-            };
-            error?: unknown;
-        }>;
-        onAuthStateChange(callback: (event: string, session: S | null) => void): {
-            data: {
-                subscription: {
-                    unsubscribe(): void;
-                };
-            };
-        };
-    };
-}
-type SessionStatus = "loading" | "signedIn" | "signedOut";
-interface SessionState<S = unknown> {
-    status: SessionStatus;
-    session: S | null;
-    /** The signed-in user's id, or null. */
-    userId: string | null;
-    /** True when the session came from the phone because Supabase couldn't be reached. */
-    offline: boolean;
-}
-interface SessionStore<S = unknown> {
-    getState(): SessionState<S>;
-    subscribe(listener: () => void): () => void;
-    /** Read the current session (the boot step). Throws only on a non-network error. */
-    load(): Promise<void>;
-    /** Follow sign-in and sign-out; returns the unsubscribe. */
-    start(): () => void;
-}
-interface SessionStoreOptions<S = unknown> {
-    /**
-     * The signed-in user changed after the session was first known: signed
-     * out, signed in, or switched account. `previous` and `next` are user ids
-     * (null when nobody). Clear caches here.
-     */
-    onUserChange?: (previous: string | null, next: string | null) => void;
-    /** Longest wait for `getSession()` before using the stored session. Default 5000 ms. */
-    waitMs?: number;
-    /**
-     * Read the session saved on the phone without refreshing it. Default: from
-     * the Supabase client's own storage (`auth.storage` under `auth.storageKey`).
-     */
-    readStoredSession?: () => Promise<S | null>;
-    /** The user id in a session. Default `session.user.id`. */
-    userIdOf?: (session: S) => string | null;
-}
-/** The Supabase session as a store: `load` reads it once, `start` follows auth events. */
-declare function createSessionStore<S = unknown>(client: AuthClientLike<S>, options?: SessionStoreOptions<S>): SessionStore<S>;
-/** Makes a session store readable with `useSession()`. */
-declare function SessionProvider({ store, children }: {
-    store: SessionStore;
-    children: ReactNode;
-}): react.JSX.Element;
-/** The session and whether it is known yet. Inside `GenesisNativeApp` or a `SessionProvider`. */
-declare function useSession<S = unknown>(): SessionState<S>;
-interface AuthGateProps {
-    signedIn: ReactNode;
-    signedOut: ReactNode;
-    /** While the session is still being read. Default nothing (the splash is up). */
-    loading?: ReactNode;
-}
-/** Render one tree for a signed-in user and another for everyone else. */
-declare function AuthGate({ signedIn, signedOut, loading }: AuthGateProps): react.JSX.Element;
-
-interface LinkHold {
-    /** Hold `path`, replacing any held one. */
-    hold(path: string): void;
-    peek(): string | null;
-    /** Return the held path and forget it. */
-    take(): string | null;
-    clear(): void;
-    subscribe(listener: () => void): () => void;
-}
-/** A place to hold one deep link until sign-in completes; lives outside React. */
-declare function createLinkHold(): LinkHold;
-/** `"pending"` while booting or reading the session. */
-type HeldLinkAuth = "pending" | "signedOut" | "signedIn";
-interface UseHeldLinkOptions {
-    auth: HeldLinkAuth;
-    /** Go there, e.g. `(path) => router.replace(path)`. Called once per link held across a sign-in. */
-    onRelease: (path: string) => void;
-}
-/** Follow the held link after a sign-in, drop it otherwise; returns the link still held. */
-declare function useHeldLink(hold: LinkHold, { auth, onRelease }: UseHeldLinkOptions): string | null;
-
-/** `expo-splash-screen`, or a stand-in. Call `preventAutoHideAsync()` at module scope yourself too. */
-interface SplashModule {
-    preventAutoHideAsync?: () => Promise<unknown>;
-    hideAsync: () => Promise<unknown>;
-}
-interface BootScreenProps {
-    status: BootStatus;
-}
-interface SignedOutProps {
-    /** Your screens. The default renders them, for an expo-router layout that redirects. */
-    children: ReactNode;
-}
-type NativeAppSlots = UpdatesSlots & {
-    /** Shown while booting: under the splash at launch, on its own after "Try again". Default `BootScreen`. */
-    boot: BootScreenProps;
-    /** A failed boot, a fatal global error or a render error. Default `FatalScreen`. */
-    fatal: FatalScreenProps;
-    /** The boundary around your screens. Default `GenesisErrorBoundary`. */
-    errorBoundary: GenesisErrorBoundaryProps;
-    /** What a signed-out user sees. Default your screens (gate them with `useSession`). */
-    signedOut: SignedOutProps;
-};
-interface NativeQueryClientOptions {
-    /** Your own client. Default `createNativeQueryClient(config)`. */
-    client?: QueryClient;
-    config?: QueryClientConfig;
-}
-interface GenesisNativeAppProps {
-    brand: CanonicalBrand;
-    /** A Supabase client (from `createGenesisSupabase` in `@marktiderman/genesis-supabase`). */
-    supabase: AuthClientLike & SupabaseClientInput;
-    /** The data provider. Default `createSupabaseProvider(supabase)`. */
-    provider?: DataProvider;
-    queryClient?: NativeQueryClientOptions;
-    /**
-     * Save queries to the phone: `persistQueries({ storage, keys, buster })`
-     * from `@marktiderman/genesis-native/persist`. The saved cache belongs to
-     * one user: it is restored only for that user and cleared when the user
-     * changes (sign-out, a session that ended while the app was closed, an
-     * account switch).
-     */
-    persist?: (client: QueryClient) => QueryPersistence;
-    /** `expo-splash-screen`: hidden once boot has finished and the session is known. */
-    splash?: SplashModule;
-    /** `KeyboardAwareScrollView` from react-native-keyboard-controller, for form screens. */
-    keyboardScroll?: ComponentType<KeyboardScrollProps>;
-    /** Follow a link held while signed out, once the user signs in. */
-    links?: {
-        hold: LinkHold;
-        onRelease: (path: string) => void;
-    };
-    /** Run before first render, in order (wipe-on-reinstall, hydrate stores, fonts). Read once. */
-    steps?: readonly BootStep[];
-    bootOptions?: BootOptions;
-    /** Longest wait for Supabase's `getSession()` before using the stored session (offline). Default 5000 ms. */
-    sessionWaitMs?: number;
-    /** Default `globalThis.ErrorUtils`. */
-    errorUtils?: ErrorUtilsLike;
-    /** Report unhandled promise rejections to `onError`. Default Hermes's tracker; `null` turns it off. */
-    rejectionTracker?: EnableRejectionTracker | null;
-    /** `AppState` and NetInfo, so queries refetch on focus and know the network. */
-    lifecycle?: QueryLifecycleOptions;
-    /** Every caught error, for reporting (Sentry). */
-    onError?: OnError;
-    /** After a signed-in user signs out, once the query cache is cleared. */
-    onSignedOut?: () => void;
-    /**
-     * The updates block: `createUpdates(…)` from `@marktiderman/genesis-native/updates`
-     * (force upgrade, maintenance, the update banner, what's new). Its policy
-     * loads behind the splash for at most `policyTimeoutMs` and never fails the
-     * boot. Read once; leave it out to turn the block off.
-     */
-    updates?: UpdatesBlock;
-    slots?: Slots<NativeAppSlots>;
-    slotProps?: SlotPropsFor<NativeAppSlots>;
-    children?: ReactNode;
-}
-/** The default boot slot: a plain loading view (the splash covers it at launch). */
-declare function BootScreen(_props: BootScreenProps): react.JSX.Element;
-/**
- * The root of an Expo app: theme, keyboard scrolling, data, boot behind the splash, errors, session and held links.
- *
- * @stability Beta
- */
-declare function GenesisNativeApp(props: GenesisNativeAppProps): react.JSX.Element;
+export { A as AuthClientLike, b as AuthGate, c as AuthGateProps, B as BlockSettingsSection, d as BootController, e as BootOptions, f as BootProvider, g as BootScreen, h as BootScreenProps, i as BootState, j as BootStatus, k as BootStep, l as BootStepContext, m as BootTimeoutError, E as EnableRejectionTracker, n as ErrorReport, o as ErrorUtilsLike, F as FatalScreen, p as FatalScreenProps, G as GenesisErrorBoundary, q as GenesisErrorBoundaryProps, r as GenesisNativeApp, s as GenesisNativeAppProps, t as GlobalErrorHandlerOptions, H as HeldLinkAuth, L as LinkHold, u as LinkOptions, v as LinkTarget, w as NativeAppSlots, N as NativeBlock, x as NativeBlockRootProps, y as NativeQueryClientOptions, O as OnError, P as PlainFatalScreen, S as SessionProvider, z as SessionState, C as SessionStatus, I as SessionStore, J as SessionStoreOptions, K as SettingsRowLike, M as SignedOutProps, Q as SplashModule, R as UseBlockSettingsOptions, T as UseBootReturn, W as UseHeldLinkOptions, X as createBoot, Y as createLinkHold, Z as createSessionStore, _ as defaultErrorUtils, $ as defaultRejectionTracker, a0 as installGlobalErrorHandler, a1 as installRejectionTracker, a2 as mergeBlockSettings, a3 as normalizeLink, a4 as useBlockSettings, a5 as useBlocks, a6 as useBoot, a7 as useHeldLink, a8 as useSession } from './blocks-a1YQ1Elf.js';
+import { A as AsyncStorageLike } from './query-DUmVAfsF.js';
+export { a as AppStateLike, D as DAY_MS, N as NetInfoLike, Q as QueryLifecycleOptions, b as QueryPersistence, c as connectQueryLifecycle, d as createNativeQueryClient } from './query-DUmVAfsF.js';
+import 'react';
+import '@marktiderman/genesis-core/slots';
+import '@marktiderman/genesis-features/blocks';
+import '@tanstack/react-query';
+import '@marktiderman/genesis-design-system';
+import '@marktiderman/genesis-core/provider';
+import '@marktiderman/genesis-ui-native/layouts';
+import '@marktiderman/genesis-ui-native/components';
 
 /**
  * A hydration gate holds writes until a persisted store has loaded from disk.
@@ -375,38 +53,4 @@ interface HydrationGateOptions {
 /** A gate that holds writes until a persisted store has hydrated. */
 declare function createHydrationGate({ onDroppedWrite }?: HydrationGateOptions): HydrationGate;
 
-/**
- * Deep links: turn an incoming universal link or app link into an app path.
- *
- * Meant for expo-router's `app/+native-intent.ts`:
- *
- *   export function redirectSystemPath({ path }: { path: string }) {
- *     return normalizeLink(path, links);
- *   }
- *
- * A link to a path the map doesn't know goes to `"/"` (and `onUnknown`), so a
- * stale or mistyped link opens the app instead of a "not found" screen. It
- * never throws: anything it can't read is unknown.
- */
-/** A target path (`"/clients/:id"`, params filled in) or a function of the params. */
-type LinkTarget = string | ((params: Record<string, string>) => string);
-interface LinkOptions {
-    /** App schemes, without `://` (`["myapp"]`). `myapp://clients/1` is the path `/clients/1`. */
-    schemes?: readonly string[];
-    /** Hosts of universal / app links (`["example.com"]`). Other hosts are unknown. */
-    hosts?: readonly string[];
-    /**
-     * Incoming path pattern → app path. A segment `:name` captures one
-     * segment, a final `*` captures the rest (as `params["*"]`). The first
-     * match wins; `"/"` is always known.
-     */
-    map: Readonly<Record<string, LinkTarget>>;
-    /** Patterns to ignore (return `null`, so expo-router doesn't navigate), e.g. an auth callback. */
-    ignore?: readonly string[];
-    /** Told about each link that went to `"/"` because nothing matched. */
-    onUnknown?: (url: string) => void;
-}
-/** The app path for `url`, `"/"` when it is unknown, or `null` when it is ignored. */
-declare function normalizeLink(url: string, options: LinkOptions): string | null;
-
-export { AsyncStorageLike, type AuthClientLike, AuthGate, type AuthGateProps, type BootController, type BootOptions, BootProvider, BootScreen, type BootScreenProps, type BootState, type BootStatus, type BootStep, type BootStepContext, BootTimeoutError, type EnableRejectionTracker, type ErrorReport, type ErrorUtilsLike, FatalScreen, type FatalScreenProps, GenesisErrorBoundary, type GenesisErrorBoundaryProps, GenesisNativeApp, type GenesisNativeAppProps, type GlobalErrorHandlerOptions, type HeldLinkAuth, type HydrationGate, type HydrationGateOptions, type LinkHold, type LinkOptions, type LinkTarget, type NativeAppSlots, type NativeQueryClientOptions, type OnError, PlainFatalScreen, QueryLifecycleOptions, QueryPersistence, SessionProvider, type SessionState, type SessionStatus, type SessionStore, type SessionStoreOptions, type SignedOutProps, type SplashModule, type UseBootReturn, type UseHeldLinkOptions, createBoot, createHydrationGate, createLinkHold, createSessionStore, defaultErrorUtils, defaultRejectionTracker, installGlobalErrorHandler, installRejectionTracker, normalizeLink, useBoot, useHeldLink, useSession };
+export { AsyncStorageLike, type HydrationGate, type HydrationGateOptions, createHydrationGate };