@molecule/app-analytics 1.0.2 → 1.0.3
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/LICENSE +111 -24
- package/README.md +84 -84
- package/package.json +4 -4
package/LICENSE
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
|
|
1
2
|
Apache License
|
|
2
3
|
Version 2.0, January 2004
|
|
3
4
|
http://www.apache.org/licenses/
|
|
@@ -34,21 +35,33 @@
|
|
|
34
35
|
|
|
35
36
|
"Work" shall mean the work of authorship, whether in Source or
|
|
36
37
|
Object form, made available under the License, as indicated by a
|
|
37
|
-
copyright notice that is included in or attached to the work
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
38
40
|
|
|
39
41
|
"Derivative Works" shall mean any work, whether in Source or Object
|
|
40
42
|
form, that is based on (or derived from) the Work and for which the
|
|
41
43
|
editorial revisions, annotations, elaborations, or other modifications
|
|
42
|
-
represent, as a whole, an original work of authorship.
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
49
62
|
|
|
50
63
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
51
|
-
on behalf of whom a Contribution has been received by
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
52
65
|
subsequently incorporated within the Work.
|
|
53
66
|
|
|
54
67
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
@@ -61,8 +74,18 @@
|
|
|
61
74
|
3. Grant of Patent License. Subject to the terms and conditions of
|
|
62
75
|
this License, each Contributor hereby grants to You a perpetual,
|
|
63
76
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
64
|
-
|
|
65
|
-
and otherwise transfer the Work
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
66
89
|
|
|
67
90
|
4. Redistribution. You may reproduce and distribute copies of the
|
|
68
91
|
Work or Derivative Works thereof in any medium, with or without
|
|
@@ -84,23 +107,87 @@
|
|
|
84
107
|
(d) If the Work includes a "NOTICE" text file as part of its
|
|
85
108
|
distribution, then any Derivative Works that You distribute must
|
|
86
109
|
include a readable copy of the attribution notices contained
|
|
87
|
-
within such NOTICE file
|
|
88
|
-
|
|
89
|
-
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
90
138
|
|
|
91
139
|
6. Trademarks. This License does not grant permission to use the trade
|
|
92
|
-
names, trademarks, service marks, or product names of the Licensor
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
93
143
|
|
|
94
144
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
95
|
-
agreed to in writing, Licensor provides the Work
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
104
191
|
|
|
105
192
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
106
193
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -3,20 +3,20 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
|
3
3
|
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
4
|
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
5
|
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
-
Generated: 2026-
|
|
6
|
+
Generated: 2026-10-16T23:32:42.497Z
|
|
7
7
|
-->
|
|
8
8
|
|
|
9
9
|
# @molecule/app-analytics
|
|
10
10
|
|
|
11
|
-
> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
|
|
12
|
-
> It is written to be read by coding agents as much as by people, and is generated from this
|
|
13
|
-
> package's source — edit `src/index.ts` JSDoc, not this file.
|
|
14
|
-
|
|
15
11
|
Frontend analytics interface for molecule.dev.
|
|
16
12
|
|
|
17
13
|
Provides a unified analytics API that can be backed by different
|
|
18
14
|
implementations (PostHog, Mixpanel, etc.).
|
|
19
15
|
|
|
16
|
+
> **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
|
|
17
|
+
> It is written to be read by coding agents as much as by people, and is generated from this
|
|
18
|
+
> package's source — edit `src/index.ts` JSDoc, not this file.
|
|
19
|
+
|
|
20
20
|
## Quick Start
|
|
21
21
|
|
|
22
22
|
```typescript
|
|
@@ -47,6 +47,43 @@ npm install @molecule/app-analytics @molecule/app-bond
|
|
|
47
47
|
|
|
48
48
|
### Interfaces
|
|
49
49
|
|
|
50
|
+
#### `AutoTrackingOptions`
|
|
51
|
+
|
|
52
|
+
Auto-tracking options. Pass any combination of sources — only provided
|
|
53
|
+
sources are tracked. Works for both web and mobile apps.
|
|
54
|
+
|
|
55
|
+
```typescript
|
|
56
|
+
interface AutoTrackingOptions {
|
|
57
|
+
/** Auth client for login/logout/register/error events. */
|
|
58
|
+
authClient?: AuthClientLike
|
|
59
|
+
/** Router for page view tracking. */
|
|
60
|
+
router?: RouterLike
|
|
61
|
+
/** HTTP client for error tracking. */
|
|
62
|
+
httpClient?: HttpClientLike
|
|
63
|
+
/** Lifecycle client for app foreground/background and deep link tracking. */
|
|
64
|
+
lifecycleClient?: LifecycleClientLike
|
|
65
|
+
/** Push client for notification received/tapped tracking. */
|
|
66
|
+
pushClient?: PushClientLike
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
#### `AnalyticsUserProps`
|
|
71
|
+
|
|
72
|
+
User properties for analytics identification.
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
interface AnalyticsUserProps {
|
|
76
|
+
/** Unique user identifier. */
|
|
77
|
+
userId: string
|
|
78
|
+
/** User email address. */
|
|
79
|
+
email?: string
|
|
80
|
+
/** User display name. */
|
|
81
|
+
name?: string
|
|
82
|
+
/** Arbitrary key-value traits to associate with the user. */
|
|
83
|
+
traits?: Record<string, unknown>
|
|
84
|
+
}
|
|
85
|
+
```
|
|
86
|
+
|
|
50
87
|
#### `AnalyticsEvent`
|
|
51
88
|
|
|
52
89
|
Event properties for analytics tracking.
|
|
@@ -148,54 +185,37 @@ interface AnalyticsProvider {
|
|
|
148
185
|
}
|
|
149
186
|
```
|
|
150
187
|
|
|
151
|
-
|
|
188
|
+
### Functions
|
|
152
189
|
|
|
153
|
-
|
|
190
|
+
#### `setupAutoTracking(options)`
|
|
154
191
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
userId: string
|
|
159
|
-
/** User email address. */
|
|
160
|
-
email?: string
|
|
161
|
-
/** User display name. */
|
|
162
|
-
name?: string
|
|
163
|
-
/** Arbitrary key-value traits to associate with the user. */
|
|
164
|
-
traits?: Record<string, unknown>
|
|
165
|
-
}
|
|
166
|
-
```
|
|
192
|
+
Sets up automatic analytics tracking for auth events, route changes,
|
|
193
|
+
HTTP errors, app lifecycle transitions, push notifications, and deep links.
|
|
194
|
+
Returns a cleanup function that removes all subscriptions.
|
|
167
195
|
|
|
168
|
-
|
|
196
|
+
Pass any combination of sources — only provided sources are tracked.
|
|
169
197
|
|
|
170
|
-
|
|
171
|
-
|
|
198
|
+
The analytics provider is resolved at EVENT time, not at setup time — so
|
|
199
|
+
`setupAutoTracking()` may safely run before the analytics bond is set
|
|
200
|
+
(events fired before bonding no-op; events fired after are tracked).
|
|
172
201
|
|
|
173
202
|
```typescript
|
|
174
|
-
|
|
175
|
-
/** Auth client for login/logout/register/error events. */
|
|
176
|
-
authClient?: AuthClientLike
|
|
177
|
-
/** Router for page view tracking. */
|
|
178
|
-
router?: RouterLike
|
|
179
|
-
/** HTTP client for error tracking. */
|
|
180
|
-
httpClient?: HttpClientLike
|
|
181
|
-
/** Lifecycle client for app foreground/background and deep link tracking. */
|
|
182
|
-
lifecycleClient?: LifecycleClientLike
|
|
183
|
-
/** Push client for notification received/tapped tracking. */
|
|
184
|
-
pushClient?: PushClientLike
|
|
185
|
-
}
|
|
203
|
+
function setupAutoTracking(options: AutoTrackingOptions): () => void
|
|
186
204
|
```
|
|
187
205
|
|
|
188
|
-
|
|
206
|
+
- `options` — Sources to auto-track.
|
|
189
207
|
|
|
190
|
-
|
|
208
|
+
**Returns:** A cleanup function that removes all event subscriptions.
|
|
191
209
|
|
|
192
|
-
|
|
210
|
+
#### `setProvider(provider)`
|
|
211
|
+
|
|
212
|
+
Registers an analytics provider as the active singleton.
|
|
193
213
|
|
|
194
214
|
```typescript
|
|
195
|
-
function
|
|
215
|
+
function setProvider(provider: AnalyticsProvider): void
|
|
196
216
|
```
|
|
197
217
|
|
|
198
|
-
|
|
218
|
+
- `provider` — The analytics provider implementation to bond.
|
|
199
219
|
|
|
200
220
|
#### `getProvider()`
|
|
201
221
|
|
|
@@ -208,19 +228,6 @@ function getProvider(): AnalyticsProvider
|
|
|
208
228
|
|
|
209
229
|
**Returns:** The bonded analytics provider, or a silent no-op fallback.
|
|
210
230
|
|
|
211
|
-
#### `group(groupId, traits)`
|
|
212
|
-
|
|
213
|
-
Associates the current user with a group/organization. Errors are silently ignored.
|
|
214
|
-
|
|
215
|
-
```typescript
|
|
216
|
-
function group(groupId: string, traits?: Record<string, unknown>): Promise<void>
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
- `groupId` — The group identifier.
|
|
220
|
-
- `traits` — Optional traits describing the group.
|
|
221
|
-
|
|
222
|
-
**Returns:** A promise that resolves when group association completes or fails silently.
|
|
223
|
-
|
|
224
231
|
#### `hasProvider()`
|
|
225
232
|
|
|
226
233
|
Checks whether an analytics provider is currently bonded.
|
|
@@ -243,69 +250,62 @@ function identify(user: AnalyticsUserProps): Promise<void>
|
|
|
243
250
|
|
|
244
251
|
**Returns:** A promise that resolves when identification completes or fails silently.
|
|
245
252
|
|
|
246
|
-
#### `
|
|
253
|
+
#### `track(event)`
|
|
247
254
|
|
|
248
|
-
Tracks a
|
|
255
|
+
Tracks a named event with optional properties. Errors are silently ignored.
|
|
249
256
|
|
|
250
257
|
```typescript
|
|
251
|
-
function
|
|
258
|
+
function track(event: AnalyticsEvent): Promise<void>
|
|
252
259
|
```
|
|
253
260
|
|
|
254
|
-
- `
|
|
261
|
+
- `event` — The event to track (name and optional properties).
|
|
255
262
|
|
|
256
|
-
**Returns:** A promise that resolves when
|
|
263
|
+
**Returns:** A promise that resolves when tracking completes or fails silently.
|
|
257
264
|
|
|
258
|
-
#### `
|
|
265
|
+
#### `page(pageView)`
|
|
259
266
|
|
|
260
|
-
|
|
267
|
+
Tracks a page view event. Errors are silently ignored.
|
|
261
268
|
|
|
262
269
|
```typescript
|
|
263
|
-
function
|
|
270
|
+
function page(pageView: AnalyticsPageView): Promise<void>
|
|
264
271
|
```
|
|
265
272
|
|
|
266
|
-
|
|
273
|
+
- `pageView` — The page view data (name, path, referrer, etc.).
|
|
267
274
|
|
|
268
|
-
|
|
275
|
+
**Returns:** A promise that resolves when page tracking completes or fails silently.
|
|
269
276
|
|
|
270
|
-
|
|
277
|
+
#### `group(groupId, traits)`
|
|
278
|
+
|
|
279
|
+
Associates the current user with a group/organization. Errors are silently ignored.
|
|
271
280
|
|
|
272
281
|
```typescript
|
|
273
|
-
function
|
|
282
|
+
function group(groupId: string, traits?: Record<string, unknown>): Promise<void>
|
|
274
283
|
```
|
|
275
284
|
|
|
276
|
-
- `
|
|
277
|
-
|
|
278
|
-
#### `setupAutoTracking(options)`
|
|
285
|
+
- `groupId` — The group identifier.
|
|
286
|
+
- `traits` — Optional traits describing the group.
|
|
279
287
|
|
|
280
|
-
|
|
281
|
-
HTTP errors, app lifecycle transitions, push notifications, and deep links.
|
|
282
|
-
Returns a cleanup function that removes all subscriptions.
|
|
288
|
+
**Returns:** A promise that resolves when group association completes or fails silently.
|
|
283
289
|
|
|
284
|
-
|
|
290
|
+
#### `reset()`
|
|
285
291
|
|
|
286
|
-
|
|
287
|
-
`setupAutoTracking()` may safely run before the analytics bond is set
|
|
288
|
-
(events fired before bonding no-op; events fired after are tracked).
|
|
292
|
+
Resets the analytics state (e.g. on logout). Errors are silently ignored.
|
|
289
293
|
|
|
290
294
|
```typescript
|
|
291
|
-
function
|
|
295
|
+
function reset(): Promise<void>
|
|
292
296
|
```
|
|
293
297
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
**Returns:** A cleanup function that removes all event subscriptions.
|
|
298
|
+
**Returns:** A promise that resolves when reset completes or fails silently.
|
|
297
299
|
|
|
298
|
-
#### `
|
|
300
|
+
#### `flush()`
|
|
299
301
|
|
|
300
|
-
|
|
302
|
+
Flushes any queued analytics events to the backend. Errors are silently ignored.
|
|
301
303
|
|
|
302
304
|
```typescript
|
|
303
|
-
function
|
|
305
|
+
function flush(): Promise<void>
|
|
304
306
|
```
|
|
305
307
|
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
**Returns:** A promise that resolves when tracking completes or fails silently.
|
|
308
|
+
**Returns:** A promise that resolves when flush completes or fails silently.
|
|
309
309
|
|
|
310
310
|
## Available Providers
|
|
311
311
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@molecule/app-analytics",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "Frontend analytics interface for molecule.dev",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -32,10 +32,10 @@
|
|
|
32
32
|
"@molecule/app-bond": "^1.0.1"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
|
-
"@molecule/app-bond": "1.0.
|
|
36
|
-
"@types/node": "26.
|
|
35
|
+
"@molecule/app-bond": "1.0.3",
|
|
36
|
+
"@types/node": "26.6.5",
|
|
37
37
|
"typescript": "6.0.3",
|
|
38
|
-
"vitest": "4.1.
|
|
38
|
+
"vitest": "4.1.12"
|
|
39
39
|
},
|
|
40
40
|
"repository": {
|
|
41
41
|
"type": "git",
|