@appmetrica/react-native-analytics 3.6.0 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appmetrica/react-native-analytics",
-  "version": "3.6.0",
+  "version": "4.1.0",
   "description": "React Native plugin for AppMetrica analytics tool",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -29,8 +29,10 @@
     "test": "jest",
     "typecheck": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx}\"",
     "clean": "del-cli android/build lib",
-    "prepare": "bob build"
+    "prepack": "bob build"
   },
   "keywords": [
     "appmetrica",
@@ -55,20 +57,19 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@react-native/eslint-config": "^0.73.1",
-    "@types/jest": "^29.5.5",
+    "@react-native/eslint-config": "^0.76.0",
+    "@types/jest": "^29.5.12",
     "@types/jsdom": "^21.1.7",
-    "@types/react": "^18.2.44",
     "@types/node": "^22.10.0",
+    "@types/react": "^18.2.6",
     "del-cli": "^5.1.0",
     "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",
-    "react": "18.2.0",
-    "react-native": "0.74.2",
-    "react-native-builder-bob": "^0.20.0",
+    "react": "18.3.1",
+    "react-native": "0.76.0",
+    "react-native-builder-bob": "^0.40.17",
     "typescript": "^5.2.2"
   },
   "resolutions": {
@@ -76,7 +77,7 @@
   },
   "peerDependencies": {
     "react": "*",
-    "react-native": "*"
+    "react-native": ">=0.76.0 <1.0.0"
   },
   "jest": {
     "preset": "react-native",
@@ -91,22 +92,12 @@
       "@react-native",
       "prettier"
     ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    }
+    "rules": {}
   },
   "eslintIgnore": [
     "node_modules/",
-    "lib/"
+    "lib/",
+    "babel.config.js"
   ],
   "prettier": {
     "quoteProps": "consistent",
@@ -128,5 +119,19 @@
         }
       ]
     ]
+  },
+  "codegenConfig": {
+    "name": "AppMetricaNativeSpec",
+    "type": "modules",
+    "jsSrcsDir": "src/specs",
+    "android": {
+      "javaPackageName": "io.appmetrica.analytics.reactnative"
+    },
+    "ios": {
+      "modulesProvider": {
+        "AppMetrica": "AMARNAppMetrica",
+        "AppMetricaReporter": "AMARNReporter"
+      }
+    }
   }
 }

package/src/deferredDeeplink.ts

@@ -1,4 +1,8 @@
-export type DeferredDeeplinkError = 'NO_REFERRER' | 'NOT_A_FIRST_LAUNCH' | 'PARSE_ERROR' | 'UNKNOWN';
+export type DeferredDeeplinkError =
+  | 'NO_REFERRER'
+  | 'NOT_A_FIRST_LAUNCH'
+  | 'PARSE_ERROR'
+  | 'UNKNOWN';
 
 export interface DeferredDeeplinkListener {
   onSuccess: (deeplink: string) => void;

package/src/ecommerce.ts

@@ -53,7 +53,7 @@ export type ECommerceOrder = {
 };
 
 export type ECommerceEventType =
-  | 'showSceenEvent'
+  | 'showScreenEvent'
   | 'showProductCardEvent'
   | 'showProductDetailsEvent'
   | 'addCartItemEvent'
@@ -73,7 +73,7 @@ export interface ECommerceEvent {
 export class ECommerce {
   static showScreenEvent(screen: ECommerceScreen): ECommerceEvent {
     return {
-      ecommerceEvent: 'showSceenEvent',
+      ecommerceEvent: 'showScreenEvent',
       ecommerceScreen: normalizeECommerceScreen(screen),
     };
   }

package/src/error.ts

@@ -47,7 +47,7 @@ function parseStackTrace(
       }
     });
     return array;
-  } catch(e) {
+  } catch (e) {
     console.log(e);
     return undefined;
   }

package/src/index.ts

@@ -1,32 +1,27 @@
-import { Linking, NativeModules, Platform } from 'react-native';
+import { Linking } from 'react-native';
+import AppMetricaNative from './specs/NativeAppMetrica';
 import type { ECommerceEvent } from './ecommerce';
 import type { AdRevenue, Revenue } from './revenue';
 import type { UserProfile } from './userProfile';
 import type { ExternalAttribution } from './externalAttribution';
 import { normalizeAdRevenue } from './utils';
 import { AppMetricaError } from './error';
-import { Reporter, type IReporter, type ReporterConfig } from './reporter';
+import { Reporter } from './reporter';
+import type { IReporter, ReporterConfig } from './reporter';
 import type {
   DeferredDeeplinkListener,
   DeferredDeeplinkParametersListener,
+  DeferredDeeplinkError,
 } from './deferredDeeplink';
 
-const LINKING_ERROR =
-  `The package '@appmetrica/react-native-analytics' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
-
-const AppMetricaNative = NativeModules.AppMetrica
-  ? NativeModules.AppMetrica
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
+import type {
+  AppMetricaConfig,
+  StartupParamsReason,
+  StartupParamsCallback,
+  Location,
+  StartupParamsItem,
+} from './types';
+import { StartupParams } from './types';
 
 var activated = false;
 
@@ -44,71 +39,15 @@ function appOpenTracking() {
   Linking.addEventListener('url', callback);
 }
 
-export type AppMetricaConfig = {
-  apiKey: string;
-  appVersion?: string;
-  crashReporting?: boolean;
-  firstActivationAsUpdate?: boolean;
-  location?: Location;
-  locationTracking?: boolean;
-  logs?: boolean;
-  sessionTimeout?: number;
-  statisticsSending?: boolean;
-  preloadInfo?: PreloadInfo;
-  maxReportsInDatabaseCount?: number;
-  nativeCrashReporting?: boolean; // Android only
-  activationAsSessionStart?: boolean; // iOS only
-  sessionsAutoTracking?: boolean; // iOS only
-  appOpenTrackingEnabled?: boolean;
-  userProfileID?: string;
-
-  errorEnvironment?: Record<string, string | undefined>;
-  appEnvironment?: Record<string, string | undefined>;
-  maxReportsCount?: number;
-  dispatchPeriodSeconds?: number;
-};
-
-export type PreloadInfo = {
-  trackingId: string;
-  additionalInfo?: Record<string, string>;
-};
-
-export type Location = {
-  latitude: number;
-  longitude: number;
-  altitude?: number;
-  accuracy?: number;
-  course?: number;
-  speed?: number;
-  timestamp?: number;
-};
-
-export type StartupParamsReason = 'UNKNOWN' | 'NETWORK' | 'INVALID_RESPONSE';
-
-export type StartupParams = {
-  deviceIdHash?: string;
-  deviceId?: string;
-  uuid?: string;
-};
-
-export type StartupParamsCallback = (
-  params?: StartupParams,
-  reason?: StartupParamsReason
-) => void;
-
-export const DEVICE_ID_HASH_KEY = 'appmetrica_device_id_hash';
-export const DEVICE_ID_KEY = 'appmetrica_device_id';
-export const UUID_KEY = 'appmetrica_uuid';
-
 export * from './ecommerce';
 export * from './revenue';
 export * from './userProfile';
 export * from './externalAttribution';
 export type { IReporter, ReporterConfig } from './reporter';
 export * from './deferredDeeplink';
+export * from './types';
 
 export default class AppMetrica {
-
   private static reporters: Map<string, Reporter> = new Map();
 
   static activate(config: AppMetricaConfig) {
@@ -122,11 +61,11 @@ export default class AppMetrica {
   }
 
   // Android only
-  static async getLibraryApiLevel(): Promise<number> {
+  static getLibraryApiLevel(): number {
     return AppMetricaNative.getLibraryApiLevel();
   }
 
-  static async getLibraryVersion(): Promise<string> {
+  static getLibraryVersion(): string {
     return AppMetricaNative.getLibraryVersion();
   }
 
@@ -146,7 +85,9 @@ export default class AppMetrica {
     AppMetricaNative.reportError(
       identifier,
       message,
-      _reason instanceof Error ? AppMetricaError.withError(_reason) : AppMetricaError.withObject(_reason)
+      _reason instanceof Error
+        ? AppMetricaError.withError(_reason)
+        : AppMetricaError.withObject(_reason)
     );
   }
 
@@ -154,8 +95,14 @@ export default class AppMetrica {
     AppMetricaNative.reportUnhandledException(AppMetricaError.withError(error));
   }
 
-  static reportErrorWithoutIdentifier(message: string | undefined, error: Error) {
-    AppMetricaNative.reportErrorWithoutIdentifier(message, AppMetricaError.withError(error));
+  static reportErrorWithoutIdentifier(
+    message: string | undefined,
+    error: Error
+  ) {
+    AppMetricaNative.reportErrorWithoutIdentifier(
+      message,
+      AppMetricaError.withError(error)
+    );
   }
 
   static reportEvent(eventName: string, attributes?: Record<string, any>) {
@@ -166,7 +113,13 @@ export default class AppMetrica {
     listener: StartupParamsCallback,
     identifiers: Array<string>
   ) {
-    AppMetricaNative.requestStartupParams(identifiers, listener);
+    const adapter = (params?: Object, reason?: Object) => {
+      const startupParams = params
+        ? new StartupParams(params as Record<string, StartupParamsItem>)
+        : undefined;
+      listener(startupParams, reason as StartupParamsReason);
+    };
+    AppMetricaNative.requestStartupParams(adapter, identifiers);
   }
 
   static resumeSession() {
@@ -240,17 +193,21 @@ export default class AppMetrica {
     AppMetricaNative.activateReporter(config);
   }
 
-  static getDeviceId(): Promise<string | null> {
+  static getDeviceId(): string | null {
     return AppMetricaNative.getDeviceId();
   }
 
-  static getUuid(): Promise<string | null> {
+  static getUuid(): string | null {
     return AppMetricaNative.getUuid();
   }
 
   static requestDeferredDeeplink(listener: DeferredDeeplinkListener) {
+    const adaptedOnFailure = (error: string, referrer?: string) => {
+      listener.onFailure(error as DeferredDeeplinkError, referrer);
+    };
+
     AppMetricaNative.requestDeferredDeeplink(
-      listener.onFailure,
+      adaptedOnFailure,
       listener.onSuccess
     );
   }
@@ -258,9 +215,15 @@ export default class AppMetrica {
   static requestDeferredDeeplinkParameters(
     listener: DeferredDeeplinkParametersListener
   ) {
+    const adaptedOnFailure = (error: string, referrer?: string) => {
+      listener.onFailure(error as DeferredDeeplinkError, referrer);
+    };
+    const adaptedOnSuccess = (parameters: Object) => {
+      listener.onSuccess(parameters as Record<string, string>);
+    };
     AppMetricaNative.requestDeferredDeeplinkParameters(
-      listener.onFailure,
-      listener.onSuccess
+      adaptedOnFailure,
+      adaptedOnSuccess
     );
   }
 }

package/src/reporter.ts

@@ -1,28 +1,15 @@
-import { NativeModules, Platform } from 'react-native';
 import type { UserProfile } from './userProfile';
 import type { AdRevenue, Revenue } from './revenue';
 import type { ECommerceEvent } from './ecommerce';
 import { AppMetricaError } from './error';
-
-const LINKING_ERROR =
-  `The package '@appmetrica/react-native-analytics' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
-
-const ReporterNativeModule = NativeModules.AppMetricaReporter
-  ? NativeModules.AppMetricaReporter
-  : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
+import ReporterNativeModule from './specs/NativeReporter';
 
 export interface IReporter {
-  reportError(identifier: string, message?: string, _reason?: Error | Object): void;
+  reportError(
+    identifier: string,
+    message?: string,
+    _reason?: Error | Object
+  ): void;
   reportErrorWithoutIdentifier(message: string | undefined, error: Error): void;
   reportUnhandledException(error: Error): void;
   reportEvent(eventName: string, attributes?: Record<string, any>): void;
@@ -40,7 +27,6 @@ export interface IReporter {
 }
 
 export class Reporter implements IReporter {
-
   private apiKey: string;
 
   constructor(apiKey: string) {
@@ -52,16 +38,25 @@ export class Reporter implements IReporter {
       this.apiKey,
       identifier,
       message,
-      _reason instanceof Error ? AppMetricaError.withError(_reason) : AppMetricaError.withObject(_reason)
+      _reason instanceof Error
+        ? AppMetricaError.withError(_reason)
+        : AppMetricaError.withObject(_reason)
     );
   }
 
   reportErrorWithoutIdentifier(message: string | undefined, error: Error) {
-    ReporterNativeModule.reportErrorWithoutIdentifier(this.apiKey, message, AppMetricaError.withError(error));
+    ReporterNativeModule.reportErrorWithoutIdentifier(
+      this.apiKey,
+      message,
+      AppMetricaError.withError(error)
+    );
   }
 
   reportUnhandledException(error: Error) {
-    ReporterNativeModule.reportUnhandledException(this.apiKey, AppMetricaError.withError(error));
+    ReporterNativeModule.reportUnhandledException(
+      this.apiKey,
+      AppMetricaError.withError(error)
+    );
   }
 
   reportEvent(eventName: string, attributes?: Record<string, any>) {
@@ -109,7 +104,7 @@ export class Reporter implements IReporter {
   }
 
   reportRevenue(revenue: Revenue) {
-    ReporterNativeModule.reportRevenue(this.apiKey, revenue)
+    ReporterNativeModule.reportRevenue(this.apiKey, revenue);
   }
 }
 
@@ -123,4 +118,4 @@ export type ReporterConfig = {
   dispatchPeriodSeconds?: number;
   userProfileID?: string;
   maxReportsCount?: number;
-}
+};

package/src/specs/NativeAppMetrica.ts

@@ -0,0 +1,55 @@
+import type { TurboModule } from 'react-native/Libraries/TurboModule/RCTExport';
+import { TurboModuleRegistry } from 'react-native';
+
+export interface Spec extends TurboModule {
+  activate(config: Object): void;
+  pauseSession(): void;
+  resumeSession(): void;
+  sendEventsBuffer(): void;
+  setDataSendingEnabled(enabled: boolean): void;
+  setLocationTracking(enabled: boolean): void;
+  setLocation(location?: Object): void;
+  setUserProfileID(userProfileID?: string): void;
+  reportAppOpen(deeplink?: string): void;
+  reportEvent(eventName: string, attributes?: Object): void;
+  reportECommerce(event: Object): void;
+  reportRevenue(revenue: Object): void;
+  reportAdRevenue(adRevenue: Object): void;
+  reportUserProfile(userProfile: Object): void;
+  reportExternalAttribution(attribution: Object): void;
+  reportError(identifier: string, message?: string, error?: Object): void;
+  reportErrorWithoutIdentifier(
+    message: string | undefined,
+    error: Object
+  ): void;
+  reportUnhandledException(error: Object): void;
+  putAppEnvironmentValue(key: string, value?: string): void;
+  putErrorEnvironmentValue(key: string, value?: string): void;
+  clearAppEnvironment(): void;
+  activateReporter(config: Object): void;
+  touchReporter(apiKey: string): void;
+  requestStartupParams(
+    listener: (params?: Object, reason?: Object) => void,
+    identifiers: Array<string>
+  ): void;
+  requestDeferredDeeplink(
+    onFailure: (error: string, referrer?: string) => void,
+    onSuccess: (deeplink: string) => void
+  ): void;
+  requestDeferredDeeplinkParameters(
+    onFailure: (error: string, referrer?: string) => void,
+    onSuccess: (parameters: Object) => void
+  ): void;
+  getDeviceId(): string | null;
+  getUuid(): string | null;
+  getLibraryVersion(): string;
+  getLibraryApiLevel(): number;
+
+  readonly getConstants: () => {
+    DEVICE_ID_HASH_KEY: string;
+    DEVICE_ID_KEY: string;
+    UUID_KEY: string;
+  };
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('AppMetrica');

package/src/specs/NativeReporter.ts

@@ -0,0 +1,31 @@
+import type { TurboModule } from 'react-native/Libraries/TurboModule/RCTExport';
+import { TurboModuleRegistry } from 'react-native';
+
+export interface Spec extends TurboModule {
+  pauseSession(apiKey: string): void;
+  resumeSession(apiKey: string): void;
+  sendEventsBuffer(apiKey: string): void;
+  setDataSendingEnabled(apiKey: string, enabled: boolean): void;
+  setUserProfileID(apiKey: string, userProfileID?: string): void;
+  reportEvent(apiKey: string, eventName: string, attributes?: Object): void;
+  reportECommerce(apiKey: string, event: Object): void;
+  reportRevenue(apiKey: string, revenue: Object): void;
+  reportAdRevenue(apiKey: string, adRevenue: Object): void;
+  reportUserProfile(apiKey: string, userProfile: Object): void;
+  reportError(
+    apiKey: string,
+    identifier: string,
+    message?: string,
+    error?: Object
+  ): void;
+  reportErrorWithoutIdentifier(
+    apiKey: string,
+    message: string | undefined,
+    error: Object
+  ): void;
+  reportUnhandledException(apiKey: string, error: Object): void;
+  putAppEnvironmentValue(apiKey: string, key: string, value?: string): void;
+  clearAppEnvironment(apiKey: string): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('AppMetricaReporter');

package/src/types.ts

@@ -0,0 +1,105 @@
+import AppMetricaNative from './specs/NativeAppMetrica';
+
+export type AppMetricaConfig = {
+  apiKey: string;
+  appVersion?: string;
+  crashReporting?: boolean;
+  firstActivationAsUpdate?: boolean;
+  location?: Location;
+  locationTracking?: boolean;
+  logs?: boolean;
+  sessionTimeout?: number;
+  statisticsSending?: boolean;
+  preloadInfo?: PreloadInfo;
+  maxReportsInDatabaseCount?: number;
+  nativeCrashReporting?: boolean;
+  activationAsSessionStart?: boolean;
+  sessionsAutoTracking?: boolean;
+  appOpenTrackingEnabled?: boolean;
+  userProfileID?: string;
+  errorEnvironment?: Record<string, string | undefined>;
+  appEnvironment?: Record<string, string | undefined>;
+  maxReportsCount?: number;
+  dispatchPeriodSeconds?: number;
+  appBuildNumber?: number;
+  revenueAutoTrackingEnabled?: boolean;
+  deviceType?: string;
+  advIdentifiersTracking?: boolean;
+};
+
+export type PreloadInfo = {
+  trackingId: string;
+  additionalInfo?: Record<string, string>;
+};
+
+export type Location = {
+  latitude: number;
+  longitude: number;
+  altitude?: number;
+  accuracy?: number;
+  course?: number;
+  speed?: number;
+  timestamp?: number;
+};
+
+export type StartupParamsReason = 'UNKNOWN' | 'NETWORK' | 'INVALID_RESPONSE';
+
+export class StartupParams {
+  private static constants = AppMetricaNative.getConstants();
+  static readonly DEVICE_ID_HASH_KEY = this.constants.DEVICE_ID_HASH_KEY;
+  static readonly DEVICE_ID_KEY = this.constants.DEVICE_ID_KEY;
+  static readonly UUID_KEY = this.constants.UUID_KEY;
+
+  readonly deviceIdHash?: string;
+  readonly deviceId?: string;
+  readonly uuid?: string;
+
+  constructor(readonly params?: Record<string, StartupParamsItem>) {
+    if (params) {
+      this.deviceIdHash = this.parameterForKey(
+        StartupParams.DEVICE_ID_HASH_KEY
+      );
+      this.deviceId = this.parameterForKey(StartupParams.DEVICE_ID_KEY);
+      this.uuid = this.parameterForKey(StartupParams.UUID_KEY);
+    }
+  }
+
+  parameterForKey(key: string): string | undefined {
+    return this.params?.[key]?.id;
+  }
+}
+
+export type StartupParamsCallback = (
+  params?: StartupParams,
+  reason?: StartupParamsReason
+) => void;
+
+export type ReporterConfig = {
+  apiKey: string;
+  sessionTimeout?: number;
+  statisticsSending?: boolean;
+  maxReportsCount?: number;
+  dispatchPeriodSeconds?: number;
+  logs?: boolean;
+};
+
+export type StartupParamsItem = {
+  id?: string;
+  errorDetails?: string;
+  status: StartupParamsItemStatus;
+};
+
+export type StartupParamsItemStatus =
+  | 'OK'
+  | 'FEATURE_DISABLED'
+  | 'INVALID_VALUE_FROM_PROVIDER'
+  | 'NETWORK_ERROR'
+  | 'PROVIDER_UNAVAILABLE'
+  | 'UNKNOWN_ERROR';
+
+export enum PredefinedDeviceTypes {
+  PHONE = 'phone',
+  TABLET = 'tablet',
+  TV = 'tv',
+  CAR = 'car',
+}

package/src/utils.ts

@@ -18,7 +18,7 @@ export function normalizeECommerceOrder(order: ECommerceOrder): ECommerceOrder {
   if (order.payload instanceof Map) {
     newOrder.payload = convertMap(order.payload);
   }
-  newOrder.products = order.products.map(normalizeECommerceCartItem)
+  newOrder.products = order.products.map(normalizeECommerceCartItem);
   return newOrder;
 }
 
@@ -48,13 +48,15 @@ export function normalizeECommerceReferrer(
     return undefined;
   }
   const newReferrer = { ...referrer } as ECommerceReferrer;
-  if (referrer.screen != undefined) {
+  if (referrer.screen !== undefined) {
     newReferrer.screen = normalizeECommerceScreen(referrer.screen);
   }
   return newReferrer;
 }
 
-export function normalizeECommerceScreen(screen: ECommerceScreen): ECommerceScreen {
+export function normalizeECommerceScreen(
+  screen: ECommerceScreen
+): ECommerceScreen {
   const newScreen = { ...screen } as ECommerceScreen;
   if (screen.payload instanceof Map) {
     newScreen.payload = convertMap(screen.payload);