@crumbsdk/react-native 0.0.1-rc.3 → 0.0.1-rc.5

package/src/index.ts

@@ -1,4 +1,17 @@
 import NativeCrumbReactNative from './NativeCrumbReactNative';
+import { withBuildRelease } from './build-release';
+import {
+  currentScreenJson,
+  setScreen,
+  trackReactNavigation,
+  useExpoRouterScreen,
+} from './screen-context';
+export { setScreen, trackReactNavigation, useExpoRouterScreen };
+export type { CrumbScreenOptions, CrumbNavigationRef } from './screen-context';
+import {
+  configureJavaScriptCrashCapture,
+  recoverJavaScriptCrashes,
+} from './javascript-crash-capture';
 import {
   clearLogs,
   configureLogBuffer,
@@ -9,24 +22,34 @@ import {
 } from './log-buffer';
 import type {
   CrumbConfiguration,
+  CrumbJavaScriptCrashCaptureOptions,
   CrumbLogLevel,
   CrumbLogMetadata,
 } from './types';
 
 export type {
+  CrumbApplicationMetadata,
   CrumbCaptureOptions,
   CrumbConfiguration,
+  CrumbCustomContextOptions,
   CrumbDiagnosticsOptions,
+  CrumbJavaScriptCrashCaptureOptions,
+  CrumbEvidenceCategory,
   CrumbInvocation,
   CrumbLogLevel,
   CrumbLogMetadata,
   CrumbLogOptions,
   CrumbPrivacyOptions,
+  CrumbReporterField,
+  CrumbReporterOptions,
   CrumbRelease,
+  CrumbTheme,
   CrumbUploadOptions,
+  CrumbWorkspacePolicyOptions,
 } from './types';
 
-export async function start(configuration: CrumbConfiguration): Promise<void> {
+export async function start(input: CrumbConfiguration): Promise<void> {
+  const configuration = withBuildRelease(input);
   validateConfiguration(configuration);
   const logOptions = configuration.diagnostics?.logs;
   configureLogBuffer(logOptions);
@@ -38,6 +61,14 @@ export async function start(configuration: CrumbConfiguration): Promise<void> {
   } else {
     disableConsoleCapture();
   }
+
+  configureJavaScriptCrashCapture(
+    configuration.diagnostics?.javascriptCrashCapture,
+    configuration
+  );
+  if (configuration.diagnostics?.javascriptCrashCapture?.enabled) {
+    await recoverJavaScriptCrashes();
+  }
 }
 
 export function installReporter(): Promise<boolean> {
@@ -45,7 +76,7 @@ export function installReporter(): Promise<boolean> {
 }
 
 export function show(): Promise<boolean> {
-  return NativeCrumbReactNative.show();
+  return NativeCrumbReactNative.show(currentScreenJson());
 }
 
 export function log(
@@ -93,6 +124,191 @@ function validateConfiguration(configuration: CrumbConfiguration): void {
     configuration.diagnostics?.logs?.maximumBytes,
     'diagnostics.logs.maximumBytes'
   );
+  if (
+    configuration.diagnostics?.renderingEnabled !== undefined &&
+    typeof configuration.diagnostics.renderingEnabled !== 'boolean'
+  ) {
+    throw new TypeError(
+      'Crumb diagnostics.renderingEnabled must be a boolean.'
+    );
+  }
+  assertJavaScriptCrashCapture(
+    configuration.diagnostics?.javascriptCrashCapture
+  );
+
+  if (
+    configuration.reporter?.theme !== undefined &&
+    !['system', 'light', 'dark'].includes(configuration.reporter.theme)
+  ) {
+    throw new TypeError('Crumb reporter.theme is unsupported.');
+  }
+  assertReporterFields(configuration.reporter?.visibleFields);
+  assertEvidence(configuration.evidence);
+  assertApplicationMetadata(configuration.application?.name);
+  assertCustomContext(configuration.customContext);
+  assertWorkspacePolicy(configuration.workspacePolicy);
+}
+
+function assertJavaScriptCrashCapture(
+  value: CrumbJavaScriptCrashCaptureOptions | undefined
+): void {
+  if (value === undefined) return;
+  assertPositiveInteger(
+    value.maximumBreadcrumbs,
+    'diagnostics.javascriptCrashCapture.maximumBreadcrumbs'
+  );
+  assertPositiveInteger(
+    value.maximumBreadcrumbBytes,
+    'diagnostics.javascriptCrashCapture.maximumBreadcrumbBytes'
+  );
+  if (value.maximumBreadcrumbs !== undefined && value.maximumBreadcrumbs > 50) {
+    throw new TypeError(
+      'Crumb diagnostics.javascriptCrashCapture.maximumBreadcrumbs must be at most 50.'
+    );
+  }
+  if (
+    value.maximumBreadcrumbBytes !== undefined &&
+    value.maximumBreadcrumbBytes > 65_536
+  ) {
+    throw new TypeError(
+      'Crumb diagnostics.javascriptCrashCapture.maximumBreadcrumbBytes must be at most 65536.'
+    );
+  }
+}
+
+function assertReporterFields(value: readonly string[] | undefined): void {
+  if (value === undefined) return;
+  if (
+    new Set(value).size !== value.length ||
+    value.some((field) => !['category', 'description'].includes(field)) ||
+    !value.includes('description')
+  ) {
+    throw new TypeError(
+      'Crumb reporter.visibleFields must contain unique supported fields including description.'
+    );
+  }
+}
+
+function assertEvidence(value: readonly string[] | undefined): void {
+  if (value === undefined) return;
+  const supported = [
+    'screenshot',
+    'performance',
+    'network',
+    'logs',
+    'thread_stacks',
+    'health_check',
+    'custom_context',
+  ];
+  if (
+    new Set(value).size !== value.length ||
+    value.some((item) => !supported.includes(item))
+  ) {
+    throw new TypeError(
+      'Crumb evidence must contain unique supported categories.'
+    );
+  }
+}
+
+function assertApplicationMetadata(value: string | undefined): void {
+  if (value === undefined) return;
+  if (
+    typeof value !== 'string' ||
+    !value.trim() ||
+    value.length > 256 ||
+    hasControlCharacters(value)
+  ) {
+    throw new TypeError(
+      'Crumb application.name must be printable and at most 256 characters.'
+    );
+  }
+}
+
+function assertCustomContext(value: CrumbConfiguration['customContext']): void {
+  if (value === undefined) return;
+  const allowedKeys = value.allowedKeys ?? [];
+  const values = value.values ?? {};
+  if (
+    !Array.isArray(allowedKeys) ||
+    new Set(allowedKeys).size !== allowedKeys.length ||
+    allowedKeys.length > 16 ||
+    allowedKeys.some((key) => !isValidContextKey(key))
+  ) {
+    throw new TypeError(
+      'Crumb customContext.allowedKeys contains an invalid key.'
+    );
+  }
+  if (values === null || typeof values !== 'object' || Array.isArray(values)) {
+    throw new TypeError('Crumb customContext.values must be a string map.');
+  }
+  const entries = Object.entries(values);
+  if (
+    entries.length > 16 ||
+    entries.some(
+      ([key, item]) => !isValidContextKey(key) || typeof item !== 'string'
+    )
+  ) {
+    throw new TypeError(
+      'Crumb customContext.values must contain bounded string values.'
+    );
+  }
+}
+
+function assertWorkspacePolicy(
+  value: CrumbConfiguration['workspacePolicy']
+): void {
+  if (value === undefined) return;
+  assertPositiveInteger(value.timeoutMs, 'workspacePolicy.timeoutMs');
+  if (
+    value.timeoutMs !== undefined &&
+    (value.timeoutMs < 250 || value.timeoutMs > 5000)
+  ) {
+    throw new TypeError(
+      'Crumb workspacePolicy.timeoutMs must be between 250 and 5000.'
+    );
+  }
+  if (value.url === undefined) return;
+  let url: WorkspacePolicyUrl;
+  try {
+    url = new URL(value.url) as unknown as WorkspacePolicyUrl;
+  } catch {
+    throw new TypeError(
+      'Crumb workspacePolicy.url must be a valid HTTP or HTTPS URL.'
+    );
+  }
+  if (
+    !['http:', 'https:'].includes(url.protocol) ||
+    url.username ||
+    url.password ||
+    url.search ||
+    url.hash
+  ) {
+    throw new TypeError(
+      'Crumb workspacePolicy.url must be an HTTP or HTTPS URL without credentials or query values.'
+    );
+  }
+}
+
+interface WorkspacePolicyUrl {
+  protocol: string;
+  username: string;
+  password: string;
+  search: string;
+  hash: string;
+}
+
+function isValidContextKey(value: unknown): value is string {
+  return (
+    typeof value === 'string' &&
+    value.length <= 64 &&
+    /^[A-Za-z][A-Za-z0-9_.-]*$/.test(value)
+  );
+}
+
+function hasControlCharacters(value: string): boolean {
+  return [...value].some(
+    (character) => character < ' ' || character === '\u007f'
+  );
 }
 
 function assertPositiveInteger(value: number | undefined, field: string): void {
@@ -103,6 +319,9 @@ function assertPositiveInteger(value: number | undefined, field: string): void {
 }
 
 const Crumb = Object.freeze({
+  setScreen,
+  trackReactNavigation,
+  useExpoRouterScreen,
   start,
   installReporter,
   show,