@appmetrica/react-native-analytics 3.0.0 → 3.1.0

package/src/index.ts

@@ -1,6 +1,8 @@
 import { Linking, NativeModules, Platform } from 'react-native';
 import type { ECommerceEvent } from './ecommerce';
 import type { AdRevenue, Revenue } from './revenue';
+import type { UserProfile } from './userProfile';
+import { normalizeAdRevenue } from './utils';
 
 const LINKING_ERROR =
   `The package '@appmetrica/react-native-analytics' doesn't seem to be linked. Make sure: \n\n` +
@@ -51,6 +53,7 @@ export type AppMetricaConfig = {
   activationAsSessionStart?: boolean; // iOS only
   sessionsAutoTracking?: boolean; // iOS only
   appOpenTrackingEnabled?: boolean;
+  userProfileID?: string;
 };
 
 export type PreloadInfo = {
@@ -87,6 +90,7 @@ export const UUID_KEY = 'appmetrica_uuid';
 
 export * from './ecommerce';
 export * from './revenue';
+export * from './userProfile';
 
 export default class AppMetrica {
   static activate(config: AppMetricaConfig) {
@@ -116,7 +120,7 @@ export default class AppMetrica {
     AppMetricaNative.reportAppOpen(deeplink);
   }
 
-  static reportError(identifier: string, message: string, _reason: Object) {
+  static reportError(identifier: string, message: string, _reason?: Object) {
     AppMetricaNative.reportError(identifier, message);
   }
 
@@ -164,6 +168,10 @@ export default class AppMetrica {
   }
 
   static reportAdRevenue(adRevenue: AdRevenue) {
-    AppMetricaNative.reportAdRevenue(adRevenue);
+    AppMetricaNative.reportAdRevenue(normalizeAdRevenue(adRevenue));
+  }
+
+  static reportUserProfile(userProfile: UserProfile) {
+    AppMetricaNative.reportUserProfile(userProfile)
   }
 }

package/src/revenue.ts

@@ -16,7 +16,7 @@ export type Receipt = {
 export type AdRevenue = {
   price: number | string;
   currency: string;
-  payload?: Map<string, string>;
+  payload?: Map<string, string> | Record<string, string>;
   adNetwork?: string;
   adPlacementID?: string;
   adPlacementName?: string;

package/src/userProfile.ts

@@ -0,0 +1,362 @@
+export class UserProfile {
+  private attributes: Array<UserProfileUpdate>;
+
+  constructor() {
+    this.attributes = [];
+  }
+
+  apply(attribute: UserProfileUpdate): UserProfile {
+    this.attributes.push(attribute);
+
+    return this;
+  }
+}
+
+type UserProfileUpdateType =
+  | 'BirthDateWithAge'
+  | 'BirthDateWithYear'
+  | 'BirthDateWithMonth'
+  | 'BirthDateWithDay'
+  | 'BirthDateValueReset'
+  | 'BooleanValue'
+  | 'BooleanValueReset'
+  | 'Counter'
+  | 'GenderValue'
+  | 'GenderValueReset'
+  | 'NameValue'
+  | 'NameValueReset'
+  | 'NotificationsEnabledValue'
+  | 'NotificationsEnabledValueReset'
+  | 'NumberValue'
+  | 'NumberValueReset'
+  | 'StringValue'
+  | 'StringValueReset';
+
+export interface UserProfileUpdate {
+  type: UserProfileUpdateType;
+  key?: string;
+  value?: any;
+  ifUndefined?: boolean;
+  age?: number;
+  year?: number;
+  month?: number;
+  day?: number;
+  delta?: number;
+}
+
+export type UserProfileGender = 'male' | 'female' | 'other';
+
+export class Attributes {
+  static birthDate() {
+    return new BirthDateAttribute();
+  }
+
+  static customBoolean(key: string) {
+    return new BooleanAttribute(key);
+  }
+
+  static customCounter(key: string) {
+    return new CounterAttribute(key);
+  }
+
+  static customNumber(key: string) {
+    return new NumberAttribute(key);
+  }
+
+  static customString(key: string) {
+    return new StringAttribute(key);
+  }
+
+  static gender() {
+    return new GenderAttribute();
+  }
+
+  static userName() {
+    return new NameAttribute();
+  }
+
+  static notificationsEnabled() {
+    return new NotificationsEnabledAttribute();
+  }
+}
+
+export class BirthDateAttribute {
+  withAge(age: number): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithAge',
+      age: age,
+      ifUndefined: false,
+    };
+  }
+
+  withAgeIfUndefined(age: number): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithAge',
+      age: age,
+      ifUndefined: true,
+    };
+  }
+
+  withYear(year: number): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithYear',
+      year: year,
+      ifUndefined: false,
+    };
+  }
+
+  withYearIfUndefined(year: number): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithYear',
+      year: year,
+      ifUndefined: true,
+    };
+  }
+
+  withMonth(year: number, month: number): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithMonth',
+      year: year,
+      month: month,
+      ifUndefined: false,
+    };
+  }
+
+  withMonthIfUndefined(year: number, month: number): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithMonth',
+      year: year,
+      month: month,
+      ifUndefined: true,
+    };
+  }
+
+  withDay(year: number, month: number, day: number): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithDay',
+      year: year,
+      month: month,
+      day: day,
+      ifUndefined: false,
+    };
+  }
+
+  withDayIfUndefined(
+    year: number,
+    month: number,
+    day: number
+  ): UserProfileUpdate {
+    return {
+      type: 'BirthDateWithDay',
+      year: year,
+      month: month,
+      day: day,
+      ifUndefined: true,
+    };
+  }
+
+  withDate(date: Date): UserProfileUpdate {
+    return this.withDay(date.getFullYear(), date.getMonth(), date.getDate());
+  }
+
+  withDateIfUndefined(date: Date): UserProfileUpdate {
+    return this.withDayIfUndefined(
+      date.getFullYear(),
+      date.getMonth(),
+      date.getDate()
+    );
+  }
+
+  withValueReset(): UserProfileUpdate {
+    return {
+      type: 'BirthDateValueReset',
+    };
+  }
+}
+
+export class BooleanAttribute {
+  private readonly key: string;
+
+  constructor(key: string) {
+    this.key = key;
+  }
+
+  withValue(value: boolean): UserProfileUpdate {
+    return {
+      type: 'BooleanValue',
+      key: this.key,
+      value: value,
+      ifUndefined: false,
+    };
+  }
+
+  withValueIfUndefined(value: boolean): UserProfileUpdate {
+    return {
+      type: 'BooleanValue',
+      key: this.key,
+      value: value,
+      ifUndefined: true,
+    };
+  }
+
+  withValueReset(): UserProfileUpdate {
+    return {
+      type: 'BooleanValueReset',
+      key: this.key,
+    };
+  }
+}
+
+export class CounterAttribute {
+  private readonly key: string;
+
+  constructor(key: string) {
+    this.key = key;
+  }
+
+  withDelta(delta: number): UserProfileUpdate {
+    return {
+      type: 'Counter',
+      key: this.key,
+      delta: delta,
+    };
+  }
+}
+
+export class GenderAttribute {
+  withValue(gender: UserProfileGender): UserProfileUpdate {
+    return {
+      type: 'GenderValue',
+      value: gender,
+      ifUndefined: false,
+    };
+  }
+
+  withValueIfUndefined(gender: UserProfileGender): UserProfileUpdate {
+    return {
+      type: 'GenderValue',
+      value: gender,
+      ifUndefined: true,
+    };
+  }
+
+  withValueReset(): UserProfileUpdate {
+    return {
+      type: 'GenderValueReset',
+    };
+  }
+}
+
+export class NameAttribute {
+  withValue(value: string): UserProfileUpdate {
+    return {
+      type: 'NameValue',
+      value: value,
+      ifUndefined: false,
+    };
+  }
+
+  withValueIfUndefined(value: string): UserProfileUpdate {
+    return {
+      type: 'NameValue',
+      value: value,
+      ifUndefined: true,
+    };
+  }
+
+  withValueReset(): UserProfileUpdate {
+    return {
+      type: 'NameValueReset',
+    };
+  }
+}
+
+export class NotificationsEnabledAttribute {
+  withValue(value: boolean): UserProfileUpdate {
+    return {
+      type: 'NotificationsEnabledValue',
+      value: value,
+      ifUndefined: false,
+    };
+  }
+
+  withValueIfUndefined(value: boolean): UserProfileUpdate {
+    return {
+      type: 'NotificationsEnabledValue',
+      value: value,
+      ifUndefined: true,
+    };
+  }
+
+  withValueReset(): UserProfileUpdate {
+    return {
+      type: 'NotificationsEnabledValueReset',
+    };
+  }
+}
+
+export class NumberAttribute {
+  private readonly key: string;
+
+  constructor(key: string) {
+    this.key = key;
+  }
+
+  withValue(value: number): UserProfileUpdate {
+    return {
+      type: 'NumberValue',
+      key: this.key,
+      value: value,
+      ifUndefined: false,
+    };
+  }
+
+  withValueIfUndefined(value: number): UserProfileUpdate {
+    return {
+      type: 'NumberValue',
+      key: this.key,
+      value: value,
+      ifUndefined: true,
+    };
+  }
+
+  withValueReset(): UserProfileUpdate {
+    return {
+      type: 'NumberValueReset',
+      key: this.key,
+    };
+  }
+}
+
+export class StringAttribute {
+  private readonly key: string;
+
+  constructor(key: string) {
+    this.key = key;
+  }
+
+  withValue(value: string): UserProfileUpdate {
+    return {
+      type: 'StringValue',
+      key: this.key,
+      value: value,
+      ifUndefined: false,
+    };
+  }
+
+  withValueIfUndefined(value: string): UserProfileUpdate {
+    return {
+      type: 'StringValue',
+      key: this.key,
+      value: value,
+      ifUndefined: true,
+    };
+  }
+
+  withValueReset(): UserProfileUpdate {
+    return {
+      type: 'StringValueReset',
+      key: this.key,
+    };
+  }
+}

package/src/utils.ts

@@ -0,0 +1,71 @@
+import type {
+  ECommerceCartItem,
+  ECommerceOrder,
+  ECommerceProduct,
+  ECommerceReferrer,
+  ECommerceScreen,
+} from './ecommerce';
+import type { AdRevenue } from './revenue';
+
+function convertMap(
+  map?: Map<string, string>
+): Record<string, string> | undefined {
+  return map !== undefined ? Object.fromEntries(map) : undefined;
+}
+
+export function normalizeECommerceOrder(order: ECommerceOrder): ECommerceOrder {
+  const newOrder = { ...order } as ECommerceOrder;
+  if (order.payload instanceof Map) {
+    newOrder.payload = convertMap(order.payload);
+  }
+  newOrder.products = order.products.map(normalizeECommerceCartItem)
+  return newOrder;
+}
+
+export function normalizeECommerceCartItem(
+  item: ECommerceCartItem
+): ECommerceCartItem {
+  const newItem = { ...item } as ECommerceCartItem;
+  newItem.product = normalizeECommerceProduct(item.product);
+  newItem.referrer = normalizeECommerceReferrer(item.referrer);
+  return newItem;
+}
+
+export function normalizeECommerceProduct(
+  product: ECommerceProduct
+): ECommerceProduct {
+  const newProduct = { ...product } as ECommerceProduct;
+  if (product.payload instanceof Map) {
+    newProduct.payload = convertMap(product.payload);
+  }
+  return newProduct;
+}
+
+export function normalizeECommerceReferrer(
+  referrer?: ECommerceReferrer
+): ECommerceReferrer | undefined {
+  if (referrer === undefined) {
+    return undefined;
+  }
+  const newReferrer = { ...referrer } as ECommerceReferrer;
+  if (referrer.screen != undefined) {
+    newReferrer.screen = normalizeECommerceScreen(referrer.screen);
+  }
+  return newReferrer;
+}
+
+export function normalizeECommerceScreen(screen: ECommerceScreen): ECommerceScreen {
+  const newScreen = { ...screen } as ECommerceScreen;
+  if (screen.payload instanceof Map) {
+    newScreen.payload = convertMap(screen.payload);
+  }
+  return newScreen;
+}
+
+export function normalizeAdRevenue(adRevenue: AdRevenue): AdRevenue {
+  const newAdRevenue = { ...adRevenue } as AdRevenue;
+  if (adRevenue.payload instanceof Map) {
+    newAdRevenue.payload = convertMap(adRevenue.payload);
+  }
+  return newAdRevenue;
+}