appsprint-react-native 0.2.0

package/lib/commonjs/NativeAppSprint.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NativeAppSprint = void 0;
+var _reactNative = require("react-native");
+const LINKING_ERROR = "The package 'appsprint-react-native' doesn't seem to be linked. " + "Make sure you have run 'pod install' and rebuilt the app.";
+const unsupportedPlatformModule = {
+  async configure() {},
+  async sendEvent() {},
+  async sendTestEvent() {
+    return {
+      success: false,
+      message: "Unsupported platform"
+    };
+  },
+  async flush() {},
+  async clearData() {},
+  async setCustomerUserId() {},
+  async enableAppleAdsAttribution() {},
+  async getAppSprintId() {
+    return null;
+  },
+  async getAttribution() {
+    return null;
+  },
+  async isInitialized() {
+    return false;
+  },
+  async isSdkDisabled() {
+    return false;
+  },
+  async destroy() {},
+  async getDeviceInfo() {
+    return {};
+  },
+  async getAdServicesToken() {
+    return null;
+  },
+  async requestTrackingAuthorization() {
+    return false;
+  }
+};
+const NativeAppSprint = exports.NativeAppSprint = _reactNative.Platform.OS === "ios" || _reactNative.Platform.OS === "android" ? _reactNative.NativeModules.AppSprintModule ?? new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+}) : unsupportedPlatformModule;
+//# sourceMappingURL=NativeAppSprint.js.map

package/lib/commonjs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "AppSprint", {
+  enumerable: true,
+  get: function () {
+    return _AppSprint.AppSprint;
+  }
+});
+Object.defineProperty(exports, "NativeAppSprint", {
+  enumerable: true,
+  get: function () {
+    return _NativeAppSprint.NativeAppSprint;
+  }
+});
+var _AppSprint = require("./AppSprint");
+var _NativeAppSprint = require("./NativeAppSprint");
+//# sourceMappingURL=index.js.map

package/lib/commonjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/lib/commonjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=types.js.map

package/lib/module/AppSprint.js

@@ -0,0 +1,46 @@
+"use strict";
+
+import { NativeAppSprint } from "./NativeAppSprint";
+class AppSprintSDK {
+  async configure(config) {
+    if (typeof config.apiKey !== "string" || config.apiKey.trim().length === 0) {
+      throw new Error("AppSprint.configure requires a non-empty apiKey.");
+    }
+    await NativeAppSprint.configure(config);
+  }
+  async sendEvent(eventType, name, params) {
+    await NativeAppSprint.sendEvent(eventType, name ?? null, params?.revenue ?? null, params?.currency ?? null, params ?? null);
+  }
+  async sendTestEvent() {
+    return NativeAppSprint.sendTestEvent();
+  }
+  async flush() {
+    await NativeAppSprint.flush();
+  }
+  async clearData() {
+    await NativeAppSprint.clearData();
+  }
+  async setCustomerUserId(userId) {
+    await NativeAppSprint.setCustomerUserId(userId);
+  }
+  async enableAppleAdsAttribution() {
+    await NativeAppSprint.enableAppleAdsAttribution();
+  }
+  async getAppSprintId() {
+    return NativeAppSprint.getAppSprintId();
+  }
+  async getAttribution() {
+    return NativeAppSprint.getAttribution();
+  }
+  async isInitialized() {
+    return NativeAppSprint.isInitialized();
+  }
+  async isSdkDisabled() {
+    return NativeAppSprint.isSdkDisabled();
+  }
+  async destroy() {
+    await NativeAppSprint.destroy();
+  }
+}
+export const AppSprint = new AppSprintSDK();
+//# sourceMappingURL=AppSprint.js.map

package/lib/module/NativeAppSprint.js

@@ -0,0 +1,47 @@
+"use strict";
+
+import { NativeModules, Platform } from "react-native";
+const LINKING_ERROR = "The package 'appsprint-react-native' doesn't seem to be linked. " + "Make sure you have run 'pod install' and rebuilt the app.";
+const unsupportedPlatformModule = {
+  async configure() {},
+  async sendEvent() {},
+  async sendTestEvent() {
+    return {
+      success: false,
+      message: "Unsupported platform"
+    };
+  },
+  async flush() {},
+  async clearData() {},
+  async setCustomerUserId() {},
+  async enableAppleAdsAttribution() {},
+  async getAppSprintId() {
+    return null;
+  },
+  async getAttribution() {
+    return null;
+  },
+  async isInitialized() {
+    return false;
+  },
+  async isSdkDisabled() {
+    return false;
+  },
+  async destroy() {},
+  async getDeviceInfo() {
+    return {};
+  },
+  async getAdServicesToken() {
+    return null;
+  },
+  async requestTrackingAuthorization() {
+    return false;
+  }
+};
+const NativeAppSprint = Platform.OS === "ios" || Platform.OS === "android" ? NativeModules.AppSprintModule ?? new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+}) : unsupportedPlatformModule;
+export { NativeAppSprint };
+//# sourceMappingURL=NativeAppSprint.js.map

package/lib/module/index.js

@@ -0,0 +1,5 @@
+"use strict";
+
+export { AppSprint } from "./AppSprint";
+export { NativeAppSprint } from "./NativeAppSprint";
+//# sourceMappingURL=index.js.map

package/lib/module/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/lib/module/types.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=types.js.map

package/lib/typescript/AppSprint.d.ts

@@ -0,0 +1,18 @@
+import type { AppSprintConfig, AttributionResult, EventParams, EventType, TestEventResult } from "./types";
+declare class AppSprintSDK {
+    configure(config: AppSprintConfig): Promise<void>;
+    sendEvent(eventType: EventType, name?: string | null, params?: EventParams): Promise<void>;
+    sendTestEvent(): Promise<TestEventResult>;
+    flush(): Promise<void>;
+    clearData(): Promise<void>;
+    setCustomerUserId(userId: string): Promise<void>;
+    enableAppleAdsAttribution(): Promise<void>;
+    getAppSprintId(): Promise<string | null>;
+    getAttribution(): Promise<AttributionResult | null>;
+    isInitialized(): Promise<boolean>;
+    isSdkDisabled(): Promise<boolean>;
+    destroy(): Promise<void>;
+}
+export declare const AppSprint: AppSprintSDK;
+export {};
+//# sourceMappingURL=AppSprint.d.ts.map

package/lib/typescript/NativeAppSprint.d.ts

@@ -0,0 +1,4 @@
+import type { NativeAppSprintModule } from "./types";
+declare const NativeAppSprint: NativeAppSprintModule;
+export { NativeAppSprint };
+//# sourceMappingURL=NativeAppSprint.d.ts.map

package/lib/typescript/index.d.ts

@@ -0,0 +1,4 @@
+export { AppSprint } from "./AppSprint";
+export { NativeAppSprint } from "./NativeAppSprint";
+export type { AppSprintConfig, EventType, EventParams, AttributionResult, InstallResponse, DeviceInfo, LogLevel, TestEventResult, NativeAppSprintModule, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/types.d.ts

@@ -0,0 +1,60 @@
+export interface AppSprintConfig {
+    apiKey: string;
+    apiUrl?: string;
+    enableAppleAdsAttribution?: boolean;
+    isDebug?: boolean;
+    logLevel?: 0 | 1 | 2 | 3;
+    customerUserId?: string | null;
+}
+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 interface EventParams {
+    revenue?: number;
+    currency?: string;
+    [key: string]: unknown;
+}
+export interface AttributionResult {
+    source: "apple_ads" | "fingerprint" | "organic";
+    confidence: number;
+    campaignName?: string;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+}
+export interface InstallResponse {
+    appsprintId: string;
+    attribution: AttributionResult;
+}
+export interface TestEventResult {
+    success: boolean;
+    message: string;
+}
+export interface DeviceInfo {
+    deviceModel?: string;
+    screenWidth?: number;
+    screenHeight?: number;
+    locale?: string;
+    timezone?: string;
+    osVersion?: string;
+    idfv?: string;
+    idfa?: string;
+    adServicesToken?: string;
+}
+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>;
+    sendTestEvent(): Promise<TestEventResult>;
+    flush(): Promise<void>;
+    clearData(): Promise<void>;
+    setCustomerUserId(userId: string): Promise<void>;
+    enableAppleAdsAttribution(): Promise<void>;
+    getAppSprintId(): Promise<string | null>;
+    getAttribution(): Promise<AttributionResult | null>;
+    isInitialized(): Promise<boolean>;
+    isSdkDisabled(): Promise<boolean>;
+    destroy(): Promise<void>;
+    getDeviceInfo(): Promise<DeviceInfo>;
+    getAdServicesToken(): Promise<string | null>;
+    requestTrackingAuthorization(): Promise<boolean>;
+}
+//# sourceMappingURL=types.d.ts.map

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "appsprint-react-native",
+  "version": "0.2.0",
+  "description": "AppSprint mobile attribution SDK for React Native",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index.ts",
+  "source": "src/index.ts",
+  "files": [
+    "src",
+    "lib",
+    "ios",
+    "android",
+    "plugin",
+    "app.plugin.js",
+    "appsprint-react-native.podspec",
+    "!**/__tests__",
+    "!lib/**/*.map",
+    "!ios/build",
+    "!android/build",
+    "!android/.gradle"
+  ],
+  "scripts": {
+    "test": "node --test test/appsprint-sdk.test.cjs test/release-artifacts.test.cjs",
+    "typecheck": "tsc --noEmit",
+    "build": "bob build",
+    "prepare": "bob build",
+    "validate:release": "node scripts/validate-release-artifacts.cjs",
+    "prepack": "npm run validate:release"
+  },
+  "keywords": ["react-native", "attribution", "mobile", "analytics", "appsprint"],
+  "repository": "https://github.com/app-sprint/appsprint-react-native",
+  "author": "AppSprint",
+  "license": "MIT",
+  "homepage": "https://appsprint.app",
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-native": ">=0.71.0"
+  },
+  "devDependencies": {
+    "react-native-builder-bob": "^0.35.0",
+    "typescript": "^5.7.0",
+    "react": "^18.2.0",
+    "react-native": "^0.76.0"
+  },
+  "dependencies": {},
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": ["commonjs", "module", "typescript"]
+  },
+  "expo": {
+    "plugins": ["./app.plugin.js"]
+  }
+}

package/plugin/build/index.d.ts

@@ -0,0 +1,10 @@
+import type { ConfigPlugin } from "@expo/config-plugins";
+
+export interface AppSprintExpoPluginProps {
+  trackingDescription?: string;
+  advertisingAttributionEndpoint?: string;
+}
+
+declare const withAppSprint: ConfigPlugin<AppSprintExpoPluginProps | void>;
+
+export default withAppSprint;

package/plugin/build/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+const { withInfoPlist } = require("@expo/config-plugins");
+
+const DEFAULT_TRACKING_DESCRIPTION =
+  "This identifier will be used to deliver personalized ads to you.";
+
+const withAppSprint = (config, props) =>
+  withInfoPlist(config, (expoConfig) => {
+    expoConfig.modResults.NSUserTrackingUsageDescription =
+      props?.trackingDescription ?? DEFAULT_TRACKING_DESCRIPTION;
+
+    if (props?.advertisingAttributionEndpoint) {
+      expoConfig.modResults.NSAdvertisingAttributionReportEndpoint =
+        props.advertisingAttributionEndpoint;
+    }
+
+    return expoConfig;
+  });
+
+module.exports = withAppSprint;
+module.exports.default = withAppSprint;

package/plugin/src/index.ts

@@ -0,0 +1,27 @@
+import { ConfigPlugin, withInfoPlist } from "@expo/config-plugins";
+
+const withAppSprint: ConfigPlugin<{
+  trackingDescription?: string;
+  advertisingAttributionEndpoint?: string;
+} | void> = (config, props) => {
+  const description =
+    props?.trackingDescription ??
+    "This identifier will be used to deliver personalized ads to you.";
+
+  config = withInfoPlist(config, (config) => {
+    // Add ATT usage description
+    config.modResults.NSUserTrackingUsageDescription = description;
+
+    // Add advertising attribution report endpoint
+    if (props?.advertisingAttributionEndpoint) {
+      config.modResults.NSAdvertisingAttributionReportEndpoint =
+        props.advertisingAttributionEndpoint;
+    }
+
+    return config;
+  });
+
+  return config;
+};
+
+export default withAppSprint;

package/src/AppSprint.ts

@@ -0,0 +1,74 @@
+import { NativeAppSprint } from "./NativeAppSprint";
+import type {
+  AppSprintConfig,
+  AttributionResult,
+  EventParams,
+  EventType,
+  TestEventResult,
+} from "./types";
+
+class AppSprintSDK {
+  async configure(config: AppSprintConfig): Promise<void> {
+    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>);
+  }
+
+  async sendEvent(
+    eventType: EventType,
+    name?: string | null,
+    params?: EventParams
+  ): Promise<void> {
+    await NativeAppSprint.sendEvent(
+      eventType,
+      name ?? null,
+      params?.revenue ?? null,
+      params?.currency ?? null,
+      params ?? null
+    );
+  }
+
+  async sendTestEvent(): Promise<TestEventResult> {
+    return NativeAppSprint.sendTestEvent();
+  }
+
+  async flush(): Promise<void> {
+    await NativeAppSprint.flush();
+  }
+
+  async clearData(): Promise<void> {
+    await NativeAppSprint.clearData();
+  }
+
+  async setCustomerUserId(userId: string): Promise<void> {
+    await NativeAppSprint.setCustomerUserId(userId);
+  }
+
+  async enableAppleAdsAttribution(): Promise<void> {
+    await NativeAppSprint.enableAppleAdsAttribution();
+  }
+
+  async getAppSprintId(): Promise<string | null> {
+    return NativeAppSprint.getAppSprintId();
+  }
+
+  async getAttribution(): Promise<AttributionResult | null> {
+    return NativeAppSprint.getAttribution();
+  }
+
+  async isInitialized(): Promise<boolean> {
+    return NativeAppSprint.isInitialized();
+  }
+
+  async isSdkDisabled(): Promise<boolean> {
+    return NativeAppSprint.isSdkDisabled();
+  }
+
+  async destroy(): Promise<void> {
+    await NativeAppSprint.destroy();
+  }
+}
+
+export const AppSprint = new AppSprintSDK();

package/src/NativeAppSprint.ts

@@ -0,0 +1,52 @@
+import { NativeModules, Platform } from "react-native";
+import type { NativeAppSprintModule } from "./types";
+
+const LINKING_ERROR =
+  "The package 'appsprint-react-native' doesn't seem to be linked. " +
+  "Make sure you have run 'pod install' and rebuilt the app.";
+
+const unsupportedPlatformModule: NativeAppSprintModule = {
+  async configure() {},
+  async sendEvent() {},
+  async sendTestEvent() {
+    return { success: false, message: "Unsupported platform" };
+  },
+  async flush() {},
+  async clearData() {},
+  async setCustomerUserId() {},
+  async enableAppleAdsAttribution() {},
+  async getAppSprintId() {
+    return null;
+  },
+  async getAttribution() {
+    return null;
+  },
+  async isInitialized() {
+    return false;
+  },
+  async isSdkDisabled() {
+    return false;
+  },
+  async destroy() {},
+  async getDeviceInfo() {
+    return {};
+  },
+  async getAdServicesToken() {
+    return null;
+  },
+  async requestTrackingAuthorization() {
+    return false;
+  },
+};
+
+const NativeAppSprint: NativeAppSprintModule =
+  Platform.OS === "ios" || Platform.OS === "android"
+    ? NativeModules.AppSprintModule ??
+      new Proxy({} as NativeAppSprintModule, {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      })
+    : unsupportedPlatformModule;
+
+export { NativeAppSprint };

package/src/index.ts

@@ -0,0 +1,13 @@
+export { AppSprint } from "./AppSprint";
+export { NativeAppSprint } from "./NativeAppSprint";
+export type {
+  AppSprintConfig,
+  EventType,
+  EventParams,
+  AttributionResult,
+  InstallResponse,
+  DeviceInfo,
+  LogLevel,
+  TestEventResult,
+  NativeAppSprintModule,
+} from "./types";

package/src/types.ts

@@ -0,0 +1,93 @@
+export interface AppSprintConfig {
+  apiKey: string;
+  apiUrl?: string; // defaults to https://api.appsprint.app
+  enableAppleAdsAttribution?: boolean;
+  isDebug?: boolean;
+  logLevel?: 0 | 1 | 2 | 3; // 0=DEBUG, 1=INFO, 2=WARN, 3=ERROR
+  customerUserId?: string | null;
+}
+
+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 interface EventParams {
+  revenue?: number;
+  currency?: string;
+  [key: string]: unknown;
+}
+
+export interface AttributionResult {
+  source: "apple_ads" | "fingerprint" | "organic";
+  confidence: number;
+  campaignName?: string;
+  utmSource?: string;
+  utmMedium?: string;
+  utmCampaign?: string;
+}
+
+export interface InstallResponse {
+  appsprintId: string;
+  attribution: AttributionResult;
+}
+
+export interface TestEventResult {
+  success: boolean;
+  message: string;
+}
+
+export interface DeviceInfo {
+  deviceModel?: string;
+  screenWidth?: number;
+  screenHeight?: number;
+  locale?: string;
+  timezone?: string;
+  osVersion?: string;
+  idfv?: string;
+  idfa?: string;
+  adServicesToken?: string;
+}
+
+export interface NativeAppSprintModule {
+  // Core SDK (delegates to precompiled binary)
+  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>;
+  sendTestEvent(): Promise<TestEventResult>;
+  flush(): Promise<void>;
+  clearData(): Promise<void>;
+  setCustomerUserId(userId: string): Promise<void>;
+  enableAppleAdsAttribution(): Promise<void>;
+  getAppSprintId(): Promise<string | null>;
+  getAttribution(): Promise<AttributionResult | null>;
+  isInitialized(): Promise<boolean>;
+  isSdkDisabled(): Promise<boolean>;
+  destroy(): Promise<void>;
+
+  // Utility
+  getDeviceInfo(): Promise<DeviceInfo>;
+  getAdServicesToken(): Promise<string | null>;
+  requestTrackingAuthorization(): Promise<boolean>;
+}