@everframe/react-native 1.2.0 → 1.3.0

package/dist/index.d.ts

@@ -1,87 +1,12 @@
 import * as React from 'react';
 import { EverframeUserSpec, ConfigOpts } from './NativeEverframe.js';
 export { Rect, Spec } from './NativeEverframe.js';
-import { z } from 'zod';
 import { E as EverframeIntegration } from './types-D5e4kWaw.js';
-import { R as ReportDeliveryStatus, E as ErrorCaptureStatus, P as PromiseRejectionStatus } from './promise-rejection-types-C-lxCdDl.js';
-export { a as ErrorCaptureCounters, b as ErrorCaptureOutcome, c as ErrorCapturePath, d as PromiseRejectionCounters, e as RejectionReason, f as ReportCaptureOutcome, g as ReportCapturePath, h as ReportCapturePathStatus, i as ReportDeliveryReason, j as ReportQueueOperation, k as ReportQueueStatus, l as ReportStorageFailure, m as ReportTransportOrigin, n as ReportTransportOutcome, o as ReportTransportStatus } from './promise-rejection-types-C-lxCdDl.js';
+import { R as ReportDeliveryStatus, E as ErrorCaptureStatus, P as PromiseRejectionStatus } from './promise-rejection-types-CiyBTz7v.js';
+export { a as ErrorCaptureCounters, b as ErrorCaptureOutcome, c as ErrorCapturePath, d as PromiseRejectionCounters, e as RejectionReason, f as ReportCaptureOutcome, g as ReportCapturePath, h as ReportCapturePathStatus, i as ReportDeliveryReason, j as ReportQueueOperation, k as ReportQueueStatus, l as ReportStorageFailure, m as ReportTransportOrigin, n as ReportTransportOutcome, o as ReportTransportStatus } from './promise-rejection-types-CiyBTz7v.js';
+import { z } from 'zod';
 import { ViewProps, EventSubscription } from 'react-native';
 
-declare const ErrorSeverity: z.ZodEnum<{
-    error: "error";
-    info: "info";
-    warning: "warning";
-}>;
-type ErrorSeverity = z.infer<typeof ErrorSeverity>;
-
-/** Optional per-occurrence details captured with a handled exception. */
-interface CaptureExceptionOptions {
-    severity?: ErrorSeverity;
-    context?: string;
-    metadata?: Record<string, unknown>;
-}
-interface DeviceMetadata {
-    os: string;
-    osVersion: string;
-    model?: string;
-    screenSize: {
-        width: number;
-        height: number;
-    };
-    pixelRatio: number;
-    locale: string;
-    timezone: string;
-    network?: string;
-    /**
-     * Raw User-Agent string from `navigator.userAgent`. Surfaced to triagers so
-     * they can disambiguate things our OS/version parser doesn't capture
-     * (browser engine + version, in-app webviews, bot signatures, accessibility
-     * UA overrides). Web SDK only — native SDKs leave this undefined.
-     */
-    userAgent?: string;
-}
-interface ReportDraft {
-    title: string;
-    description: string;
-    excludedArtifacts: string[];
-    annotations: unknown[];
-    redactions: unknown[];
-    /** Host-supplied free-form metadata (from `setExtra`). Opaque string, ≤2000 chars. */
-    extra?: string;
-}
-/**
- * The SDK key under its name, `sdkKey`, or under `apiKey`, its name before
- * 1.2. `apiKey` is deprecated but still accepted, so a 1.1 config keeps
- * working; `sdkKey` wins when both are set. Exactly one is required.
- */
-type SdkKeyField = {
-    /**
-     * Per-app SDK key (`evf_live_…`; publishable, not secret). Every
-     * Everframe SDK names this field `sdkKey`. It is not the App ID (a UUID)
-     * that symbol and source-map uploads take.
-     */
-    sdkKey: string;
-    /** @deprecated Renamed to `sdkKey`. Still accepted; `sdkKey` wins when both are set. */
-    apiKey?: string;
-} | {
-    sdkKey?: undefined;
-    /** @deprecated Renamed to `sdkKey`. Still accepted. */
-    apiKey: string;
-};
-/** `C` as a host passes it: the SDK key as `sdkKey` or the deprecated `apiKey`. */
-type WithSdkKeyField<C extends {
-    sdkKey: string;
-}> = Omit<C, 'sdkKey'> & SdkKeyField;
-/**
- * A host-supplied function that produces the next report's `extra` payload
- * on demand. Registered via `setExtra(resolve)`; invoked once per report
- * assembly (see `resolveClientExtra`), never at registration time.
- */
-type ExtraResolver = () => string | Record<string, unknown>;
-
-/** Protocol ceiling — `packages/protocol/src/envelope.ts`. */
-declare const EXTRA_MAX_CHARS = 16384;
-
 type JsonScalar = string | number | boolean | null;
 type JsonValue = JsonScalar | JsonValue[] | JsonObject;
 type JsonObject = {
@@ -113,15 +38,17 @@ declare const ReportEnvelope: z.ZodObject<{
         }>;
         version: z.ZodString;
         platform: z.ZodEnum<{
-            android: "android";
-            ios: "ios";
             web: "web";
-            tvos: "tvos";
             tizen: "tizen";
             webos: "webos";
-            androidtv: "androidtv";
-            roku: "roku";
             vega: "vega";
+            vidaa: "vidaa";
+            titanos: "titanos";
+            roku: "roku";
+            android: "android";
+            ios: "ios";
+            tvos: "tvos";
+            androidtv: "androidtv";
         }>;
         formFactor: z.ZodEnum<{
             phone: "phone";
@@ -290,9 +217,9 @@ declare const ReportEnvelope: z.ZodObject<{
             jsBundle: z.ZodOptional<z.ZodObject<{
                 engine: z.ZodLiteral<"hermes">;
                 platform: z.ZodEnum<{
+                    vega: "vega";
                     android: "android";
                     ios: "ios";
-                    vega: "vega";
                 }>;
                 buildId: z.ZodString;
                 bundleName: z.ZodString;
@@ -802,22 +729,85 @@ declare class EverframeNotMountedError extends Error {
     readonly name = "EverframeNotMountedError";
     constructor(message?: string);
 }
+/**
+ * Rejected by `open()` when the host turned the reporter off
+ * (`reporter: { disabled: true }`, a crash-only session). The session keeps
+ * this for its whole life, including after a companion bond upgrades it:
+ * reports then come through the companion, not through `open()`. Same name
+ * as the web SDK's error of the same purpose.
+ */
+declare class EverframeReporterDisabledError extends Error {
+    readonly name = "EverframeReporterDisabledError";
+    constructor(message?: string);
+}
+
+declare const ErrorSeverity: z.ZodEnum<{
+    error: "error";
+    info: "info";
+    warning: "warning";
+}>;
+type ErrorSeverity = z.infer<typeof ErrorSeverity>;
+
+/** Optional per-occurrence details captured with a handled exception. */
+interface CaptureExceptionOptions {
+    severity?: ErrorSeverity;
+    context?: string;
+    metadata?: Record<string, unknown>;
+}
+interface DeviceMetadata {
+    os: string;
+    osVersion: string;
+    model?: string;
+    screenSize: {
+        width: number;
+        height: number;
+    };
+    pixelRatio: number;
+    locale: string;
+    timezone: string;
+    network?: string;
+    /**
+     * Raw User-Agent string from `navigator.userAgent`. Surfaced to triagers so
+     * they can disambiguate things our OS/version parser doesn't capture
+     * (browser engine + version, in-app webviews, bot signatures, accessibility
+     * UA overrides). Web SDK only — native SDKs leave this undefined.
+     */
+    userAgent?: string;
+}
+interface ReportDraft {
+    title: string;
+    description: string;
+    excludedArtifacts: string[];
+    annotations: unknown[];
+    redactions: unknown[];
+    /** Host-supplied free-form metadata (from `setExtra`). Opaque string, ≤2000 chars. */
+    extra?: string;
+}
+/**
+ * A host-supplied function that produces the next report's `extra` payload
+ * on demand. Registered via `setExtra(resolve)`; invoked once per report
+ * assembly (see `resolveClientExtra`), never at registration time.
+ */
+type ExtraResolver = () => string | Record<string, unknown>;
+
+/** Protocol ceiling — `packages/protocol/src/envelope.ts`. */
+declare const EXTRA_MAX_CHARS = 16384;
 
 /** Shape exposed via `useEverframe()` and the top-level `open` re-export. */
 interface EverframeContextValue {
-    /** Cached native delivery observations, independent of JS admission; optional for older context implementations. */
-    getReportDeliveryStatus?(): ReportDeliveryStatus;
-    /** Local admission only; optional for older context implementations. */
-    getErrorCaptureStatus?(): ErrorCaptureStatus;
-    /** Optional for compatibility with existing context implementations. */
-    getPromiseRejectionStatus?(): PromiseRejectionStatus;
+    /** Cached native delivery observations, independent of JS admission. */
+    getReportDeliveryStatus(): ReportDeliveryStatus;
+    /** Local admission only. */
+    getErrorCaptureStatus(): ErrorCaptureStatus;
+    getPromiseRejectionStatus(): PromiseRejectionStatus;
     /** Capture a handled exception without opening the reporter. No-op outside the owning mount. */
     captureException(error: unknown, options?: CaptureExceptionOptions): void;
     /**
      * Open the native reporter modal. Resolves with the user-facing outcome
      * (`submitted` / `queued` / `cancelled`). Replaces the pre-0.3 nested
      * `report.open()` — the `.report` namespace held only `.open` so flattening
-     * matches sdk-react.
+     * matches sdk-react. Rejects with `EverframeReporterDisabledError` when the
+     * config sets `reporter: { disabled: true }`.
      */
     open(): Promise<ReporterResult>;
     sensitive: {
@@ -963,7 +953,7 @@ declare function getReportDeliveryStatus(): ReportDeliveryStatus;
  * review instruction, left as pre-existing behavior rather than folded in
  * here.
  */
-interface RuntimeConfig extends Omit<ConfigOpts, "sdkVersion" | "installIdentifierDisabled" | "crashReportingDisabled" | "companionBadgeEnabled" | "companionBadgePosition" | "shakeToReportEnabled" | "themeBackground" | "themeSurface" | "themeBorder" | "themeText" | "themeTextMuted" | "themeAccent" | "themeAccentForeground" | "themeDestructive" | "vitalsEnabled" | "vitalsSampleRate" | "vitalsCaptureSourceQuery" | "releaseHealthEnabled" | "releaseHealthLoadedBuildId" | "releaseHealthUserId" | "releaseHealthIncludeDebugBuilds"> {
+interface RuntimeConfig extends Omit<ConfigOpts, 'sdkVersion' | 'installIdentifierDisabled' | 'crashReportingDisabled' | 'companionBadgeEnabled' | 'companionBadgePosition' | 'shakeToReportEnabled' | 'reporterDisabled' | 'themeBackground' | 'themeSurface' | 'themeBorder' | 'themeText' | 'themeTextMuted' | 'themeAccent' | 'themeAccentForeground' | 'themeDestructive' | 'vitalsEnabled' | 'vitalsSampleRate' | 'vitalsCaptureSourceQuery' | 'releaseHealthEnabled' | 'releaseHealthLoadedBuildId' | 'releaseHealthUserId' | 'releaseHealthIncludeDebugBuilds'> {
     /**
      * Per-app SDK key (publishable, not secret). Required on the host-facing
      * config — narrows the bridge `ConfigOpts.sdkKey?` to required so a missing
@@ -1056,7 +1046,7 @@ interface RuntimeConfig extends Omit<ConfigOpts, "sdkVersion" | "installIdentifi
      * it through unchanged — the union is a subtype of `string`, so no
      * conversion is needed, same as `captureScreenshot` above.
      */
-    attachPinUi?: "builtin" | "custom" | "off";
+    attachPinUi?: 'builtin' | 'custom' | 'off';
     /**
      * Companion on-screen name-badge visibility/position (naming spec
      * 2026-08-24, controller ruling / Task 6b) — lets a host that finds the
@@ -1071,7 +1061,7 @@ interface RuntimeConfig extends Omit<ConfigOpts, "sdkVersion" | "installIdentifi
      */
     companionBadge?: {
         enabled?: boolean;
-        position?: "bottom-right" | "bottom-left" | "top-right" | "top-left";
+        position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
     };
     /**
      * Native mobile shake gesture. Enabled by default; the dashboard remains
@@ -1081,6 +1071,21 @@ interface RuntimeConfig extends Omit<ConfigOpts, "sdkVersion" | "installIdentifi
     shakeToReport?: {
         enabled?: boolean;
     };
+    /**
+     * Crash-only session switch (spec 2026-10-12). CLIENT VETO only.
+     * `disabled: true` turns off every on-device way to open the reporter
+     * (shake, `open()`, which then rejects with
+     * `EverframeReporterDisabledError`), keeps network bodies off and samples
+     * session replay with the server's crash-only rate (default 0) instead of
+     * the normal one. A companion bond upgrades the session: replay and bodies
+     * then follow the normal server rules for the rest of the session, and
+     * reports come through the companion. Crash and error capture are
+     * unaffected. Flattened onto `ConfigOpts.reporterDisabled` by
+     * `extractBridgeConfig`.
+     */
+    reporter?: {
+        disabled?: boolean;
+    };
     /**
      * Inline reporter theme (reporter branding spec 2026-08-25, RN slice) —
      * 8 optional `#rrggbb` role strings for the NATIVE report dialogs the RN
@@ -1120,11 +1125,8 @@ interface RuntimeConfig extends Omit<ConfigOpts, "sdkVersion" | "installIdentifi
         captureSourceQuery?: boolean;
     };
 }
-/**
- * The provider config as a host passes it: the SDK key as `sdkKey`, or as the
- * deprecated `apiKey` (its name before 1.2).
- */
-type EverframeProviderConfig = WithSdkKeyField<RuntimeConfig>;
+/** The provider config as a host passes it. */
+type EverframeProviderConfig = RuntimeConfig;
 
 interface EverframeProviderProps {
     config: EverframeProviderConfig;
@@ -1393,4 +1395,4 @@ declare namespace companion {
   export { type companion_CompanionAttachChallenge as CompanionAttachChallenge, type companion_CompanionState as CompanionState, companion_getEmitter as getEmitter, companion_onAttachChallenge as onAttachChallenge, companion_onAttachedUserName as onAttachedUserName, companion_onCode as onCode, companion_onPairUrl as onPairUrl, companion_onResolvedName as onResolvedName, companion_onRunning as onRunning, companion_onState as onState, companion_start as start, companion_stop as stop, companion_useCompanion as useCompanion };
 }
 
-export { AttachmentRef, type CaptureExceptionOptions, type CompanionState, ConfigOpts, type DeviceMetadata, EXTRA_MAX_CHARS, ErrorCaptureStatus, type EverframeContextValue, EverframeIntegration, EverframeNotMountedError, EverframeProvider, type EverframeProviderProps, EverframeScreen, type EverframeScreenProps, EverframeSensitive, EverframeUserSpec, type HostPlayerEventType, type PlayerHandle, type PlayerStats, PromiseRejectionStatus, ReportDeliveryStatus, type ReportDraft, ReportEnvelope, type ReporterResult, EverframeSensitive as Sensitive, type TrackPlayerOptions, UINode, UITree, VitalsPlayerEventType, addBreadcrumb, captureException, companion, getErrorCaptureStatus, getPromiseRejectionStatus, getReportDeliveryStatus, open, recordScreen, setExtra, setUser, trackPlayer, trackVitals, useCompanion, useEverframe, useEverframeScreen, useEverframeSensitiveRef, useTrackPlayer };
+export { AttachmentRef, type CaptureExceptionOptions, type CompanionState, ConfigOpts, type DeviceMetadata, EXTRA_MAX_CHARS, ErrorCaptureStatus, type EverframeContextValue, EverframeIntegration, EverframeNotMountedError, EverframeProvider, type EverframeProviderProps, EverframeReporterDisabledError, EverframeScreen, type EverframeScreenProps, EverframeSensitive, EverframeUserSpec, type HostPlayerEventType, type PlayerHandle, type PlayerStats, PromiseRejectionStatus, ReportDeliveryStatus, type ReportDraft, ReportEnvelope, type ReporterResult, EverframeSensitive as Sensitive, type TrackPlayerOptions, UINode, UITree, VitalsPlayerEventType, addBreadcrumb, captureException, companion, getErrorCaptureStatus, getPromiseRejectionStatus, getReportDeliveryStatus, open, recordScreen, setExtra, setUser, trackPlayer, trackVitals, useCompanion, useEverframe, useEverframeScreen, useEverframeSensitiveRef, useTrackPlayer };