@marktiderman/genesis-support 0.0.0-stage → 0.2.0

package/dist/native.d.ts

@@ -0,0 +1,207 @@
+import * as react from 'react';
+import { ComponentType, ReactNode } from 'react';
+import { NativeBlock, NativeBlockRootProps } from '@marktiderman/genesis-native';
+import { S as SUPPORT_BLOCK_ID, b as SupportPaths } from './block-fZjTS2sY.js';
+import { u as ScreenshotContentType, M as SupportSupabase, c as ContextCollector, A as SupportCopyOverrides, x as SupportClient, z as SupportCopy, o as FeedbackType, j as FeedbackDelivery, H as SupportIdea, K as SupportReport } from './copy-CuTArBFg.js';
+import { InboxPageProps, ThreadPageProps } from '@marktiderman/genesis-ui-native/layouts';
+import '@marktiderman/genesis-features/blocks';
+import '@supabase/supabase-js';
+
+/**
+ * The native modules the support block can use, as the shapes it needs. The
+ * app passes the real ones (all optional peers), so the block runs without
+ * any of them and the tests pass fakes:
+ *
+ *   import * as ViewShot from "react-native-view-shot";   // screenshots, mark-up
+ *   import { Accelerometer } from "expo-sensors";          // shake to report
+ */
+interface CaptureOptions {
+    format?: "png" | "jpg" | "webp";
+    quality?: number;
+    result?: "tmpfile" | "base64" | "data-uri";
+    width?: number;
+    height?: number;
+}
+/** `react-native-view-shot`: `captureScreen` (the whole screen) and `captureRef` (one view, for flattening mark-up). */
+interface ViewShotLike {
+    captureScreen(options?: CaptureOptions): Promise<string>;
+    captureRef(view: unknown, options?: CaptureOptions): Promise<string>;
+}
+interface AccelerometerMeasurement {
+    x: number;
+    y: number;
+    z: number;
+}
+/** `expo-sensors`' `Accelerometer` (values in g). */
+interface AccelerometerLike {
+    addListener(listener: (measurement: AccelerometerMeasurement) => void): {
+        remove(): void;
+    };
+    setUpdateInterval?(intervalMs: number): void;
+}
+interface ShakeOptions {
+    /** Acceleration, in g, that counts as a jolt. Default 2.3. */
+    threshold?: number;
+    /** Jolts needed within `windowMs`. Default 2. */
+    jolts?: number;
+    windowMs?: number;
+    /** Quiet time after a shake. Default 3000 ms. */
+    cooldownMs?: number;
+    intervalMs?: number;
+    now?: () => number;
+}
+/** Calls `onShake` when the phone is shaken: a few strong jolts close together, then a cooldown. Returns the stop. */
+declare function listenForShake(accelerometer: AccelerometerLike, onShake: () => void, options?: ShakeOptions): () => void;
+
+/** A screenshot waiting for the feedback screen. `uri` is a data URI. */
+interface PendingScreenshot {
+    uri: string;
+    contentType: ScreenshotContentType;
+    width: number;
+    height: number;
+}
+/** What the feedback screen opens with: where the person was, and maybe a screenshot of it. */
+interface PendingFeedback {
+    route: string | null;
+    screenshot: PendingScreenshot | null;
+    /** Extra context to send with the report (the devtools overlay's debug report). */
+    extra?: Record<string, unknown>;
+}
+interface SupportOptions {
+    /** The app's Supabase client (migration 0006 applied). */
+    supabase: SupportSupabase;
+    /** Opens a path (expo-router's `router.push`). */
+    navigate: (href: string) => void;
+    /** `Platform.OS`. Default from React Native. */
+    platform?: string;
+    /** The version signature sent with each report (`useVersionSignature().short`, or a function that reads it). */
+    appVersion?: string | (() => string | undefined);
+    /** The current route, as a hook (expo-router's `usePathname`). The root calls it. */
+    useCurrentRoute?: () => string;
+    /** More context (device facts, the update id). Merged over the defaults. */
+    collector?: ContextCollector;
+    /** `react-native-view-shot`. Without it there are no screenshots. */
+    viewShot?: ViewShotLike;
+    /** `expo-sensors`' `Accelerometer`. Without it (or with `shake: false`) shaking does nothing. */
+    accelerometer?: AccelerometerLike;
+    shake?: false | ShakeOptions;
+    /** Default `/support`. The route files live under it. */
+    basePath?: string;
+    copy?: SupportCopyOverrides;
+    /** The Settings rows' section (default `support`), or `false` for none. */
+    settings?: false | {
+        section?: string;
+    };
+    /** `false` leaves the idea board out. */
+    ideas?: boolean;
+    /** Every caught error, for reporting. None of them reaches the person as a crash. */
+    onError?: (error: Error, where: "capture" | "shake") => void;
+}
+interface SupportBlock extends NativeBlock<typeof SUPPORT_BLOCK_ID> {
+    readonly options: SupportOptions;
+    readonly client: SupportClient;
+    readonly copy: SupportCopy;
+    readonly paths: SupportPaths;
+    readonly collector: ContextCollector;
+    /** Capture the screen (if it can and `screenshot` isn't false), then open the feedback screen. */
+    openFeedback(options?: {
+        screenshot?: boolean;
+        extra?: Record<string, unknown>;
+        delayMs?: number;
+    }): Promise<void>;
+    /** Hand the feedback screen what it opens with (`takePending` empties it). */
+    takePending(): PendingFeedback | null;
+    peekPending(): PendingFeedback | null;
+    subscribePending(listener: () => void): () => void;
+    /** The route the person is on, as the root last saw it. */
+    currentRoute(): string | null;
+    readonly Root: ComponentType<NativeBlockRootProps>;
+}
+/** The support block, from `GenesisNativeApp blocks` (or `SupportProvider`). Throws outside one. */
+declare function useSupport(): SupportBlock;
+/** The same block, or `null` when support is off (for a button that hides itself). */
+declare function useOptionalSupport(): SupportBlock | null;
+declare function SupportProvider({ block, children }: {
+    block: SupportBlock;
+    children?: ReactNode;
+}): react.JSX.Element;
+declare const SUPPORT_QUERY_ROOT = "genesis-support";
+/** How many reports have a staff reply the person hasn't read. */
+declare function useUnreadReplies(): number;
+declare function createSupport(options: SupportOptions): SupportBlock;
+/** The pending feedback, re-rendering when it changes. */
+declare function usePendingFeedback(): PendingFeedback | null;
+
+interface FeedbackFormProps {
+    defaultType?: FeedbackType;
+    /** After a report is saved (go back, say thanks). The form has already shown its own confirmation, unless `sentAlert` is false. */
+    onSent?: (delivery: FeedbackDelivery) => void;
+    /** Confirm a sent report with an alert. Default true; false when `onSent` says so itself (a toast). */
+    sentAlert?: boolean;
+    testID?: string;
+}
+declare function FeedbackForm({ defaultType, onSent, sentAlert, testID }: FeedbackFormProps): react.JSX.Element;
+
+type Point = {
+    x: number;
+    y: number;
+};
+/** The dots along a stroke, close enough to read as a line. */
+declare function strokeDots(points: readonly Point[], spacing?: number): Point[];
+declare function boxOf(from: Point, to: Point): {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+};
+interface ScreenshotAnnotatorProps {
+    screenshot: PendingScreenshot;
+    viewShot: ViewShotLike;
+    copy: SupportCopy["annotate"];
+    /** `marked`: the image now carries marks (pen or hidden parts). */
+    onDone: (screenshot: PendingScreenshot, marked: boolean) => void;
+    /** `hadMarks`: the person drew something and left without saving it. */
+    onCancel: (hadMarks: boolean) => void;
+    testID?: string;
+}
+declare function ScreenshotAnnotator({ screenshot, viewShot, copy, onDone, onCancel, testID }: ScreenshotAnnotatorProps): react.JSX.Element;
+
+type InboxProps = Pick<InboxPageProps, "items" | "refreshing" | "onRefresh" | "emptyTitle" | "emptyBody" | "emptyActionLabel" | "onEmptyAction" | "sectionTitle" | "header" | "testID" | "loading" | "error" | "errorTitle" | "errorBody"> & {
+    headerTitle: string;
+};
+/** Help: the person's reports, newest first, with unread staff replies, and links to the idea board. */
+declare function useSupportInbox(): InboxProps;
+type ThreadProps = Pick<ThreadPageProps, "messages" | "composer" | "closedNotice" | "readAt" | "readLabel" | "emptyTitle" | "emptyBody" | "labels" | "testID"> & {
+    headerTitle: string;
+    report: SupportReport | null;
+    loading: boolean;
+    /** Read, and there is no such report (deleted, or not the person's): leave the screen. */
+    notFound: boolean;
+};
+/** One report as a conversation: the report itself, then the replies. Marks it read as it opens and as replies arrive. */
+declare function useSupportThread(reportId: string, options?: {
+    pollMs?: number;
+}): ThreadProps;
+/** A vote toggle for an idea row. */
+declare function VoteButton({ idea, onToggle, testID }: {
+    idea: SupportIdea;
+    onToggle: () => void;
+    testID?: string;
+}): react.JSX.Element;
+type BoardProps = Pick<InboxPageProps, "items" | "refreshing" | "onRefresh" | "emptyTitle" | "emptyBody" | "header" | "testID" | "loading" | "error" | "errorTitle" | "errorBody"> & {
+    headerTitle: string;
+};
+/** The idea board: most votes first, a vote button on each, and a field to suggest one. */
+declare function useIdeaBoard(): BoardProps;
+/** "You asked, we shipped": the shipped ideas the person suggested or voted for, with the FeatureId each shipped as. */
+declare function useShippedIdeas(): Omit<BoardProps, "header">;
+/**
+ * "Send feedback", for a devtools panel's slot or any screen: captures the
+ * screen, then opens the feedback screen. Renders nothing when support is off.
+ */
+declare function SendFeedbackButton({ testID, screenshot }: {
+    testID?: string;
+    screenshot?: boolean;
+}): react.JSX.Element | null;
+
+export { type AccelerometerLike, type AccelerometerMeasurement, type CaptureOptions, FeedbackForm, type FeedbackFormProps, type PendingFeedback, type PendingScreenshot, SUPPORT_QUERY_ROOT, ScreenshotAnnotator, type ScreenshotAnnotatorProps, SendFeedbackButton, type ShakeOptions, type SupportBlock, type SupportOptions, SupportProvider, type ViewShotLike, VoteButton, boxOf, createSupport, listenForShake, strokeDots, useIdeaBoard, useOptionalSupport, usePendingFeedback, useShippedIdeas, useSupport, useSupportInbox, useSupportThread, useUnreadReplies };