@tracelog/lib 2.6.2 → 2.7.0-rc.95.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.
Files changed (12) hide show
  1. package/README.md +13 -5
  2. package/dist/browser/tracelog.esm.js +810 -634
  3. package/dist/browser/tracelog.esm.js.map +1 -1
  4. package/dist/browser/tracelog.js +1 -1
  5. package/dist/browser/tracelog.js.map +1 -1
  6. package/dist/public-api.cjs +2 -2
  7. package/dist/public-api.cjs.map +1 -1
  8. package/dist/public-api.d.mts +25 -5
  9. package/dist/public-api.d.ts +25 -5
  10. package/dist/public-api.js +2 -2
  11. package/dist/public-api.js.map +1 -1
  12. package/package.json +1 -1
package/README.md CHANGED
@@ -94,13 +94,19 @@ await tracelog.init({
94
94
  }
95
95
  });
96
96
 
97
- // 6. Track custom events (after init)
97
+ // 6. Identify user (after init, optional)
98
+ tracelog.identify('cust_123', { name: 'Maria Garcia', plan: 'pro' });
99
+
100
+ // 7. Track custom events (after init)
98
101
  tracelog.event('button_clicked', {
99
102
  buttonId: 'signup-cta',
100
103
  source: 'homepage'
101
104
  });
102
105
 
103
- // 7. Cleanup (on consent revoke or app unmount)
106
+ // 8. On logout: reset identity
107
+ await tracelog.resetIdentity();
108
+
109
+ // 9. Cleanup (on consent revoke or app unmount)
104
110
  tracelog.destroy();
105
111
  ```
106
112
 
@@ -130,6 +136,8 @@ tracelog.destroy();
130
136
  | `removeTransformer(hook)` | Remove a previously set transformer |
131
137
  | `setCustomHeaders(provider)` | Add custom HTTP headers to requests (see [Custom Headers](#custom-headers)) |
132
138
  | `removeCustomHeaders()` | Remove custom headers provider |
139
+ | `identify(userId, traits?)` | Associate visitor with a known user identity |
140
+ | `resetIdentity()` | Clear identity, regenerate UUID, start new session |
133
141
  | `isInitialized()` | Check initialization status |
134
142
  | `getSessionId()` | Get current session ID (or null) |
135
143
  | `setQaMode(enabled)` | Enable/disable QA mode (console logging) |
@@ -390,9 +398,9 @@ tracelog.mergeGlobalMetadata({
390
398
 
391
399
  ### Validation Rules
392
400
 
393
- - **Allowed Types**: Primitives (string, number, boolean), string arrays, nested objects (1 level deep)
394
- - **NOT Allowed**: Functions, symbols, undefined, deeply nested objects
395
- - **Limits**: Max 100 keys, 10KB serialized size, 500 items per array, 1000 chars per string
401
+ - **Allowed Types**: Primitives (string, number, boolean), string arrays, nested objects (up to 10 levels)
402
+ - **NOT Allowed**: Functions, symbols, undefined, circular references
403
+ - **Limits**: Max 100 keys, 48KB serialized size, 500 items per array, 1000 chars per string
396
404
 
397
405
  **→ [Metadata API Reference](./API_REFERENCE.md#global-metadata)**
398
406