@litemetrics/core 0.1.0 → 0.1.1
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/README.md +40 -0
- package/dist/index.d.cts +4 -0
- package/dist/index.d.ts +4 -0
- package/package.json +10 -3
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @litemetrics/core
|
|
2
|
+
|
|
3
|
+
Shared types, interfaces, and constants for the Litemetrics analytics SDK.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @litemetrics/core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
This package is used internally by other Litemetrics packages. You typically don't need to install it directly.
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import type {
|
|
17
|
+
TrackerConfig,
|
|
18
|
+
CollectorConfig,
|
|
19
|
+
EnrichedEvent,
|
|
20
|
+
Site,
|
|
21
|
+
QueryParams,
|
|
22
|
+
QueryResult,
|
|
23
|
+
DBAdapter,
|
|
24
|
+
} from '@litemetrics/core';
|
|
25
|
+
|
|
26
|
+
import { DEFAULT_BATCH_SIZE, DEFAULT_FLUSH_INTERVAL } from '@litemetrics/core';
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## What's Included
|
|
30
|
+
|
|
31
|
+
- **Event Types** - `PageviewEvent`, `CustomEvent`, `IdentifyEvent`, `EnrichedEvent`
|
|
32
|
+
- **Config Types** - `TrackerConfig`, `CollectorConfig`, `DBConfig`, `CORSConfig`
|
|
33
|
+
- **Query Types** - `QueryParams`, `QueryResult`, `TimeSeriesParams`, `RetentionParams`
|
|
34
|
+
- **Site Types** - `Site`, `CreateSiteRequest`, `UpdateSiteRequest`
|
|
35
|
+
- **DB Adapter Interface** - `DBAdapter` for building custom database adapters
|
|
36
|
+
- **Constants** - Default batch sizes, flush intervals, session timeouts, storage keys
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
MIT
|
package/dist/index.d.cts
CHANGED
|
@@ -86,6 +86,10 @@ interface TrackerConfig {
|
|
|
86
86
|
endpoint: string;
|
|
87
87
|
autoTrack?: boolean;
|
|
88
88
|
autoSpa?: boolean;
|
|
89
|
+
autoOutbound?: boolean;
|
|
90
|
+
autoFileDownloads?: boolean;
|
|
91
|
+
autoScrollDepth?: boolean;
|
|
92
|
+
autoRageClicks?: boolean;
|
|
89
93
|
batchSize?: number;
|
|
90
94
|
flushInterval?: number;
|
|
91
95
|
respectDnt?: boolean;
|
package/dist/index.d.ts
CHANGED
|
@@ -86,6 +86,10 @@ interface TrackerConfig {
|
|
|
86
86
|
endpoint: string;
|
|
87
87
|
autoTrack?: boolean;
|
|
88
88
|
autoSpa?: boolean;
|
|
89
|
+
autoOutbound?: boolean;
|
|
90
|
+
autoFileDownloads?: boolean;
|
|
91
|
+
autoScrollDepth?: boolean;
|
|
92
|
+
autoRageClicks?: boolean;
|
|
89
93
|
batchSize?: number;
|
|
90
94
|
flushInterval?: number;
|
|
91
95
|
respectDnt?: boolean;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@litemetrics/core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Shared types and utilities for Litemetrics analytics SDK",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Metehan Kurucu",
|
|
@@ -9,7 +9,12 @@
|
|
|
9
9
|
"url": "https://github.com/metehankurucu/litemetrics",
|
|
10
10
|
"directory": "packages/core"
|
|
11
11
|
},
|
|
12
|
-
"keywords": [
|
|
12
|
+
"keywords": [
|
|
13
|
+
"analytics",
|
|
14
|
+
"tracking",
|
|
15
|
+
"litemetrics",
|
|
16
|
+
"types"
|
|
17
|
+
],
|
|
13
18
|
"type": "module",
|
|
14
19
|
"main": "./dist/index.cjs",
|
|
15
20
|
"module": "./dist/index.js",
|
|
@@ -21,7 +26,9 @@
|
|
|
21
26
|
"require": "./dist/index.cjs"
|
|
22
27
|
}
|
|
23
28
|
},
|
|
24
|
-
"files": [
|
|
29
|
+
"files": [
|
|
30
|
+
"dist"
|
|
31
|
+
],
|
|
25
32
|
"publishConfig": {
|
|
26
33
|
"access": "public"
|
|
27
34
|
},
|