crumbtrail-react-native 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,231 @@
+import { SessionStore, PersistedSession, TargetDescriptor, Crumbtrail, CrumbtrailConfig } from 'crumbtrail-core';
+import { ReactNode, Component, ErrorInfo } from 'react';
+
+declare const REACT_NATIVE_CAPABILITY_BITS: {
+    readonly asyncStorage: number;
+    readonly navigation: number;
+    readonly viewShot: number;
+};
+type ReactNativeOptionalModuleName = "asyncStorage" | "navigation" | "viewShot";
+type ReactNativeCapabilityStatus = "present" | "absent";
+interface ReactNativeCapabilityDetail {
+    packageName: string;
+    present: boolean;
+    status: ReactNativeCapabilityStatus;
+}
+type ReactNativeCapabilityModules = Record<ReactNativeOptionalModuleName, ReactNativeCapabilityDetail>;
+interface ReactNativeCapabilities {
+    bitset: number;
+    capabilities: string[];
+    modules: ReactNativeCapabilityModules;
+}
+type OptionalModuleResolver = (packageName: string) => unknown;
+interface DetectReactNativeCapabilitiesOptions {
+    resolver?: OptionalModuleResolver;
+}
+declare function detectReactNativeCapabilities(options?: DetectReactNativeCapabilitiesOptions): ReactNativeCapabilities;
+
+interface AsyncStorageLike {
+    getItem(key: string): Promise<string | null> | string | null;
+    setItem(key: string, value: string): Promise<void> | void;
+}
+interface ReactNativeSessionStore extends SessionStore {
+    hydrate(): Promise<PersistedSession | undefined>;
+}
+declare function createReactNativeSessionStore(storage: AsyncStorageLike | null | undefined, key?: string): ReactNativeSessionStore | undefined;
+
+interface ReactNativeTargetInput {
+    role?: string;
+    label?: string;
+    testID?: string;
+    testId?: string;
+    accessibilityId?: string;
+    accessibilityLabel?: string;
+    componentName?: string;
+    routePath?: string;
+    ancestryHash?: string;
+    bounds?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    redaction?: unknown;
+}
+declare function createReactNativeTargetDescriptor(input: ReactNativeTargetInput): TargetDescriptor | undefined;
+
+interface ReactNativeViewSnapshotNode {
+    id?: string;
+    componentName?: string;
+    role?: string;
+    label?: string;
+    testID?: string;
+    accessibilityId?: string;
+    bounds?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    children?: ReactNativeViewSnapshotNode[];
+}
+interface ReactNativeViewSnapshot {
+    routePath?: string;
+    root: ReactNativeViewSnapshotNode;
+}
+interface ReactNativeTouchOverlay {
+    x: number;
+    y: number;
+    target?: TargetDescriptor | ReactNativeTargetInput;
+    phase?: "start" | "move" | "end" | "cancel" | "press";
+}
+interface ReactNativeViewShotModule {
+    captureRef?: (target: unknown, options?: Record<string, unknown>) => Promise<string> | string;
+    captureScreen?: (options?: Record<string, unknown>) => Promise<string> | string;
+}
+interface ReplayLiteLogger {
+    addEvent(partial: {
+        type: string;
+        data: Record<string, unknown>;
+        platform?: "react-native";
+        sdk?: {
+            name: string;
+            version?: string;
+        };
+        capabilities?: string[];
+        target?: TargetDescriptor;
+    }): void;
+}
+interface ReactNativeReplayLiteOptions {
+    logger: ReplayLiteLogger;
+    capabilities: string[];
+    viewShot?: ReactNativeViewShotModule | null;
+}
+interface ReactNativeReplayLiteController {
+    recordViewSnapshot(snapshot: ReactNativeViewSnapshot): void;
+    recordTouch(overlay: ReactNativeTouchOverlay): void;
+    captureCrashScreenshot(target?: unknown): Promise<string | undefined>;
+}
+declare function createReactNativeReplayLite(options: ReactNativeReplayLiteOptions): ReactNativeReplayLiteController;
+
+type ReactNativeCollectorName = "console" | "errors" | "network" | "appState" | "environment" | "navigation" | "replayLite";
+type ReactNativeCollectorConfig = boolean | Partial<Record<ReactNativeCollectorName, boolean>>;
+interface ReactNativeAppStateModule {
+    currentState?: string;
+    addEventListener?: (type: string, listener: (state: string) => void) => {
+        remove?: () => void;
+    } | (() => void);
+}
+interface ReactNativePlatformModule {
+    OS?: string;
+    Version?: string | number;
+    constants?: Record<string, unknown>;
+}
+interface ReactNativeDimensionsModule {
+    get?: (dimension: "window" | "screen") => {
+        width?: number;
+        height?: number;
+        scale?: number;
+        fontScale?: number;
+    };
+    addEventListener?: (type: string, listener: (event: Record<string, unknown>) => void) => {
+        remove?: () => void;
+    } | (() => void);
+}
+interface ReactNativeModule {
+    AppState?: ReactNativeAppStateModule;
+    Platform?: ReactNativePlatformModule;
+    Dimensions?: ReactNativeDimensionsModule;
+}
+interface ReactNativeNavigationLike {
+    getCurrentRoute?: () => {
+        name?: string;
+        path?: string;
+        key?: string;
+    } | undefined;
+    addListener?: (event: string, listener: () => void) => (() => void) | {
+        remove?: () => void;
+    };
+}
+interface ReactNativeErrorUtilsLike {
+    getGlobalHandler?: () => ((error: unknown, isFatal?: boolean) => void) | undefined;
+    setGlobalHandler?: (handler: (error: unknown, isFatal?: boolean) => void) => void;
+}
+interface ReactNativeCollectorRuntime {
+    globalObject?: typeof globalThis & Record<string, unknown>;
+    reactNative?: ReactNativeModule | null;
+    navigation?: ReactNativeNavigationLike | null;
+    errorUtils?: ReactNativeErrorUtilsLike | null;
+}
+interface StartReactNativeCollectorsOptions extends ReactNativeCollectorRuntime {
+    config?: ReactNativeCollectorConfig;
+    capabilities: ReactNativeCapabilities;
+    resolver?: OptionalModuleResolver;
+}
+interface ReactNativeCollectorController {
+    cleanup(): void;
+    replayLite?: ReactNativeReplayLiteController;
+}
+declare function startReactNativeCollectors(logger: Crumbtrail, options: StartReactNativeCollectorsOptions): ReactNativeCollectorController;
+
+interface ReactNativeCrumbtrailOptions extends DetectReactNativeCapabilitiesOptions, ReactNativeCollectorRuntime {
+    config?: Partial<CrumbtrailConfig>;
+    asyncStorage?: AsyncStorageLike | null;
+    reportCapabilities?: boolean;
+    collectors?: ReactNativeCollectorConfig;
+}
+interface ReactNativeCrumbtrailResult {
+    logger: Crumbtrail;
+    capabilities: ReactNativeCapabilities;
+    collectors: ReactNativeCollectorController;
+}
+declare function createReactNativeCrumbtrail(options?: ReactNativeCrumbtrailOptions): ReactNativeCrumbtrailResult;
+declare function createReactNativeCrumbtrailAsync(options?: ReactNativeCrumbtrailOptions): Promise<ReactNativeCrumbtrailResult>;
+
+interface CrumbtrailReactNativeContextValue {
+    logger: Crumbtrail;
+    capabilities: ReactNativeCapabilities;
+}
+interface CrumbtrailReactNativeProviderProps {
+    children: ReactNode;
+    logger?: Crumbtrail;
+    config?: Partial<CrumbtrailConfig>;
+    asyncStorage?: AsyncStorageLike | null;
+    resolver?: OptionalModuleResolver;
+    reportCapabilities?: boolean;
+    fallback?: ReactNode;
+}
+declare function CrumbtrailReactNativeProvider(props: CrumbtrailReactNativeProviderProps): ReactNode;
+declare function useCrumbtrailReactNative(): CrumbtrailReactNativeContextValue;
+
+interface BugStateLogger {
+    registerStateProvider(name: string, provider: () => unknown): () => void;
+}
+interface UseBugStateOptions {
+    captureRawState?: boolean;
+}
+declare function redactReactNativeSnapshot(value: unknown, keyName?: string): unknown;
+declare function useBugState(logger: BugStateLogger | null | undefined, name: string, value: unknown, options?: UseBugStateOptions): void;
+
+interface CrumbtrailReactNativeErrorBoundaryProps {
+    logger: BugStateLogger & {
+        addEvent(partial: {
+            type: string;
+            data: Record<string, unknown>;
+        }): void;
+    };
+    children: ReactNode;
+    fallback?: ReactNode;
+}
+interface State {
+    hasError: boolean;
+}
+declare class CrumbtrailReactNativeErrorBoundary extends Component<CrumbtrailReactNativeErrorBoundaryProps, State> {
+    constructor(props: CrumbtrailReactNativeErrorBoundaryProps);
+    static getDerivedStateFromError(_error: Error): State;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    resetError(): void;
+    render(): ReactNode;
+}
+
+export { type AsyncStorageLike, type BugStateLogger, type CrumbtrailReactNativeContextValue, CrumbtrailReactNativeErrorBoundary, type CrumbtrailReactNativeErrorBoundaryProps, CrumbtrailReactNativeProvider, type CrumbtrailReactNativeProviderProps, type DetectReactNativeCapabilitiesOptions, type OptionalModuleResolver, REACT_NATIVE_CAPABILITY_BITS, type ReactNativeAppStateModule, type ReactNativeCapabilities, type ReactNativeCapabilityDetail, type ReactNativeCapabilityModules, type ReactNativeCapabilityStatus, type ReactNativeCollectorConfig, type ReactNativeCollectorController, type ReactNativeCollectorName, type ReactNativeCollectorRuntime, type ReactNativeCrumbtrailOptions, type ReactNativeCrumbtrailResult, type ReactNativeDimensionsModule, type ReactNativeErrorUtilsLike, type ReactNativeModule, type ReactNativeNavigationLike, type ReactNativeOptionalModuleName, type ReactNativePlatformModule, type ReactNativeReplayLiteController, type ReactNativeReplayLiteOptions, type ReactNativeSessionStore, type ReactNativeTargetInput, type ReactNativeTouchOverlay, type ReactNativeViewShotModule, type ReactNativeViewSnapshot, type ReactNativeViewSnapshotNode, type UseBugStateOptions, createReactNativeCrumbtrail, createReactNativeCrumbtrailAsync, createReactNativeReplayLite, createReactNativeSessionStore, createReactNativeTargetDescriptor, detectReactNativeCapabilities, redactReactNativeSnapshot, startReactNativeCollectors, useBugState, useCrumbtrailReactNative };

package/dist/index.d.ts

@@ -0,0 +1,231 @@
+import { SessionStore, PersistedSession, TargetDescriptor, Crumbtrail, CrumbtrailConfig } from 'crumbtrail-core';
+import { ReactNode, Component, ErrorInfo } from 'react';
+
+declare const REACT_NATIVE_CAPABILITY_BITS: {
+    readonly asyncStorage: number;
+    readonly navigation: number;
+    readonly viewShot: number;
+};
+type ReactNativeOptionalModuleName = "asyncStorage" | "navigation" | "viewShot";
+type ReactNativeCapabilityStatus = "present" | "absent";
+interface ReactNativeCapabilityDetail {
+    packageName: string;
+    present: boolean;
+    status: ReactNativeCapabilityStatus;
+}
+type ReactNativeCapabilityModules = Record<ReactNativeOptionalModuleName, ReactNativeCapabilityDetail>;
+interface ReactNativeCapabilities {
+    bitset: number;
+    capabilities: string[];
+    modules: ReactNativeCapabilityModules;
+}
+type OptionalModuleResolver = (packageName: string) => unknown;
+interface DetectReactNativeCapabilitiesOptions {
+    resolver?: OptionalModuleResolver;
+}
+declare function detectReactNativeCapabilities(options?: DetectReactNativeCapabilitiesOptions): ReactNativeCapabilities;
+
+interface AsyncStorageLike {
+    getItem(key: string): Promise<string | null> | string | null;
+    setItem(key: string, value: string): Promise<void> | void;
+}
+interface ReactNativeSessionStore extends SessionStore {
+    hydrate(): Promise<PersistedSession | undefined>;
+}
+declare function createReactNativeSessionStore(storage: AsyncStorageLike | null | undefined, key?: string): ReactNativeSessionStore | undefined;
+
+interface ReactNativeTargetInput {
+    role?: string;
+    label?: string;
+    testID?: string;
+    testId?: string;
+    accessibilityId?: string;
+    accessibilityLabel?: string;
+    componentName?: string;
+    routePath?: string;
+    ancestryHash?: string;
+    bounds?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    redaction?: unknown;
+}
+declare function createReactNativeTargetDescriptor(input: ReactNativeTargetInput): TargetDescriptor | undefined;
+
+interface ReactNativeViewSnapshotNode {
+    id?: string;
+    componentName?: string;
+    role?: string;
+    label?: string;
+    testID?: string;
+    accessibilityId?: string;
+    bounds?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    children?: ReactNativeViewSnapshotNode[];
+}
+interface ReactNativeViewSnapshot {
+    routePath?: string;
+    root: ReactNativeViewSnapshotNode;
+}
+interface ReactNativeTouchOverlay {
+    x: number;
+    y: number;
+    target?: TargetDescriptor | ReactNativeTargetInput;
+    phase?: "start" | "move" | "end" | "cancel" | "press";
+}
+interface ReactNativeViewShotModule {
+    captureRef?: (target: unknown, options?: Record<string, unknown>) => Promise<string> | string;
+    captureScreen?: (options?: Record<string, unknown>) => Promise<string> | string;
+}
+interface ReplayLiteLogger {
+    addEvent(partial: {
+        type: string;
+        data: Record<string, unknown>;
+        platform?: "react-native";
+        sdk?: {
+            name: string;
+            version?: string;
+        };
+        capabilities?: string[];
+        target?: TargetDescriptor;
+    }): void;
+}
+interface ReactNativeReplayLiteOptions {
+    logger: ReplayLiteLogger;
+    capabilities: string[];
+    viewShot?: ReactNativeViewShotModule | null;
+}
+interface ReactNativeReplayLiteController {
+    recordViewSnapshot(snapshot: ReactNativeViewSnapshot): void;
+    recordTouch(overlay: ReactNativeTouchOverlay): void;
+    captureCrashScreenshot(target?: unknown): Promise<string | undefined>;
+}
+declare function createReactNativeReplayLite(options: ReactNativeReplayLiteOptions): ReactNativeReplayLiteController;
+
+type ReactNativeCollectorName = "console" | "errors" | "network" | "appState" | "environment" | "navigation" | "replayLite";
+type ReactNativeCollectorConfig = boolean | Partial<Record<ReactNativeCollectorName, boolean>>;
+interface ReactNativeAppStateModule {
+    currentState?: string;
+    addEventListener?: (type: string, listener: (state: string) => void) => {
+        remove?: () => void;
+    } | (() => void);
+}
+interface ReactNativePlatformModule {
+    OS?: string;
+    Version?: string | number;
+    constants?: Record<string, unknown>;
+}
+interface ReactNativeDimensionsModule {
+    get?: (dimension: "window" | "screen") => {
+        width?: number;
+        height?: number;
+        scale?: number;
+        fontScale?: number;
+    };
+    addEventListener?: (type: string, listener: (event: Record<string, unknown>) => void) => {
+        remove?: () => void;
+    } | (() => void);
+}
+interface ReactNativeModule {
+    AppState?: ReactNativeAppStateModule;
+    Platform?: ReactNativePlatformModule;
+    Dimensions?: ReactNativeDimensionsModule;
+}
+interface ReactNativeNavigationLike {
+    getCurrentRoute?: () => {
+        name?: string;
+        path?: string;
+        key?: string;
+    } | undefined;
+    addListener?: (event: string, listener: () => void) => (() => void) | {
+        remove?: () => void;
+    };
+}
+interface ReactNativeErrorUtilsLike {
+    getGlobalHandler?: () => ((error: unknown, isFatal?: boolean) => void) | undefined;
+    setGlobalHandler?: (handler: (error: unknown, isFatal?: boolean) => void) => void;
+}
+interface ReactNativeCollectorRuntime {
+    globalObject?: typeof globalThis & Record<string, unknown>;
+    reactNative?: ReactNativeModule | null;
+    navigation?: ReactNativeNavigationLike | null;
+    errorUtils?: ReactNativeErrorUtilsLike | null;
+}
+interface StartReactNativeCollectorsOptions extends ReactNativeCollectorRuntime {
+    config?: ReactNativeCollectorConfig;
+    capabilities: ReactNativeCapabilities;
+    resolver?: OptionalModuleResolver;
+}
+interface ReactNativeCollectorController {
+    cleanup(): void;
+    replayLite?: ReactNativeReplayLiteController;
+}
+declare function startReactNativeCollectors(logger: Crumbtrail, options: StartReactNativeCollectorsOptions): ReactNativeCollectorController;
+
+interface ReactNativeCrumbtrailOptions extends DetectReactNativeCapabilitiesOptions, ReactNativeCollectorRuntime {
+    config?: Partial<CrumbtrailConfig>;
+    asyncStorage?: AsyncStorageLike | null;
+    reportCapabilities?: boolean;
+    collectors?: ReactNativeCollectorConfig;
+}
+interface ReactNativeCrumbtrailResult {
+    logger: Crumbtrail;
+    capabilities: ReactNativeCapabilities;
+    collectors: ReactNativeCollectorController;
+}
+declare function createReactNativeCrumbtrail(options?: ReactNativeCrumbtrailOptions): ReactNativeCrumbtrailResult;
+declare function createReactNativeCrumbtrailAsync(options?: ReactNativeCrumbtrailOptions): Promise<ReactNativeCrumbtrailResult>;
+
+interface CrumbtrailReactNativeContextValue {
+    logger: Crumbtrail;
+    capabilities: ReactNativeCapabilities;
+}
+interface CrumbtrailReactNativeProviderProps {
+    children: ReactNode;
+    logger?: Crumbtrail;
+    config?: Partial<CrumbtrailConfig>;
+    asyncStorage?: AsyncStorageLike | null;
+    resolver?: OptionalModuleResolver;
+    reportCapabilities?: boolean;
+    fallback?: ReactNode;
+}
+declare function CrumbtrailReactNativeProvider(props: CrumbtrailReactNativeProviderProps): ReactNode;
+declare function useCrumbtrailReactNative(): CrumbtrailReactNativeContextValue;
+
+interface BugStateLogger {
+    registerStateProvider(name: string, provider: () => unknown): () => void;
+}
+interface UseBugStateOptions {
+    captureRawState?: boolean;
+}
+declare function redactReactNativeSnapshot(value: unknown, keyName?: string): unknown;
+declare function useBugState(logger: BugStateLogger | null | undefined, name: string, value: unknown, options?: UseBugStateOptions): void;
+
+interface CrumbtrailReactNativeErrorBoundaryProps {
+    logger: BugStateLogger & {
+        addEvent(partial: {
+            type: string;
+            data: Record<string, unknown>;
+        }): void;
+    };
+    children: ReactNode;
+    fallback?: ReactNode;
+}
+interface State {
+    hasError: boolean;
+}
+declare class CrumbtrailReactNativeErrorBoundary extends Component<CrumbtrailReactNativeErrorBoundaryProps, State> {
+    constructor(props: CrumbtrailReactNativeErrorBoundaryProps);
+    static getDerivedStateFromError(_error: Error): State;
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    resetError(): void;
+    render(): ReactNode;
+}
+
+export { type AsyncStorageLike, type BugStateLogger, type CrumbtrailReactNativeContextValue, CrumbtrailReactNativeErrorBoundary, type CrumbtrailReactNativeErrorBoundaryProps, CrumbtrailReactNativeProvider, type CrumbtrailReactNativeProviderProps, type DetectReactNativeCapabilitiesOptions, type OptionalModuleResolver, REACT_NATIVE_CAPABILITY_BITS, type ReactNativeAppStateModule, type ReactNativeCapabilities, type ReactNativeCapabilityDetail, type ReactNativeCapabilityModules, type ReactNativeCapabilityStatus, type ReactNativeCollectorConfig, type ReactNativeCollectorController, type ReactNativeCollectorName, type ReactNativeCollectorRuntime, type ReactNativeCrumbtrailOptions, type ReactNativeCrumbtrailResult, type ReactNativeDimensionsModule, type ReactNativeErrorUtilsLike, type ReactNativeModule, type ReactNativeNavigationLike, type ReactNativeOptionalModuleName, type ReactNativePlatformModule, type ReactNativeReplayLiteController, type ReactNativeReplayLiteOptions, type ReactNativeSessionStore, type ReactNativeTargetInput, type ReactNativeTouchOverlay, type ReactNativeViewShotModule, type ReactNativeViewSnapshot, type ReactNativeViewSnapshotNode, type UseBugStateOptions, createReactNativeCrumbtrail, createReactNativeCrumbtrailAsync, createReactNativeReplayLite, createReactNativeSessionStore, createReactNativeTargetDescriptor, detectReactNativeCapabilities, redactReactNativeSnapshot, startReactNativeCollectors, useBugState, useCrumbtrailReactNative };