react-native-nitro-amplitude 0.1.0

package/package.json

@@ -0,0 +1,130 @@
+{
+  "name": "react-native-nitro-amplitude",
+  "version": "0.1.0",
+  "description": "High-performance Amplitude Analytics and Experiment SDK for React Native powered by Nitro Modules and C++: synchronous JSI storage, native device context, and background HTTP transport.",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index.ts",
+  "browser": "src/index.web.ts",
+  "source": "src/index.ts",
+  "app": "app.plugin.js",
+  "exports": {
+    ".": {
+      "types": "./lib/typescript/index.d.ts",
+      "react-native": "./src/index.ts",
+      "browser": "./src/index.web.ts",
+      "default": "./lib/commonjs/index.js"
+    },
+    "./analytics": {
+      "types": "./lib/typescript/analytics/index.d.ts",
+      "react-native": "./src/analytics/index.ts",
+      "default": "./lib/commonjs/analytics/index.js"
+    },
+    "./experiment": {
+      "types": "./lib/typescript/experiment/index.d.ts",
+      "react-native": "./src/experiment/index.ts",
+      "default": "./lib/commonjs/experiment/index.js"
+    },
+    "./app.plugin": "./app.plugin.js",
+    "./app.plugin.js": "./app.plugin.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "cpp",
+    "android",
+    "ios",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "app.plugin.js",
+    ".watchmanconfig",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!cpp/**/*Test.cpp",
+    "!cpp/build",
+    "!android/build",
+    "!android/.cxx",
+    "!scripts"
+  ],
+  "scripts": {
+    "build": "bob build",
+    "clean": "rimraf lib nitrogen/generated",
+    "codegen": "nitrogen --logLevel=\"debug\"",
+    "lint": "bunx eslint src --max-warnings=0",
+    "lint:fix": "bunx eslint src --max-warnings=0 --fix",
+    "lint:check": "bunx eslint src --max-warnings=0",
+    "format": "bunx prettier --write \"src/**/*.{ts,tsx}\" \"../../README.md\" \"../../CHANGELOG.md\"",
+    "format:check": "bunx prettier --check \"src/**/*.{ts,tsx}\" \"../../README.md\" \"../../CHANGELOG.md\"",
+    "typecheck": "tsc --noEmit",
+    "test:types": "tsc --noEmit -p tsconfig.types.json",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "benchmark": "node scripts/benchmark-check.js",
+    "test:cpp": "node scripts/test-cpp.js",
+    "check:pack": "node scripts/check-pack-contents.js",
+    "prepack": "node scripts/sync-package-docs.js prepare",
+    "postpack": "node scripts/sync-package-docs.js cleanup",
+    "prepublishOnly": "bun run clean && bun run codegen && bun run build && bun run test:types"
+  },
+  "keywords": [
+    "react-native",
+    "amplitude",
+    "analytics",
+    "experiment",
+    "feature-flags",
+    "a-b-testing",
+    "nitro",
+    "nitro-modules",
+    "jsi",
+    "expo",
+    "performance"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JoaoPauloCMarra/react-native-nitro-amplitude.git"
+  },
+  "author": "JoaoPauloCMarra",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/JoaoPauloCMarra/react-native-nitro-amplitude/issues"
+  },
+  "homepage": "https://github.com/JoaoPauloCMarra/react-native-nitro-amplitude#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@amplitude/analytics-connector": "^1.6.4",
+    "@amplitude/analytics-core": "2.48.2",
+    "@amplitude/experiment-core": "^0.13.1",
+    "@amplitude/ua-parser-js": "^0.7.33",
+    "tslib": "^2.8.1",
+    "unfetch": "^4.2.0"
+  },
+  "devDependencies": {
+    "@react-native/babel-preset": "^0.85.3",
+    "@types/react": "~19.2.0"
+  },
+  "peerDependencies": {
+    "react": ">=18.2.0",
+    "react-native": ">=0.75.0",
+    "react-native-nitro-modules": ">=0.35.7"
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "tsc": "../../node_modules/.bin/tsc"
+        }
+      ]
+    ]
+  }
+}

package/react-native-nitro-amplitude.podspec

@@ -0,0 +1,36 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "react-native-nitro-amplitude"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "13.0" }
+  s.source       = { :git => "https://github.com/JoaoPauloCMarra/react-native-nitro-amplitude.git", :tag => "#{s.version}" }
+
+  s.source_files = [
+    "ios/**/*.{h,m,mm,swift}",
+    "cpp/**/*.{h,hpp,c,cpp}"
+  ]
+
+  s.pod_target_xcconfig = {
+    "CLANG_CXX_LANGUAGE_STANDARD" => "c++20",
+    "CLANG_CXX_LIBRARY" => "libc++",
+    "HEADER_SEARCH_PATHS" => [
+      "\"$(PODS_TARGET_SRCROOT)/cpp/core\"",
+      "\"$(PODS_TARGET_SRCROOT)/cpp/bindings\"",
+      "\"$(PODS_TARGET_SRCROOT)/nitrogen/generated/shared/c++\"",
+      "\"$(PODS_TARGET_SRCROOT)/nitrogen/generated/ios\""
+    ].join(" ")
+  }
+
+  s.dependency "React-Core"
+  
+  load 'nitrogen/generated/ios/NitroAmplitude+autolinking.rb'
+  add_nitrogen_files(s)
+end

package/src/AmplitudeContext.nitro.ts

@@ -0,0 +1,21 @@
+import { type HybridObject } from "react-native-nitro-modules";
+
+export interface AmplitudeContext extends HybridObject<{
+  ios: "c++";
+  android: "c++";
+}> {
+  /** Warm native device context caches off the UI-critical path. */
+  prefetch(): void;
+  /** Returns JSON-encoded application context for analytics/experiment targeting. */
+  getApplicationContextJson(optionsJson: string): string;
+  /** Returns JSON-encoded legacy SDK session data for migration. */
+  getLegacySessionDataJson(instanceName: string): string;
+  /** Returns JSON-encoded legacy queued events for migration. */
+  getLegacyEventsJson(instanceName: string, eventKind: string): string[];
+  /** Removes a migrated legacy event after successful upload. */
+  removeLegacyEvent(
+    instanceName: string,
+    eventKind: string,
+    eventId: number,
+  ): void;
+}

package/src/AmplitudeStorage.nitro.ts

@@ -0,0 +1,17 @@
+import { type HybridObject } from "react-native-nitro-modules";
+
+export interface AmplitudeStorage extends HybridObject<{
+  ios: "c++";
+  android: "c++";
+}> {
+  set(key: string, value: string, persist: boolean): void;
+  get(key: string, persist: boolean): string | undefined;
+  remove(key: string, persist: boolean): void;
+  clear(persist: boolean): void;
+  has(key: string, persist: boolean): boolean;
+  getAllKeys(persist: boolean): string[];
+  getKeysByPrefix(prefix: string, persist: boolean): string[];
+  setBatch(keys: string[], values: string[], persist: boolean): void;
+  getBatch(keys: string[], persist: boolean): (string | undefined)[];
+  removeBatch(keys: string[], persist: boolean): void;
+}

package/src/AmplitudeWorker.nitro.ts

@@ -0,0 +1,25 @@
+import { type HybridObject } from "react-native-nitro-modules";
+
+export interface AmplitudeWorker extends HybridObject<{
+  ios: "c++";
+  android: "c++";
+}> {
+  enqueue(
+    requestId: string,
+    url: string,
+    method: string,
+    headersJson: string,
+    body: string,
+    timeoutMillis: number,
+  ): void;
+  cancel(requestId: string): void;
+  addOnComplete(
+    callback: (
+      requestId: string,
+      statusCode: number,
+      body: string,
+      error: string,
+    ) => void,
+  ): () => void;
+  queueSize(): number;
+}

package/src/analytics/campaign/campaign-tracker.ts

@@ -0,0 +1,162 @@
+import {
+  createIdentifyEvent,
+  Identify,
+  Storage,
+  Campaign,
+  CampaignParser as ICampaignParser,
+  BaseEvent,
+  getCookieName as getStorageKey,
+  BASE_CAMPAIGN,
+  EMPTY_VALUE,
+  MKTG,
+  CampaignParser,
+} from "@amplitude/analytics-core";
+import {
+  CampaignTracker as ICampaignTracker,
+  CampaignTrackFunction,
+  CampaignTrackerOptions,
+} from "./types";
+
+/**
+ * @deprecated
+ * Campaign tracker has mixed logic from built-in and plugin web attribution
+ * features. Do not add more features here. The plan moving foward is to consolidate logic
+ * in @amplitude/plugin-web-attribution-browser with backward compatibility.
+ */
+export class CampaignTracker implements ICampaignTracker {
+  storage: Storage<Campaign>;
+  storageKey: string;
+  parser: ICampaignParser;
+  track: CampaignTrackFunction;
+  onNewCampaign: (campaign: Campaign) => unknown;
+
+  disabled: boolean;
+  trackNewCampaigns: boolean;
+  trackPageViews: boolean;
+  excludeReferrers: string[];
+  initialEmptyValue: string;
+
+  constructor(apiKey: string, options: CampaignTrackerOptions) {
+    this.storage = options.storage;
+    this.storageKey = getStorageKey(apiKey, MKTG);
+    this.parser = new CampaignParser();
+    this.track = options.track;
+    this.onNewCampaign = options.onNewCampaign;
+
+    this.disabled = Boolean(options.disabled);
+    this.trackNewCampaigns = Boolean(options.trackNewCampaigns);
+    this.trackPageViews = Boolean(options.trackPageViews);
+    this.excludeReferrers = options.excludeReferrers ?? [];
+    if (typeof location !== "undefined") {
+      this.excludeReferrers.unshift(location.hostname);
+    }
+    this.initialEmptyValue = options.initialEmptyValue ?? EMPTY_VALUE;
+  }
+
+  isNewCampaign(
+    current: Campaign,
+    previous: Campaign | undefined,
+    ignoreSubdomainInReferrer = false,
+  ) {
+    const { referrer, referring_domain, ...currentCampaign } = current;
+    const {
+      referrer: _previous_referrer,
+      referring_domain: prevReferringDomain,
+      ...previousCampaign
+    } = previous || {};
+
+    if (
+      current.referring_domain &&
+      this.excludeReferrers.includes(current.referring_domain)
+    ) {
+      return false;
+    }
+
+    const hasNewCampaign =
+      JSON.stringify(currentCampaign) !== JSON.stringify(previousCampaign);
+    const hasNewDomain = ignoreSubdomainInReferrer
+      ? domainWithoutSubdomain(referring_domain || "") !==
+        domainWithoutSubdomain(prevReferringDomain || "")
+      : referring_domain !== prevReferringDomain;
+
+    return !previous || hasNewCampaign || hasNewDomain;
+  }
+
+  async saveCampaignToStorage(campaign: Campaign): Promise<void> {
+    await this.storage.set(this.storageKey, campaign);
+  }
+
+  async getCampaignFromStorage(): Promise<Campaign | undefined> {
+    return await this.storage.get(this.storageKey);
+  }
+
+  createCampaignEvent(campaign: Campaign) {
+    const campaignParameters: Campaign = {
+      // This object definition allows undefined keys to be iterated on
+      // in .reduce() to build indentify object
+      ...BASE_CAMPAIGN,
+      ...campaign,
+    };
+    const identifyEvent = Object.entries(campaignParameters).reduce(
+      (identify, [key, value]) => {
+        identify.setOnce(`initial_${key}`, value || this.initialEmptyValue);
+        if (value) {
+          return identify.set(key, value);
+        }
+        return identify.unset(key);
+      },
+      new Identify(),
+    );
+
+    const pageViewEvent: BaseEvent = {
+      event_type: "Page View",
+      event_properties: {
+        page_title:
+          /* istanbul ignore next */ (typeof document !== "undefined" &&
+            document.title) ||
+          "",
+        page_location:
+          /* istanbul ignore next */ (typeof location !== "undefined" &&
+            location.href) ||
+          "",
+        page_path:
+          /* istanbul ignore next */ (typeof location !== "undefined" &&
+            location.pathname) ||
+          "",
+      },
+    };
+    return {
+      ...createIdentifyEvent(identifyEvent),
+      ...(this.trackPageViews && pageViewEvent),
+    };
+  }
+
+  async send(isNewSession: boolean) {
+    if (this.disabled) {
+      return;
+    }
+    const currentCampaign = await this.parser.parse();
+    const previousCampaign = await this.getCampaignFromStorage();
+    if (!isNewSession) {
+      if (
+        !this.trackNewCampaigns ||
+        !this.isNewCampaign(currentCampaign, previousCampaign)
+      ) {
+        return;
+      }
+      this.onNewCampaign(currentCampaign);
+    }
+    await this.track(this.createCampaignEvent(currentCampaign));
+    await this.saveCampaignToStorage(currentCampaign);
+  }
+}
+
+const domainWithoutSubdomain = (domain: string) => {
+  const parts = domain.split(".");
+
+  if (parts.length <= 2) {
+    return domain;
+  }
+
+  return parts.slice(parts.length - 2, parts.length).join(".");
+};

package/src/analytics/campaign/types.ts

@@ -0,0 +1,18 @@
+import {
+  Campaign,
+  ReactNativeAttributionOptions,
+  Storage,
+  BaseEvent,
+} from "@amplitude/analytics-core";
+
+export interface CampaignTrackerOptions extends ReactNativeAttributionOptions {
+  storage: Storage<Campaign>;
+  track: CampaignTrackFunction;
+  onNewCampaign: (campaign: Campaign) => unknown;
+}
+
+export interface CampaignTracker extends CampaignTrackerOptions {
+  send(force: boolean): Promise<void>;
+}
+
+export type CampaignTrackFunction = (event: BaseEvent) => Promise<unknown>;