appsprint-react-native 0.2.0 → 1.0.4

package/lib/typescript/types.d.ts

@@ -1,29 +1,70 @@
 export interface AppSprintConfig {
     apiKey: string;
     apiUrl?: string;
+    endpointBaseUrl?: string;
     enableAppleAdsAttribution?: boolean;
     isDebug?: boolean;
     logLevel?: 0 | 1 | 2 | 3;
     customerUserId?: string | null;
+    autoTrackSessions?: boolean;
+    autoRefreshAttribution?: boolean;
+    googleAdsConsent?: GoogleAdsConsent | null;
 }
+export type AppSprintOptions = Omit<AppSprintConfig, "apiKey">;
 export type LogLevel = 0 | 1 | 2 | 3;
-export type EventType = "login" | "sign_up" | "register" | "purchase" | "subscribe" | "start_trial" | "add_to_cart" | "add_to_wishlist" | "initiate_checkout" | "view_content" | "view_item" | "search" | "share" | "tutorial_complete" | "level_start" | "level_complete" | "custom";
+export type EventType = "session_start" | "SESSION_START" | "login" | "LOGIN" | "sign_up" | "SIGN_UP" | "register" | "REGISTER" | "purchase" | "PURCHASE" | "subscribe" | "SUBSCRIBE" | "start_trial" | "START_TRIAL" | "add_payment_info" | "ADD_PAYMENT_INFO" | "add_to_cart" | "ADD_TO_CART" | "add_to_wishlist" | "ADD_TO_WISHLIST" | "initiate_checkout" | "INITIATE_CHECKOUT" | "view_content" | "VIEW_CONTENT" | "view_item" | "VIEW_ITEM" | "search" | "SEARCH" | "share" | "SHARE" | "tutorial_complete" | "TUTORIAL_COMPLETE" | "achieve_level" | "ACHIEVE_LEVEL" | "level_start" | "LEVEL_START" | "level_complete" | "LEVEL_COMPLETE" | "custom" | "CUSTOM";
+export type GoogleAdsConsentStatus = "GRANTED" | "DENIED" | "UNSPECIFIED" | "granted" | "denied" | "unspecified";
+export interface GoogleAdsConsent {
+    adUserData: GoogleAdsConsentStatus;
+}
 export interface EventParams {
     revenue?: number;
+    price?: number | string;
     currency?: string;
+    googleAdsConsent?: GoogleAdsConsent | null;
+    googleAdsAdUserDataConsent?: GoogleAdsConsentStatus;
+    email?: string;
+    name?: string;
+    phone_number?: string;
+    date_of_birth?: string;
     [key: string]: unknown;
 }
+export type AttributionParams = Record<string, string>;
+export interface AttributionLink {
+    id: string;
+    name: string;
+}
+export interface AppleAdsAttribution {
+    campaignId: string;
+    orgId?: string | null;
+    adGroupId?: string | null;
+    keywordId?: string | null;
+    adId?: string | null;
+    countryOrRegion?: string | null;
+    claimType?: string | null;
+    clickDate?: string | null;
+    impressionDate?: string | null;
+    conversionType?: string | null;
+    supplyPlacement?: string | null;
+}
 export interface AttributionResult {
-    source: "apple_ads" | "fingerprint" | "organic";
-    confidence: number;
-    campaignName?: string;
+    isAttributed?: boolean;
+    source?: "tracking_link" | "apple_ads" | "organic" | "fingerprint" | string;
+    matchType?: "idfa" | "idfv" | "ip_user_agent" | "apple_ads" | "organic" | string;
+    link?: AttributionLink | null;
+    appleAds?: AppleAdsAttribution | null;
+    confidence?: number;
+    campaignName?: string | null;
     utmSource?: string;
     utmMedium?: string;
     utmCampaign?: string;
+    utmContent?: string | null;
+    utmTerm?: string | null;
 }
 export interface InstallResponse {
     appsprintId: string;
     attribution: AttributionResult;
+    attributionParams?: AttributionParams;
 }
 export interface TestEventResult {
     success: boolean;
@@ -36,20 +77,25 @@ export interface DeviceInfo {
     locale?: string;
     timezone?: string;
     osVersion?: string;
+    appVersion?: string;
+    gaid?: string;
     idfv?: string;
     idfa?: string;
     adServicesToken?: string;
+    attStatus?: "not_determined" | "restricted" | "denied" | "authorized";
 }
 export interface NativeAppSprintModule {
-    configure(config: Record<string, unknown>): Promise<void>;
-    sendEvent(eventType: string, name: string | null, revenue: number | null, currency: string | null, parameters: Record<string, unknown> | null): Promise<void>;
+    configure(config: Record<string, unknown>): Promise<boolean>;
+    sendEvent(eventType: string, name: string | null, revenue: number | null, currency: string | null, parameters: Record<string, unknown> | null): Promise<boolean>;
     sendTestEvent(): Promise<TestEventResult>;
     flush(): Promise<void>;
     clearData(): Promise<void>;
     setCustomerUserId(userId: string): Promise<void>;
-    enableAppleAdsAttribution(): Promise<void>;
+    refreshAttribution(): Promise<AttributionResult | null>;
+    enableAppleAdsAttribution(): Promise<boolean>;
     getAppSprintId(): Promise<string | null>;
     getAttribution(): Promise<AttributionResult | null>;
+    getAttributionParams(): Promise<AttributionParams>;
     isInitialized(): Promise<boolean>;
     isSdkDisabled(): Promise<boolean>;
     destroy(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "appsprint-react-native",
-  "version": "0.2.0",
+  "version": "1.0.4",
   "description": "AppSprint mobile attribution SDK for React Native",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",
@@ -30,7 +30,10 @@
     "prepack": "npm run validate:release"
   },
   "keywords": ["react-native", "attribution", "mobile", "analytics", "appsprint"],
-  "repository": "https://github.com/app-sprint/appsprint-react-native",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/getappsprint/appsprint-react-native.git"
+  },
   "author": "AppSprint",
   "license": "MIT",
   "homepage": "https://appsprint.app",

package/plugin/build/index.js

@@ -1,22 +1,49 @@
 "use strict";
 
-const { withInfoPlist } = require("@expo/config-plugins");
+const { withAndroidManifest, withInfoPlist } = require("@expo/config-plugins");
 
 const DEFAULT_TRACKING_DESCRIPTION =
   "This identifier will be used to deliver personalized ads to you.";
 
+const ANDROID_PERMISSIONS = [
+  "android.permission.INTERNET",
+  "com.google.android.gms.permission.AD_ID",
+];
+
+function ensureAndroidPermission(androidManifest, permissionName) {
+  const permissions = androidManifest.manifest["uses-permission"] ?? [];
+  const alreadyDeclared = permissions.some(
+    (permission) => permission.$?.["android:name"] === permissionName
+  );
+
+  if (!alreadyDeclared) {
+    permissions.push({ $: { "android:name": permissionName } });
+  }
+
+  androidManifest.manifest["uses-permission"] = permissions;
+}
+
 const withAppSprint = (config, props) =>
-  withInfoPlist(config, (expoConfig) => {
-    expoConfig.modResults.NSUserTrackingUsageDescription =
-      props?.trackingDescription ?? DEFAULT_TRACKING_DESCRIPTION;
+  withAndroidManifest(
+    withInfoPlist(config, (expoConfig) => {
+      expoConfig.modResults.NSUserTrackingUsageDescription =
+        props?.trackingDescription ?? DEFAULT_TRACKING_DESCRIPTION;
 
-    if (props?.advertisingAttributionEndpoint) {
-      expoConfig.modResults.NSAdvertisingAttributionReportEndpoint =
-        props.advertisingAttributionEndpoint;
-    }
+      if (props?.advertisingAttributionEndpoint) {
+        expoConfig.modResults.NSAdvertisingAttributionReportEndpoint =
+          props.advertisingAttributionEndpoint;
+      }
+
+      return expoConfig;
+    }),
+    (expoConfig) => {
+      for (const permission of ANDROID_PERMISSIONS) {
+        ensureAndroidPermission(expoConfig.modResults, permission);
+      }
 
-    return expoConfig;
-  });
+      return expoConfig;
+    }
+  );
 
 module.exports = withAppSprint;
 module.exports.default = withAppSprint;

package/plugin/src/index.ts

@@ -1,4 +1,39 @@
-import { ConfigPlugin, withInfoPlist } from "@expo/config-plugins";
+import {
+  ConfigPlugin,
+  withAndroidManifest,
+  withInfoPlist,
+} from "@expo/config-plugins";
+
+type AndroidManifest = {
+  manifest: {
+    "uses-permission"?: Array<{
+      $?: {
+        "android:name"?: string;
+      };
+    }>;
+  };
+};
+
+const ANDROID_PERMISSIONS = [
+  "android.permission.INTERNET",
+  "com.google.android.gms.permission.AD_ID",
+];
+
+function ensureAndroidPermission(
+  androidManifest: AndroidManifest,
+  permissionName: string
+) {
+  const permissions = androidManifest.manifest["uses-permission"] ?? [];
+  const alreadyDeclared = permissions.some(
+    (permission) => permission.$?.["android:name"] === permissionName
+  );
+
+  if (!alreadyDeclared) {
+    permissions.push({ $: { "android:name": permissionName } });
+  }
+
+  androidManifest.manifest["uses-permission"] = permissions;
+}
 
 const withAppSprint: ConfigPlugin<{
   trackingDescription?: string;
@@ -21,6 +56,14 @@ const withAppSprint: ConfigPlugin<{
     return config;
   });
 
+  config = withAndroidManifest(config, (config) => {
+    for (const permission of ANDROID_PERMISSIONS) {
+      ensureAndroidPermission(config.modResults as AndroidManifest, permission);
+    }
+
+    return config;
+  });
+
   return config;
 };
 

package/src/AppSprint.ts

@@ -1,30 +1,97 @@
 import { NativeAppSprint } from "./NativeAppSprint";
 import type {
   AppSprintConfig,
+  AppSprintOptions,
+  AttributionParams,
   AttributionResult,
   EventParams,
   EventType,
   TestEventResult,
 } from "./types";
 
+function normalizeEventType(eventType: EventType | string): string {
+  return eventType.toLowerCase().replace(/-/g, "_");
+}
+
+const STANDARD_EVENT_TYPES = new Set([
+  "session_start",
+  "login",
+  "sign_up",
+  "register",
+  "purchase",
+  "subscribe",
+  "start_trial",
+  "add_payment_info",
+  "add_to_cart",
+  "add_to_wishlist",
+  "initiate_checkout",
+  "view_content",
+  "view_item",
+  "search",
+  "share",
+  "tutorial_complete",
+  "achieve_level",
+  "level_start",
+  "level_complete",
+  "custom",
+]);
+
+function numericValue(value: unknown): number | null {
+  if (typeof value === "number") return Number.isFinite(value) ? value : null;
+  if (typeof value === "string" && value.trim().length > 0) {
+    const parsed = Number(value);
+    return Number.isFinite(parsed) ? parsed : null;
+  }
+  return null;
+}
+
+function revenueValue(params?: EventParams): number | null {
+  return numericValue(params?.revenue) ?? numericValue(params?.price);
+}
+
+function normalizeConfig(
+  configOrApiKey: AppSprintConfig | string,
+  options: AppSprintOptions = {}
+): AppSprintConfig {
+  const config =
+    typeof configOrApiKey === "string"
+      ? { ...options, apiKey: configOrApiKey }
+      : configOrApiKey;
+  const apiUrl = config.apiUrl ?? config.endpointBaseUrl;
+  return apiUrl ? { ...config, apiUrl } : config;
+}
+
 class AppSprintSDK {
-  async configure(config: AppSprintConfig): Promise<void> {
+  async configure(
+    configOrApiKey: AppSprintConfig | string,
+    options: AppSprintOptions = {}
+  ): Promise<boolean> {
+    const config = normalizeConfig(configOrApiKey, options);
     if (typeof config.apiKey !== "string" || config.apiKey.trim().length === 0) {
       throw new Error("AppSprint.configure requires a non-empty apiKey.");
     }
 
-    await NativeAppSprint.configure(config as unknown as Record<string, unknown>);
+    return NativeAppSprint.configure(config as unknown as Record<string, unknown>);
   }
 
   async sendEvent(
-    eventType: EventType,
+    eventType: EventType | string,
     name?: string | null,
     params?: EventParams
-  ): Promise<void> {
-    await NativeAppSprint.sendEvent(
-      eventType,
-      name ?? null,
-      params?.revenue ?? null,
+  ): Promise<boolean> {
+    const normalizedEventType = normalizeEventType(eventType);
+    const nativeEventType = STANDARD_EVENT_TYPES.has(normalizedEventType)
+      ? normalizedEventType
+      : "custom";
+    const nativeName =
+      nativeEventType === "custom" && normalizedEventType !== "custom"
+        ? name ?? normalizedEventType
+        : name ?? null;
+
+    return NativeAppSprint.sendEvent(
+      nativeEventType,
+      nativeName,
+      revenueValue(params),
       params?.currency ?? null,
       params ?? null
     );
@@ -46,8 +113,12 @@ class AppSprintSDK {
     await NativeAppSprint.setCustomerUserId(userId);
   }
 
-  async enableAppleAdsAttribution(): Promise<void> {
-    await NativeAppSprint.enableAppleAdsAttribution();
+  async refreshAttribution(): Promise<AttributionResult | null> {
+    return NativeAppSprint.refreshAttribution();
+  }
+
+  async enableAppleAdsAttribution(): Promise<boolean> {
+    return NativeAppSprint.enableAppleAdsAttribution();
   }
 
   async getAppSprintId(): Promise<string | null> {
@@ -58,6 +129,10 @@ class AppSprintSDK {
     return NativeAppSprint.getAttribution();
   }
 
+  async getAttributionParams(): Promise<AttributionParams> {
+    return NativeAppSprint.getAttributionParams();
+  }
+
   async isInitialized(): Promise<boolean> {
     return NativeAppSprint.isInitialized();
   }

package/src/NativeAppSprint.ts

@@ -6,21 +6,33 @@ const LINKING_ERROR =
   "Make sure you have run 'pod install' and rebuilt the app.";
 
 const unsupportedPlatformModule: NativeAppSprintModule = {
-  async configure() {},
-  async sendEvent() {},
+  async configure() {
+    return false;
+  },
+  async sendEvent() {
+    return false;
+  },
   async sendTestEvent() {
     return { success: false, message: "Unsupported platform" };
   },
   async flush() {},
   async clearData() {},
   async setCustomerUserId() {},
-  async enableAppleAdsAttribution() {},
+  async refreshAttribution() {
+    return null;
+  },
+  async enableAppleAdsAttribution() {
+    return false;
+  },
   async getAppSprintId() {
     return null;
   },
   async getAttribution() {
     return null;
   },
+  async getAttributionParams() {
+    return {};
+  },
   async isInitialized() {
     return false;
   },

package/src/index.ts

@@ -2,6 +2,7 @@ export { AppSprint } from "./AppSprint";
 export { NativeAppSprint } from "./NativeAppSprint";
 export type {
   AppSprintConfig,
+  AppSprintOptions,
   EventType,
   EventParams,
   AttributionResult,

package/src/types.ts

@@ -1,51 +1,126 @@
 export interface AppSprintConfig {
   apiKey: string;
   apiUrl?: string; // defaults to https://api.appsprint.app
+  endpointBaseUrl?: string; // Appstack-compatible alias for apiUrl
   enableAppleAdsAttribution?: boolean;
   isDebug?: boolean;
   logLevel?: 0 | 1 | 2 | 3; // 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR
   customerUserId?: string | null;
+  autoTrackSessions?: boolean;
+  autoRefreshAttribution?: boolean;
+  googleAdsConsent?: GoogleAdsConsent | null;
 }
 
+export type AppSprintOptions = Omit<AppSprintConfig, "apiKey">;
 export type LogLevel = 0 | 1 | 2 | 3;
 
 export type EventType =
+  | "session_start"
+  | "SESSION_START"
   | "login"
+  | "LOGIN"
   | "sign_up"
+  | "SIGN_UP"
   | "register"
+  | "REGISTER"
   | "purchase"
+  | "PURCHASE"
   | "subscribe"
+  | "SUBSCRIBE"
   | "start_trial"
+  | "START_TRIAL"
+  | "add_payment_info"
+  | "ADD_PAYMENT_INFO"
   | "add_to_cart"
+  | "ADD_TO_CART"
   | "add_to_wishlist"
+  | "ADD_TO_WISHLIST"
   | "initiate_checkout"
+  | "INITIATE_CHECKOUT"
   | "view_content"
+  | "VIEW_CONTENT"
   | "view_item"
+  | "VIEW_ITEM"
   | "search"
+  | "SEARCH"
   | "share"
+  | "SHARE"
   | "tutorial_complete"
+  | "TUTORIAL_COMPLETE"
+  | "achieve_level"
+  | "ACHIEVE_LEVEL"
   | "level_start"
+  | "LEVEL_START"
   | "level_complete"
-  | "custom";
+  | "LEVEL_COMPLETE"
+  | "custom"
+  | "CUSTOM";
+
+export type GoogleAdsConsentStatus =
+  | "GRANTED"
+  | "DENIED"
+  | "UNSPECIFIED"
+  | "granted"
+  | "denied"
+  | "unspecified";
+
+export interface GoogleAdsConsent {
+  adUserData: GoogleAdsConsentStatus;
+}
 
 export interface EventParams {
   revenue?: number;
+  price?: number | string;
   currency?: string;
+  googleAdsConsent?: GoogleAdsConsent | null;
+  googleAdsAdUserDataConsent?: GoogleAdsConsentStatus;
+  email?: string;
+  name?: string;
+  phone_number?: string;
+  date_of_birth?: string;
   [key: string]: unknown;
 }
 
+export type AttributionParams = Record<string, string>;
+
+export interface AttributionLink {
+  id: string;
+  name: string;
+}
+
+export interface AppleAdsAttribution {
+  campaignId: string;
+  orgId?: string | null;
+  adGroupId?: string | null;
+  keywordId?: string | null;
+  adId?: string | null;
+  countryOrRegion?: string | null;
+  claimType?: string | null;
+  clickDate?: string | null;
+  impressionDate?: string | null;
+  conversionType?: string | null;
+  supplyPlacement?: string | null;
+}
+
 export interface AttributionResult {
-  source: "apple_ads" | "fingerprint" | "organic";
-  confidence: number;
-  campaignName?: string;
+  isAttributed?: boolean;
+  source?: "tracking_link" | "apple_ads" | "organic" | "fingerprint" | string;
+  matchType?: "idfa" | "idfv" | "ip_user_agent" | "apple_ads" | "organic" | string;
+  link?: AttributionLink | null;
+  appleAds?: AppleAdsAttribution | null;
+  confidence?: number;
+  campaignName?: string | null;
   utmSource?: string;
   utmMedium?: string;
   utmCampaign?: string;
+  utmContent?: string | null;
+  utmTerm?: string | null;
 }
 
 export interface InstallResponse {
   appsprintId: string;
   attribution: AttributionResult;
+  attributionParams?: AttributionParams;
 }
 
 export interface TestEventResult {
@@ -60,28 +135,33 @@ export interface DeviceInfo {
   locale?: string;
   timezone?: string;
   osVersion?: string;
+  appVersion?: string;
+  gaid?: string;
   idfv?: string;
   idfa?: string;
   adServicesToken?: string;
+  attStatus?: "not_determined" | "restricted" | "denied" | "authorized";
 }
 
 export interface NativeAppSprintModule {
   // Core SDK (delegates to precompiled binary)
-  configure(config: Record<string, unknown>): Promise<void>;
+  configure(config: Record<string, unknown>): Promise<boolean>;
   sendEvent(
     eventType: string,
     name: string | null,
     revenue: number | null,
     currency: string | null,
     parameters: Record<string, unknown> | null
-  ): Promise<void>;
+  ): Promise<boolean>;
   sendTestEvent(): Promise<TestEventResult>;
   flush(): Promise<void>;
   clearData(): Promise<void>;
   setCustomerUserId(userId: string): Promise<void>;
-  enableAppleAdsAttribution(): Promise<void>;
+  refreshAttribution(): Promise<AttributionResult | null>;
+  enableAppleAdsAttribution(): Promise<boolean>;
   getAppSprintId(): Promise<string | null>;
   getAttribution(): Promise<AttributionResult | null>;
+  getAttributionParams(): Promise<AttributionParams>;
   isInitialized(): Promise<boolean>;
   isSdkDisabled(): Promise<boolean>;
   destroy(): Promise<void>;