@booleanmaths/booleanmaths-rn-sdk 0.1.0

package/package.json

@@ -0,0 +1,189 @@
+{
+  "name": "@booleanmaths/booleanmaths-rn-sdk",
+  "version": "0.1.0",
+  "description": "React Native SDK for BooleanMaths — track user events and attribution in mobile apps.",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "@booleanmaths/booleanmaths-rn-sdk-source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace booleanmaths-rn-sdk-example",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "test": "jest",
+    "release": "release-it --only-version",
+    "web": "vite",
+    "build:web": "vite build"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android",
+    "booleanmaths",
+    "analytics",
+    "attribution",
+    "event-tracking",
+    "turbomodule",
+    "sdk"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/medront/react-native-booleanmaths-sdk.git"
+  },
+  "author": "Medront (https://github.com/medront)",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/medront/react-native-booleanmaths-sdk/issues"
+  },
+  "homepage": "https://github.com/medront/react-native-booleanmaths-sdk#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^21.0.2",
+    "@eslint/compat": "^2.1.0",
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^10.0.1",
+    "@jest/globals": "^29.7.0",
+    "@react-native/babel-preset": "0.85.0",
+    "@react-native/eslint-config": "0.85.0",
+    "@react-native/jest-preset": "0.85.0",
+    "@release-it/conventional-changelog": "^11.0.1",
+    "@types/react": "^19.2.0",
+    "commitlint": "^21.0.2",
+    "del-cli": "^7.0.0",
+    "eslint": "^9.39.4",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-ft-flow": "^3.0.11",
+    "eslint-plugin-prettier": "^5.5.6",
+    "jest": "^29.7.0",
+    "lefthook": "^2.1.9",
+    "prettier": "^3.8.3",
+    "react": "19.2.3",
+    "react-native": "0.85.0",
+    "react-native-builder-bob": "^0.43.0",
+    "react-native-web": "~0.21.2",
+    "release-it": "^20.2.0",
+    "turbo": "^2.9.16",
+    "typescript": "^6.0.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@4.11.0",
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "BooleanmathsRnSdkSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.booleanmathsrnsdk"
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "jest": {
+    "preset": "@react-native/jest-preset",
+    "testEnvironmentOptions": {
+      "customExportConditions": [
+        "require",
+        "react-native",
+        "@booleanmaths/booleanmaths-rn-sdk-source"
+      ]
+    },
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "create-react-native-library": {
+    "type": "turbo-module",
+    "languages": "kotlin-objc",
+    "tools": [
+      "eslint",
+      "jest",
+      "lefthook",
+      "release-it",
+      "vite"
+    ],
+    "version": "0.63.0"
+  }
+}

package/src/BooleanMaths.native.tsx

@@ -0,0 +1,86 @@
+import { Platform } from 'react-native';
+import NativeBooleanmathsRnSdk from './NativeBooleanmathsRnSdk';
+import type { BooleanMathsApi, BooleanMathsEventProperties } from './types';
+
+/**
+ * The BooleanMaths native SDK currently ships for Android only. There is no
+ * iOS artifact yet, so on iOS every call below short-circuits and the SDK
+ * behaves as a silent no-op rather than crashing the app.
+ */
+const SUPPORTED_PLATFORMS: ReadonlyArray<typeof Platform.OS> = ['android'];
+
+const isPlatformSupported = SUPPORTED_PLATFORMS.includes(Platform.OS);
+
+/**
+ * Both conditions must hold: a platform we ship a native SDK for, and a native
+ * module that actually resolved. The second guards against a broken/incomplete
+ * native install.
+ */
+const isSupported = isPlatformSupported && NativeBooleanmathsRnSdk != null;
+
+let hasWarned = false;
+
+function warnOnce() {
+  if (hasWarned || !__DEV__) {
+    return;
+  }
+
+  hasWarned = true;
+
+  if (!isPlatformSupported) {
+    console.warn(
+      `[@booleanmaths/booleanmaths-rn-sdk] The BooleanMaths native SDK is not available on ${Platform.OS} ` +
+        '(Android only for now). All SDK calls are no-ops on this platform and no ' +
+        'events will be tracked. Gate your calls on `BooleanMaths.isSupported` to ' +
+        'silence this warning — see the README\'s "Platform support" section.'
+    );
+    return;
+  }
+
+  console.warn(
+    '[@booleanmaths/booleanmaths-rn-sdk] The native module could not be found on ' +
+      `${Platform.OS}. Rebuild the app after installing the package (a Metro ` +
+      'reload is not enough), and on iOS run `pod install`. All SDK calls are ' +
+      'no-ops until this is fixed.'
+  );
+}
+
+export const BooleanMaths: BooleanMathsApi = {
+  isSupported,
+
+  initialize(apiKey: string, pixelId: string): void {
+    if (!isSupported) {
+      warnOnce();
+      return;
+    }
+
+    NativeBooleanmathsRnSdk!.initializeSdk(apiKey, pixelId);
+  },
+
+  trackEvent(name: string, properties: BooleanMathsEventProperties = {}): void {
+    if (!isSupported) {
+      warnOnce();
+      return;
+    }
+
+    NativeBooleanmathsRnSdk!.trackEvent(name, properties);
+  },
+
+  handleNotificationIntent(): void {
+    if (!isSupported) {
+      warnOnce();
+      return;
+    }
+
+    NativeBooleanmathsRnSdk!.handleNotificationIntent();
+  },
+
+  getHelloMessage(): string | null {
+    if (!isSupported) {
+      warnOnce();
+      return null;
+    }
+
+    return NativeBooleanmathsRnSdk!.getHelloMessage();
+  },
+};

package/src/BooleanMaths.tsx

@@ -0,0 +1,45 @@
+import type { BooleanMathsApi, BooleanMathsEventProperties } from './types';
+
+/**
+ * Web (and any non-React-Native) build of the SDK.
+ *
+ * There is no BooleanMaths browser SDK behind this wrapper, so every method is
+ * a no-op. It exists so that shared code can import and call the SDK
+ * unconditionally without platform checks or bundler errors.
+ */
+let hasWarned = false;
+
+function warnOnce() {
+  if (hasWarned || typeof __DEV__ === 'undefined' || !__DEV__) {
+    return;
+  }
+
+  hasWarned = true;
+
+  console.warn(
+    '[@booleanmaths/booleanmaths-rn-sdk] The BooleanMaths SDK has no web implementation. ' +
+      'All SDK calls are no-ops on web and no events will be tracked. Gate your ' +
+      'calls on `BooleanMaths.isSupported` to silence this warning.'
+  );
+}
+
+export const BooleanMaths: BooleanMathsApi = {
+  isSupported: false,
+
+  initialize(_apiKey: string, _pixelId: string): void {
+    warnOnce();
+  },
+
+  trackEvent(_name: string, _properties?: BooleanMathsEventProperties): void {
+    warnOnce();
+  },
+
+  handleNotificationIntent(): void {
+    warnOnce();
+  },
+
+  getHelloMessage(): string | null {
+    warnOnce();
+    return null;
+  },
+};

package/src/NativeBooleanmathsRnSdk.ts

@@ -0,0 +1,22 @@
+import { TurboModuleRegistry, type TurboModule } from 'react-native';
+
+export interface Spec extends TurboModule {
+  /**
+   * Named `initializeSdk` rather than `initialize` on purpose: `initialize` is
+   * already taken by `NativeModule.initialize()` on Android and by
+   * `+[NSObject initialize]` on iOS. The public JS API exposes this as
+   * `BooleanMaths.initialize()`.
+   */
+  initializeSdk(apiKey: string, pixelId: string): void;
+  trackEvent(name: string, properties: Object): void;
+  /** Android only. No-op elsewhere. */
+  handleNotificationIntent(): void;
+  /** Smoke test that the native bridge is wired up. */
+  getHelloMessage(): string;
+}
+
+/**
+ * `get` rather than `getEnforcing` so that a missing/unlinked native module
+ * degrades to a warning instead of throwing at import time.
+ */
+export default TurboModuleRegistry.get<Spec>('BooleanmathsRnSdk');

package/src/index.tsx

@@ -0,0 +1,7 @@
+export { BooleanMaths } from './BooleanMaths';
+export { BooleanMaths as default } from './BooleanMaths';
+export type {
+  BooleanMathsApi,
+  BooleanMathsEventProperties,
+  BooleanMathsPropertyValue,
+} from './types';

package/src/types.ts

@@ -0,0 +1,60 @@
+/**
+ * Values allowed inside an event's `properties` payload.
+ *
+ * The payload is serialized to JSON natively, so only JSON-representable
+ * values survive the bridge. Nested objects and arrays are supported.
+ */
+export type BooleanMathsPropertyValue =
+  | string
+  | number
+  | boolean
+  | null
+  | undefined
+  | BooleanMathsPropertyValue[]
+  | { [key: string]: BooleanMathsPropertyValue };
+
+export type BooleanMathsEventProperties = Record<
+  string,
+  BooleanMathsPropertyValue
+>;
+
+export interface BooleanMathsApi {
+  /**
+   * Initializes the native SDK. Safe to call on any platform; on platforms
+   * without native support this is a no-op (see `isSupported`).
+   *
+   * Calling this more than once is harmless — the native SDK ignores
+   * subsequent calls.
+   */
+  initialize(apiKey: string, pixelId: string): void;
+
+  /**
+   * Records a custom event. Events are persisted locally and synced in the
+   * background, so this never blocks and never throws on network failure.
+   *
+   * No-op if `initialize` has not been called.
+   */
+  trackEvent(name: string, properties?: BooleanMathsEventProperties): void;
+
+  /**
+   * Forwards the current Activity's intent to the native SDK so deep-link and
+   * notification campaign data is attributed.
+   *
+   * Android only — a no-op on every other platform. Call this from your
+   * deep-link handler and once after `initialize`; see the README for why the
+   * launch intent needs this.
+   */
+  handleNotificationIntent(): void;
+
+  /**
+   * Returns the native SDK's hello message, or `null` when there is no native
+   * SDK on this platform. Useful as a bridge smoke test.
+   */
+  getHelloMessage(): string | null;
+
+  /**
+   * `true` only on platforms where a real BooleanMaths native SDK is linked.
+   * Currently Android only.
+   */
+  readonly isSupported: boolean;
+}