@booleanmaths/booleanmaths-rn-sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BooleanmathsRnSdk.podspec +20 -0
- package/LICENSE +201 -0
- package/README.md +365 -0
- package/android/build.gradle +78 -0
- package/android/src/main/AndroidManifest.xml +2 -0
- package/android/src/main/java/com/booleanmathsrnsdk/BooleanmathsRnSdkModule.kt +126 -0
- package/android/src/main/java/com/booleanmathsrnsdk/BooleanmathsRnSdkPackage.kt +31 -0
- package/ios/BooleanmathsRnSdk.h +20 -0
- package/ios/BooleanmathsRnSdk.mm +56 -0
- package/lib/module/BooleanMaths.js +34 -0
- package/lib/module/BooleanMaths.js.map +1 -0
- package/lib/module/BooleanMaths.native.js +62 -0
- package/lib/module/BooleanMaths.native.js.map +1 -0
- package/lib/module/NativeBooleanmathsRnSdk.js +9 -0
- package/lib/module/NativeBooleanmathsRnSdk.js.map +1 -0
- package/lib/module/index.js +5 -0
- package/lib/module/index.js.map +1 -0
- package/lib/module/package.json +1 -0
- package/lib/module/types.js +2 -0
- package/lib/module/types.js.map +1 -0
- package/lib/typescript/package.json +1 -0
- package/lib/typescript/src/BooleanMaths.d.ts +3 -0
- package/lib/typescript/src/BooleanMaths.d.ts.map +1 -0
- package/lib/typescript/src/BooleanMaths.native.d.ts +3 -0
- package/lib/typescript/src/BooleanMaths.native.d.ts.map +1 -0
- package/lib/typescript/src/NativeBooleanmathsRnSdk.d.ts +22 -0
- package/lib/typescript/src/NativeBooleanmathsRnSdk.d.ts.map +1 -0
- package/lib/typescript/src/index.d.ts +4 -0
- package/lib/typescript/src/index.d.ts.map +1 -0
- package/lib/typescript/src/types.d.ts +47 -0
- package/lib/typescript/src/types.d.ts.map +1 -0
- package/package.json +189 -0
- package/src/BooleanMaths.native.tsx +86 -0
- package/src/BooleanMaths.tsx +45 -0
- package/src/NativeBooleanmathsRnSdk.ts +22 -0
- package/src/index.tsx +7 -0
- package/src/types.ts +60 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
require "json"
|
|
2
|
+
|
|
3
|
+
package = JSON.parse(File.read(File.join(__dir__, "package.json")))
|
|
4
|
+
|
|
5
|
+
Pod::Spec.new do |s|
|
|
6
|
+
s.name = "BooleanmathsRnSdk"
|
|
7
|
+
s.version = package["version"]
|
|
8
|
+
s.summary = package["description"]
|
|
9
|
+
s.homepage = package["homepage"]
|
|
10
|
+
s.license = package["license"]
|
|
11
|
+
s.authors = package["author"]
|
|
12
|
+
|
|
13
|
+
s.platforms = { :ios => min_ios_version_supported }
|
|
14
|
+
s.source = { :git => "https://github.com/medront/react-native-booleanmaths-sdk.git", :tag => "v#{s.version}" }
|
|
15
|
+
|
|
16
|
+
s.source_files = "ios/**/*.{h,m,mm,swift,cpp}"
|
|
17
|
+
s.private_header_files = "ios/**/*.h"
|
|
18
|
+
|
|
19
|
+
install_modules_dependencies(s)
|
|
20
|
+
end
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,365 @@
|
|
|
1
|
+
# @booleanmaths/booleanmaths-rn-sdk
|
|
2
|
+
|
|
3
|
+
React Native wrapper around the BooleanMaths mobile SDK for user event tracking
|
|
4
|
+
and attribution.
|
|
5
|
+
|
|
6
|
+
This package is a thin TurboModule bridge over the native
|
|
7
|
+
[`com.booleanmaths:bm-sdk`](https://central.sonatype.com/artifact/com.booleanmaths/bm-sdk)
|
|
8
|
+
Android SDK.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## ⚠️ Platform support
|
|
13
|
+
|
|
14
|
+
> **There is no BooleanMaths iOS SDK yet.** The native SDK is published for
|
|
15
|
+
> **Android only**. On iOS (and on web) this package installs and builds
|
|
16
|
+
> normally, but **every SDK call is a no-op and no events are tracked**.
|
|
17
|
+
|
|
18
|
+
| Platform | Native SDK | Behaviour |
|
|
19
|
+
| :------- | :--------- | :-------- |
|
|
20
|
+
| Android | ✅ `com.booleanmaths:bm-sdk:1.0.7` | Fully functional |
|
|
21
|
+
| iOS | ❌ not published | Silent no-op, **never crashes** |
|
|
22
|
+
| Web | ❌ not published | Silent no-op, **never crashes** |
|
|
23
|
+
|
|
24
|
+
### Why it does not crash
|
|
25
|
+
|
|
26
|
+
Two independent guards, so a missing iOS SDK can never take your app down:
|
|
27
|
+
|
|
28
|
+
1. **JavaScript gate.** `BooleanMaths` checks `Platform.OS` against an
|
|
29
|
+
allowlist (currently `['android']`) and returns before touching the native
|
|
30
|
+
bridge. It also verifies the TurboModule actually resolved, which covers a
|
|
31
|
+
broken or incomplete native install.
|
|
32
|
+
2. **Native backstop.** iOS still ships a real TurboModule
|
|
33
|
+
([`ios/BooleanmathsRnSdk.mm`](ios/BooleanmathsRnSdk.mm)) whose methods are
|
|
34
|
+
no-ops. So even a direct call into the bridge is harmless.
|
|
35
|
+
|
|
36
|
+
In development (`__DEV__`) you get **one** console warning per app launch, not
|
|
37
|
+
one per call.
|
|
38
|
+
|
|
39
|
+
### The fix: gate your own analytics code
|
|
40
|
+
|
|
41
|
+
Calling the SDK unconditionally is safe — you do not *need* to branch. But if
|
|
42
|
+
you want to avoid dead work, skip the dev warning, or show different UI, branch
|
|
43
|
+
on `isSupported`:
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
import { BooleanMaths } from '@booleanmaths/booleanmaths-rn-sdk';
|
|
47
|
+
|
|
48
|
+
if (BooleanMaths.isSupported) {
|
|
49
|
+
BooleanMaths.initialize(API_KEY, PIXEL_ID);
|
|
50
|
+
} else {
|
|
51
|
+
// Fall back to another analytics provider on iOS, or do nothing.
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
`isSupported` is a plain boolean, evaluated at module load — cheap to read as
|
|
56
|
+
often as you like.
|
|
57
|
+
|
|
58
|
+
### When the iOS SDK ships
|
|
59
|
+
|
|
60
|
+
Two changes, no API break for consumers:
|
|
61
|
+
|
|
62
|
+
1. Add the iOS dependency to [`BooleanmathsRnSdk.podspec`](BooleanmathsRnSdk.podspec)
|
|
63
|
+
and implement the method bodies in [`ios/BooleanmathsRnSdk.mm`](ios/BooleanmathsRnSdk.mm).
|
|
64
|
+
2. Add `'ios'` to `SUPPORTED_PLATFORMS` in
|
|
65
|
+
[`src/BooleanMaths.native.tsx`](src/BooleanMaths.native.tsx).
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## Installation
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
npm install @booleanmaths/booleanmaths-rn-sdk
|
|
73
|
+
# or
|
|
74
|
+
yarn add @booleanmaths/booleanmaths-rn-sdk
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Then rebuild the native app — a Metro reload is **not** enough:
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
npx react-native run-android
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Requirements
|
|
84
|
+
|
|
85
|
+
- React Native **0.80+** with the **New Architecture** enabled (this is a
|
|
86
|
+
TurboModule)
|
|
87
|
+
- Android **minSdkVersion 24** or higher (the native SDK requires it)
|
|
88
|
+
- `compileSdkVersion 36`, Java 17
|
|
89
|
+
|
|
90
|
+
### Android
|
|
91
|
+
|
|
92
|
+
Nothing to configure. Autolinking picks the module up, the native SDK resolves
|
|
93
|
+
from Maven Central, and the AAR merges the `INTERNET` permission it needs.
|
|
94
|
+
|
|
95
|
+
To pin a different native SDK version, set this in your app's **root**
|
|
96
|
+
`build.gradle`:
|
|
97
|
+
|
|
98
|
+
```gradle
|
|
99
|
+
buildscript {
|
|
100
|
+
ext {
|
|
101
|
+
BooleanmathsRnSdk_bmSdkVersion = "1.0.7"
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### iOS
|
|
107
|
+
|
|
108
|
+
Run `pod install` as usual. This installs the no-op stub described above — it
|
|
109
|
+
compiles and links, it just does not track anything.
|
|
110
|
+
|
|
111
|
+
```sh
|
|
112
|
+
cd ios && pod install
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Usage
|
|
118
|
+
|
|
119
|
+
```ts
|
|
120
|
+
import { BooleanMaths } from '@booleanmaths/booleanmaths-rn-sdk';
|
|
121
|
+
|
|
122
|
+
// Once, as early as possible — typically in your root component.
|
|
123
|
+
BooleanMaths.initialize('YOUR_API_KEY', 'YOUR_PIXEL_ID');
|
|
124
|
+
|
|
125
|
+
// Anywhere afterwards.
|
|
126
|
+
BooleanMaths.trackEvent('purchase', {
|
|
127
|
+
orderId: 'ORD-1024',
|
|
128
|
+
value: 2499,
|
|
129
|
+
currency: 'INR',
|
|
130
|
+
isFirstPurchase: true,
|
|
131
|
+
items: [{ sku: 'SKU-1', quantity: 2, price: 999.5 }],
|
|
132
|
+
});
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Calls are fire-and-forget. Events are persisted to a local database natively
|
|
136
|
+
and synced in the background, so `trackEvent` never blocks and never rejects on
|
|
137
|
+
network failure.
|
|
138
|
+
|
|
139
|
+
Events tracked **before** `initialize` are dropped (the native SDK logs an
|
|
140
|
+
error). Calling `initialize` more than once is harmless — subsequent calls are
|
|
141
|
+
ignored.
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## API
|
|
146
|
+
|
|
147
|
+
### `BooleanMaths.initialize(apiKey, pixelId): void`
|
|
148
|
+
|
|
149
|
+
Initializes the native SDK. Also registers this wrapper with the native SDK so
|
|
150
|
+
every event carries `wrapper_type: "react-native"` and the wrapper version, and
|
|
151
|
+
forwards the launch intent (see [Deep links](#deep-links-and-notification-attribution)).
|
|
152
|
+
|
|
153
|
+
### `BooleanMaths.trackEvent(name, properties?): void`
|
|
154
|
+
|
|
155
|
+
Records a custom event. `properties` defaults to `{}` and may contain strings,
|
|
156
|
+
numbers, booleans, nested objects, and arrays.
|
|
157
|
+
|
|
158
|
+
### `BooleanMaths.handleNotificationIntent(): void`
|
|
159
|
+
|
|
160
|
+
**Android only** (no-op elsewhere). Forwards the current Activity's intent to
|
|
161
|
+
the native SDK so deep-link and notification campaign data is attributed. Safe
|
|
162
|
+
to call repeatedly — the native SDK de-duplicates intents it has already seen.
|
|
163
|
+
|
|
164
|
+
### `BooleanMaths.getHelloMessage(): string | null`
|
|
165
|
+
|
|
166
|
+
Bridge smoke test. Returns the native SDK's hello string, or `null` where there
|
|
167
|
+
is no native SDK.
|
|
168
|
+
|
|
169
|
+
### `BooleanMaths.isSupported: boolean`
|
|
170
|
+
|
|
171
|
+
`true` only where a real native SDK is linked. Currently Android only.
|
|
172
|
+
|
|
173
|
+
---
|
|
174
|
+
|
|
175
|
+
## Deep links and notification attribution
|
|
176
|
+
|
|
177
|
+
The native SDK registers its `ActivityLifecycleCallbacks` **inside**
|
|
178
|
+
`initialize()`. In a React Native app that runs long after `MainActivity`'s
|
|
179
|
+
`onActivityCreated` has already fired, so **the intent that cold-started your
|
|
180
|
+
app is never seen by those callbacks.**
|
|
181
|
+
|
|
182
|
+
This wrapper works around it by forwarding `currentActivity.intent` at the end
|
|
183
|
+
of `initialize()`. For links that arrive while the app is already running, call
|
|
184
|
+
`handleNotificationIntent()` yourself:
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
useEffect(() => {
|
|
188
|
+
BooleanMaths.initialize(API_KEY, PIXEL_ID);
|
|
189
|
+
|
|
190
|
+
// Deep link received while the app is running.
|
|
191
|
+
const link = Linking.addEventListener('url', () => {
|
|
192
|
+
BooleanMaths.handleNotificationIntent();
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
// Notification tap that brought the app back to the foreground.
|
|
196
|
+
const state = AppState.addEventListener('change', (next) => {
|
|
197
|
+
if (next === 'active') {
|
|
198
|
+
BooleanMaths.handleNotificationIntent();
|
|
199
|
+
}
|
|
200
|
+
});
|
|
201
|
+
|
|
202
|
+
return () => {
|
|
203
|
+
link.remove();
|
|
204
|
+
state.remove();
|
|
205
|
+
};
|
|
206
|
+
}, []);
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
If your `MainActivity` uses `launchMode="singleTask"`, also make sure it
|
|
210
|
+
forwards new intents, or `currentActivity.intent` will keep returning the
|
|
211
|
+
original launch intent:
|
|
212
|
+
|
|
213
|
+
```kotlin
|
|
214
|
+
override fun onNewIntent(intent: Intent) {
|
|
215
|
+
// Set before super so the fresh intent is in place by the time React Native
|
|
216
|
+
// emits the corresponding Linking event to JavaScript.
|
|
217
|
+
setIntent(intent)
|
|
218
|
+
super.onNewIntent(intent)
|
|
219
|
+
}
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Testing it end to end
|
|
223
|
+
|
|
224
|
+
The example app ships a self-contained harness for this — no push provider or
|
|
225
|
+
Firebase project needed. **Schedule notification (10s)** posts a local
|
|
226
|
+
notification whose tap intent mimics a real marketing push (an `ACTION_VIEW`
|
|
227
|
+
deep link plus campaign extras), then navigates to a promo screen showing both
|
|
228
|
+
the parsed link params and exactly what the SDK read from the intent.
|
|
229
|
+
|
|
230
|
+
```sh
|
|
231
|
+
yarn example android
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
The scheduler is example-app-only code, deliberately not part of the SDK:
|
|
235
|
+
|
|
236
|
+
| File | Role |
|
|
237
|
+
| :--- | :--- |
|
|
238
|
+
| [NotificationDemoModule.kt](example/android/app/src/main/java/booleanmathsrnsdk/example/NotificationDemoModule.kt) | `scheduleNotification` / `getCurrentIntentInfo` |
|
|
239
|
+
| [NotificationPublisher.kt](example/android/app/src/main/java/booleanmathsrnsdk/example/NotificationPublisher.kt) | Builds the notification and its tap intent |
|
|
240
|
+
| [MainActivity.kt](example/android/app/src/main/java/booleanmathsrnsdk/example/MainActivity.kt) | The `setIntent` override above |
|
|
241
|
+
|
|
242
|
+
It uses `AlarmManager` rather than a delayed `Handler` specifically so the
|
|
243
|
+
notification still fires after the app is backgrounded or force stopped, which
|
|
244
|
+
lets you exercise both paths:
|
|
245
|
+
|
|
246
|
+
- **Warm** — background the app, tap the notification. Goes through
|
|
247
|
+
`onNewIntent`, so it only attributes because of the `setIntent` override.
|
|
248
|
+
- **Cold** — force stop the app (`adb shell am force-stop
|
|
249
|
+
booleanmathsrnsdk.example`), then tap. Attribution here depends on this
|
|
250
|
+
wrapper forwarding the launch intent during `initialize()`.
|
|
251
|
+
|
|
252
|
+
Watch it land with:
|
|
253
|
+
|
|
254
|
+
```sh
|
|
255
|
+
adb logcat -s BooleanMathsSDK:D EventDispatcher:D
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
A successful tap logs `Notification click tracked with campaign data.`,
|
|
259
|
+
persists a `NotificationClick` event, and dispatches it with the campaign
|
|
260
|
+
fields nested under `data.notification`.
|
|
261
|
+
|
|
262
|
+
---
|
|
263
|
+
|
|
264
|
+
## Automatic events
|
|
265
|
+
|
|
266
|
+
The native SDK tracks these without any call from you:
|
|
267
|
+
|
|
268
|
+
| Event | When |
|
|
269
|
+
| :---- | :--- |
|
|
270
|
+
| `app_opened` | First Activity creation / SDK initialization |
|
|
271
|
+
| `FirstOpen` | Once per install, with Google Play Install Referrer attribution |
|
|
272
|
+
| `NotificationClick` | Any intent with an action, data string, or extras is handled — see the caveat below |
|
|
273
|
+
|
|
274
|
+
Visitor ID and session ID (30-minute timeout) are generated and persisted
|
|
275
|
+
natively.
|
|
276
|
+
|
|
277
|
+
> ⚠️ **`NotificationClick` fires on ordinary app opens too (native SDK v1.0.7).**
|
|
278
|
+
> `extractCampaignData` records `intent.action` unconditionally, and
|
|
279
|
+
> `handleNotificationIntent` emits the event whenever the resulting map is
|
|
280
|
+
> non-empty. A launcher tap always carries `action = ACTION_MAIN`, so opening
|
|
281
|
+
> the app normally produces:
|
|
282
|
+
>
|
|
283
|
+
> ```json
|
|
284
|
+
> { "event": "NotificationClick",
|
|
285
|
+
> "data": { "notification": { "action": "android.intent.action.MAIN" } } }
|
|
286
|
+
> ```
|
|
287
|
+
>
|
|
288
|
+
> So `NotificationClick` counts **notification taps plus plain opens**, and
|
|
289
|
+
> cannot be used as a tap metric without filtering. A real tap is
|
|
290
|
+
> distinguishable downstream: it carries a `data` deep link and/or campaign
|
|
291
|
+
> extras, whereas a launcher open has only `action`.
|
|
292
|
+
>
|
|
293
|
+
> This wrapper reproduces the behaviour deliberately, for parity with native
|
|
294
|
+
> Android and the Flutter wrapper — the native SDK does exactly the same via its
|
|
295
|
+
> `onActivityCreated` callback. The fix belongs upstream in the Android SDK
|
|
296
|
+
> (require deep-link data or extras before emitting the event), not here.
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
## How properties cross the bridge
|
|
301
|
+
|
|
302
|
+
Two normalizations happen on the Android side, both worth knowing:
|
|
303
|
+
|
|
304
|
+
- **Integral numbers are converted to integers.** React Native passes every JS
|
|
305
|
+
number across the bridge as a `Double`, so `{ count: 3 }` would otherwise be
|
|
306
|
+
serialized as `3.0`. Values that are whole and within
|
|
307
|
+
`Number.MAX_SAFE_INTEGER` become integers; genuine fractions such as `999.5`
|
|
308
|
+
are untouched. This is what gets **persisted** locally:
|
|
309
|
+
|
|
310
|
+
```json
|
|
311
|
+
{ "value": 2499, "items": [{ "quantity": 2, "price": 999.5 }] }
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
> ⚠️ **Known native SDK limitation (v1.0.7).** The integers do *not* survive
|
|
315
|
+
> to the wire. `EventDispatcher` re-reads the stored payload with
|
|
316
|
+
> `gson.fromJson(properties, Map::class.java)`, and Gson coerces every number
|
|
317
|
+
> in a raw `Map` to `Double` — so the request body ends up with `2499.0` and
|
|
318
|
+
> `"quantity": 2.0` regardless of what this wrapper does. Strings and booleans
|
|
319
|
+
> are unaffected. This cannot be fixed from the wrapper; it needs a change in
|
|
320
|
+
> the native Android SDK (parse to `JsonElement`, or keep the stored JSON
|
|
321
|
+
> string as-is instead of round-tripping it). The normalization here is still
|
|
322
|
+
> correct at the boundary and will produce correct request bodies as soon as
|
|
323
|
+
> the native SDK stops round-tripping.
|
|
324
|
+
- **`null` and `undefined` values are dropped from objects.** The native SDK
|
|
325
|
+
serializes with Gson, which omits null map values anyway, so the emitted JSON
|
|
326
|
+
is identical. Nulls **inside arrays** are preserved so indices do not shift.
|
|
327
|
+
|
|
328
|
+
Failures in the native bridge are logged (`adb logcat -s BooleanmathsRnSdk`)
|
|
329
|
+
rather than thrown into JavaScript — analytics should never crash the host app.
|
|
330
|
+
|
|
331
|
+
---
|
|
332
|
+
|
|
333
|
+
## Troubleshooting
|
|
334
|
+
|
|
335
|
+
**No events arriving.** Confirm `BooleanMaths.isSupported` is `true`, then check
|
|
336
|
+
`adb logcat -s BooleanMathsSDK:D BooleanmathsRnSdk:D`. The native SDK logs each
|
|
337
|
+
persisted event and the full payload it sends.
|
|
338
|
+
|
|
339
|
+
**Warning: "native module could not be found".** The JS installed but the native
|
|
340
|
+
side did not. Rebuild the app (`npx react-native run-android`) rather than just
|
|
341
|
+
reloading Metro; on iOS run `pod install`.
|
|
342
|
+
|
|
343
|
+
**Events show a delay.** By design. Each `trackEvent` enqueues an immediate
|
|
344
|
+
sync attempt, but WorkManager also runs a periodic 15-minute batch job and
|
|
345
|
+
requires network connectivity.
|
|
346
|
+
|
|
347
|
+
**Deep link not attributed.** See
|
|
348
|
+
[Deep links](#deep-links-and-notification-attribution) — the launch intent needs
|
|
349
|
+
explicit forwarding, and `singleTask` activities need `setIntent`.
|
|
350
|
+
|
|
351
|
+
---
|
|
352
|
+
|
|
353
|
+
## Contributing
|
|
354
|
+
|
|
355
|
+
- [Development workflow](CONTRIBUTING.md#development-workflow)
|
|
356
|
+
- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
|
|
357
|
+
- [Code of conduct](CODE_OF_CONDUCT.md)
|
|
358
|
+
|
|
359
|
+
## License
|
|
360
|
+
|
|
361
|
+
MIT
|
|
362
|
+
|
|
363
|
+
---
|
|
364
|
+
|
|
365
|
+
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
buildscript {
|
|
2
|
+
ext.BooleanmathsRnSdk = [
|
|
3
|
+
kotlinVersion: "2.0.21",
|
|
4
|
+
minSdkVersion: 24,
|
|
5
|
+
compileSdkVersion: 36,
|
|
6
|
+
// Version of the native Android SDK (com.booleanmaths:bm-sdk) this wrapper
|
|
7
|
+
// is built against. Override with `ext.BooleanmathsRnSdk_bmSdkVersion` in
|
|
8
|
+
// your app's root build.gradle to pin a different one.
|
|
9
|
+
bmSdkVersion: "1.0.7"
|
|
10
|
+
]
|
|
11
|
+
|
|
12
|
+
ext.getExtOrDefault = { prop ->
|
|
13
|
+
if (rootProject.ext.has(prop)) {
|
|
14
|
+
return rootProject.ext.get(prop)
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
return BooleanmathsRnSdk[prop]
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
repositories {
|
|
21
|
+
google()
|
|
22
|
+
mavenCentral()
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
dependencies {
|
|
26
|
+
classpath "com.android.tools.build:gradle:8.7.2"
|
|
27
|
+
// noinspection DifferentKotlinGradleVersion
|
|
28
|
+
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
apply plugin: "com.android.library"
|
|
34
|
+
apply plugin: "kotlin-android"
|
|
35
|
+
|
|
36
|
+
apply plugin: "com.facebook.react"
|
|
37
|
+
|
|
38
|
+
// The wrapper version reported to the native SDK via setWrapperConfig(). Read
|
|
39
|
+
// from package.json so it can never drift from the published npm version.
|
|
40
|
+
def wrapperVersion = new groovy.json.JsonSlurper()
|
|
41
|
+
.parseText(file("../package.json").text)
|
|
42
|
+
.version
|
|
43
|
+
|
|
44
|
+
repositories {
|
|
45
|
+
google()
|
|
46
|
+
mavenCentral()
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
android {
|
|
50
|
+
namespace "com.booleanmathsrnsdk"
|
|
51
|
+
|
|
52
|
+
compileSdkVersion getExtOrDefault("compileSdkVersion")
|
|
53
|
+
|
|
54
|
+
buildFeatures {
|
|
55
|
+
buildConfig true
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
defaultConfig {
|
|
59
|
+
minSdkVersion getExtOrDefault("minSdkVersion")
|
|
60
|
+
|
|
61
|
+
buildConfigField "String", "WRAPPER_TYPE", "\"react-native\""
|
|
62
|
+
buildConfigField "String", "WRAPPER_VERSION", "\"${wrapperVersion}\""
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
compileOptions {
|
|
66
|
+
sourceCompatibility JavaVersion.VERSION_17
|
|
67
|
+
targetCompatibility JavaVersion.VERSION_17
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
dependencies {
|
|
72
|
+
implementation "com.facebook.react:react-android"
|
|
73
|
+
|
|
74
|
+
// The native BooleanMaths Android SDK. `api` rather than `implementation` so
|
|
75
|
+
// apps that also want to call the native singleton directly (for example to
|
|
76
|
+
// initialize from Application.onCreate) can resolve it.
|
|
77
|
+
api "com.booleanmaths:bm-sdk:${getExtOrDefault('bmSdkVersion')}"
|
|
78
|
+
}
|