node-avo-inspector 1.2.0 → 2.0.0-beta.2
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/CHANGELOG.md +46 -0
- package/README.md +270 -4
- package/dist/AvoBatchQueue.d.ts +73 -0
- package/dist/AvoBatchQueue.js +239 -0
- package/dist/AvoDeduplicator.d.ts +15 -6
- package/dist/AvoDeduplicator.js +46 -24
- package/dist/AvoInspector.d.ts +136 -23
- package/dist/AvoInspector.js +777 -109
- package/dist/AvoInspectorVersion.d.ts +3 -0
- package/dist/AvoInspectorVersion.js +10 -0
- package/dist/AvoLog.d.ts +52 -0
- package/dist/AvoLog.js +246 -0
- package/dist/AvoNetworkCallsHandler.d.ts +55 -8
- package/dist/AvoNetworkCallsHandler.js +266 -92
- package/dist/AvoSchemaParser.d.ts +6 -0
- package/dist/AvoSchemaParser.js +138 -33
- package/dist/AvoStreamId.d.ts +2 -1
- package/dist/AvoStreamId.js +21 -2
- package/dist/eventSpec/AvoEventSpecCache.d.ts +28 -5
- package/dist/eventSpec/AvoEventSpecCache.js +66 -11
- package/dist/eventSpec/AvoEventSpecFetchTypes.d.ts +50 -18
- package/dist/eventSpec/AvoEventSpecFetcher.d.ts +29 -6
- package/dist/eventSpec/AvoEventSpecFetcher.js +279 -69
- package/dist/eventSpec/EventValidator.d.ts +16 -10
- package/dist/eventSpec/EventValidator.js +351 -38
- package/dist/index.d.ts +2 -0
- package/dist/index.js +4 -1
- package/dist/utils.d.ts +29 -1
- package/dist/utils.js +86 -10
- package/package.json +18 -1
- package/.claude/scheduled_tasks.lock +0 -1
- package/.claude/settings.local.json +0 -11
- package/.claude/worktrees/release-1.1.1/LICENSE +0 -21
- package/.claude/worktrees/release-1.1.1/README.md +0 -69
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-js/index.js +0 -30
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-js/package.json +0 -15
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-js/yarn.lock +0 -6
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/dist/index.js +0 -34
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/index.ts +0 -30
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/package.json +0 -18
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/tsconfig.json +0 -15
- package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/yarn.lock +0 -11
- package/.claude/worktrees/release-1.1.1/package-lock.json +0 -4039
- package/.claude/worktrees/release-1.1.1/package.json +0 -48
- package/.claude/worktrees/release-1.1.1/reason/AvoInspector.rei +0 -11
- package/.claude/worktrees/release-1.1.1/reason/NodeAvoInspector.re +0 -27
- package/.claude/worktrees/release-1.1.1/src/AvoDeduplicator.ts +0 -146
- package/.claude/worktrees/release-1.1.1/src/AvoEncryption.ts +0 -90
- package/.claude/worktrees/release-1.1.1/src/AvoGuid.ts +0 -9
- package/.claude/worktrees/release-1.1.1/src/AvoInspector.ts +0 -383
- package/.claude/worktrees/release-1.1.1/src/AvoInspectorEnv.ts +0 -8
- package/.claude/worktrees/release-1.1.1/src/AvoNetworkCallsHandler.ts +0 -267
- package/.claude/worktrees/release-1.1.1/src/AvoSchemaParser.ts +0 -115
- package/.claude/worktrees/release-1.1.1/src/AvoStreamId.ts +0 -16
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestAvoEncryption.ts +0 -515
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestAvoEventSpecCache.ts +0 -242
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestAvoEventSpecFetcher.ts +0 -241
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestAvoInspector.ts +0 -360
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestAvoStreamId.ts +0 -72
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestDeduplicator.ts +0 -191
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestEventValidator.ts +0 -231
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestNetworkCallsHandler.ts +0 -179
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestNetworkCallsHandlerPublic.ts +0 -208
- package/.claude/worktrees/release-1.1.1/src/__tests__/TestParsing.ts +0 -153
- package/.claude/worktrees/release-1.1.1/src/__tests__/constants.ts +0 -63
- package/.claude/worktrees/release-1.1.1/src/eventSpec/AvoEventSpecCache.ts +0 -109
- package/.claude/worktrees/release-1.1.1/src/eventSpec/AvoEventSpecFetchTypes.ts +0 -47
- package/.claude/worktrees/release-1.1.1/src/eventSpec/AvoEventSpecFetcher.ts +0 -106
- package/.claude/worktrees/release-1.1.1/src/eventSpec/EventValidator.ts +0 -74
- package/.claude/worktrees/release-1.1.1/src/index.ts +0 -2
- package/.claude/worktrees/release-1.1.1/src/utils.ts +0 -49
- package/.claude/worktrees/release-1.1.1/tsconfig.json +0 -13
- package/.claude/worktrees/release-1.1.1/yarn.lock +0 -2310
- package/.github/workflows/claude.yml +0 -55
- package/dist/__tests__/TestAvoEncryption.d.ts +0 -1
- package/dist/__tests__/TestAvoEncryption.js +0 -288
- package/dist/__tests__/TestAvoEventSpecCache.d.ts +0 -1
- package/dist/__tests__/TestAvoEventSpecCache.js +0 -194
- package/dist/__tests__/TestAvoEventSpecFetcher.d.ts +0 -1
- package/dist/__tests__/TestAvoEventSpecFetcher.js +0 -219
- package/dist/__tests__/TestAvoInspector.d.ts +0 -1
- package/dist/__tests__/TestAvoInspector.js +0 -291
- package/dist/__tests__/TestAvoStreamId.d.ts +0 -1
- package/dist/__tests__/TestAvoStreamId.js +0 -55
- package/dist/__tests__/TestDeduplicator.d.ts +0 -1
- package/dist/__tests__/TestDeduplicator.js +0 -102
- package/dist/__tests__/TestEventValidator.d.ts +0 -1
- package/dist/__tests__/TestEventValidator.js +0 -196
- package/dist/__tests__/TestNetworkCallsHandler.d.ts +0 -1
- package/dist/__tests__/TestNetworkCallsHandler.js +0 -86
- package/dist/__tests__/TestNetworkCallsHandlerPublic.d.ts +0 -1
- package/dist/__tests__/TestNetworkCallsHandlerPublic.js +0 -160
- package/dist/__tests__/TestParsing.d.ts +0 -1
- package/dist/__tests__/TestParsing.js +0 -128
- package/dist/__tests__/constants.d.ts +0 -42
- package/dist/__tests__/constants.js +0 -53
- package/examples/node-inspector-js/index.js +0 -30
- package/examples/node-inspector-js/package.json +0 -15
- package/examples/node-inspector-js/yarn.lock +0 -6
- package/examples/node-inspector-ts/dist/index.js +0 -34
- package/examples/node-inspector-ts/index.ts +0 -30
- package/examples/node-inspector-ts/package.json +0 -18
- package/examples/node-inspector-ts/tsconfig.json +0 -15
- package/examples/node-inspector-ts/yarn.lock +0 -11
- package/reason/AvoInspector.rei +0 -11
- package/reason/NodeAvoInspector.re +0 -27
- package/src/AvoDeduplicator.ts +0 -150
- package/src/AvoEncryption.ts +0 -90
- package/src/AvoGuid.ts +0 -9
- package/src/AvoInspector.ts +0 -498
- package/src/AvoInspectorEnv.ts +0 -8
- package/src/AvoNetworkCallsHandler.ts +0 -340
- package/src/AvoSchemaParser.ts +0 -115
- package/src/AvoStreamId.ts +0 -16
- package/src/__tests__/TestAvoEncryption.ts +0 -515
- package/src/__tests__/TestAvoEventSpecCache.ts +0 -242
- package/src/__tests__/TestAvoEventSpecFetcher.ts +0 -279
- package/src/__tests__/TestAvoInspector.ts +0 -376
- package/src/__tests__/TestAvoStreamId.ts +0 -72
- package/src/__tests__/TestDeduplicator.ts +0 -191
- package/src/__tests__/TestEventValidator.ts +0 -231
- package/src/__tests__/TestNetworkCallsHandler.ts +0 -181
- package/src/__tests__/TestNetworkCallsHandlerPublic.ts +0 -208
- package/src/__tests__/TestParsing.ts +0 -153
- package/src/__tests__/constants.ts +0 -63
- package/src/eventSpec/AvoEventSpecCache.ts +0 -119
- package/src/eventSpec/AvoEventSpecFetchTypes.ts +0 -47
- package/src/eventSpec/AvoEventSpecFetcher.ts +0 -186
- package/src/eventSpec/EventValidator.ts +0 -74
- package/src/index.ts +0 -2
- package/src/utils.ts +0 -49
- package/tsconfig.json +0 -13
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
# Avo Inspector SDK for Node.js
|
|
2
|
-
|
|
3
|
-
[](https://badge.fury.io/js/node-avo-inspector)
|
|
4
|
-
|
|
5
|
-
This is a quick start guide. For more information about the Inspector project please read the [Inspector SDK Reference](https://www.avo.app/docs/implementation/avo-inspector-sdk-reference) and the [Inspector Setup Guide](https://www.avo.app/docs/implementation/setup-inspector-sdk).
|
|
6
|
-
|
|
7
|
-
# Installation
|
|
8
|
-
|
|
9
|
-
The library is distributed with npm, install with npm:
|
|
10
|
-
```
|
|
11
|
-
npm i node-avo-inspector
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
or yarn:
|
|
15
|
-
```
|
|
16
|
-
yarn add node-avo-inspector
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
# Initialization
|
|
20
|
-
|
|
21
|
-
Obtain the API key from the Inspector tab (Inspector > Manage Sources) in your [Avo workspace](https://www.avo.app/welcome)
|
|
22
|
-
|
|
23
|
-
```javascript
|
|
24
|
-
import * as Inspector from "node-avo-inspector";
|
|
25
|
-
|
|
26
|
-
let inspector = new Inspector.AvoInspector({
|
|
27
|
-
apiKey: "your api key",
|
|
28
|
-
env: Inspector.AvoInspectorEnv.Dev,
|
|
29
|
-
version: "1.0.0",
|
|
30
|
-
appName: "My app",
|
|
31
|
-
});
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
# Integrating with Avo Codegen
|
|
35
|
-
|
|
36
|
-
The setup is lightweight and is covered [in this guide](https://www.avo.app/docs/implementation/start-using-inspector-with-avo-functions).
|
|
37
|
-
|
|
38
|
-
Every event sent with your Codegen after this integration will automatically be sent to Inspector.
|
|
39
|
-
|
|
40
|
-
# Sending event schemas for events reported outside of Codegen
|
|
41
|
-
|
|
42
|
-
Whenever you send tracking event call the following methods:
|
|
43
|
-
|
|
44
|
-
Read more in the [Avo documentation](https://www.avo.app/docs/implementation/devs-101#inspecting-events)
|
|
45
|
-
|
|
46
|
-
This method gets actual tracking event parameters, extracts schema automatically and sends it to the Inspector backend.
|
|
47
|
-
It is the easiest way to use the library, just call this method at the same place you call your analytics tools' track methods with the same parameters.
|
|
48
|
-
|
|
49
|
-
```javascript
|
|
50
|
-
inspector.trackSchemaFromEvent("Event name", {
|
|
51
|
-
"String Prop": "Prop Value",
|
|
52
|
-
"Float Prop": 1.0,
|
|
53
|
-
"Boolean Prop": true,
|
|
54
|
-
});
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
# Enabling logs
|
|
58
|
-
|
|
59
|
-
Logs are enabled by default in the dev mode and disabled in prod mode. You can enable and disable logs by calling the `enableLogging` method:
|
|
60
|
-
|
|
61
|
-
```javascript
|
|
62
|
-
inspector.enableLogging(true | false);
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
## Author
|
|
66
|
-
Avo (https://www.avo.app), hi@avo.app
|
|
67
|
-
|
|
68
|
-
## License
|
|
69
|
-
AvoInspector is available under the MIT license.
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
const Inspector = require("node-avo-inspector");
|
|
2
|
-
|
|
3
|
-
const inspector = new Inspector.AvoInspector({
|
|
4
|
-
apiKey: "My Api Key",
|
|
5
|
-
env: Inspector.AvoInspectorEnv.Prod,
|
|
6
|
-
version: "1.0.0",
|
|
7
|
-
appName: "My App"
|
|
8
|
-
});
|
|
9
|
-
|
|
10
|
-
let eventName = "App Launched";
|
|
11
|
-
let eventParams = {
|
|
12
|
-
"userId": "odsbet455d",
|
|
13
|
-
"isAdmin": true,
|
|
14
|
-
"answer": 42,
|
|
15
|
-
"pi": 3.14,
|
|
16
|
-
"void": null,
|
|
17
|
-
"shoppingList": ["Bread", "Butter", "Salt"],
|
|
18
|
-
"birthdayGift": {
|
|
19
|
-
"name": "pool",
|
|
20
|
-
"radius": 7,
|
|
21
|
-
"depth": 2.1
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
inspector.enableLogging(true) // default is true for dev and false for prod
|
|
26
|
-
|
|
27
|
-
inspector.trackSchemaFromEvent(eventName, eventParams).then((eventSchema) => {
|
|
28
|
-
console.log("Event schema sent to Avo Inspector", eventSchema)
|
|
29
|
-
})
|
|
30
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "node-inspector-js-example",
|
|
3
|
-
"version": "1.0.0",
|
|
4
|
-
"description": "example app for avo inspector on node",
|
|
5
|
-
"main": "index.js",
|
|
6
|
-
"private": true,
|
|
7
|
-
"scripts": {
|
|
8
|
-
"test": "echo \"Error: no test specified\" && exit 1"
|
|
9
|
-
},
|
|
10
|
-
"author": "Avo (https://www.avo.app)",
|
|
11
|
-
"license": "MIT",
|
|
12
|
-
"dependencies": {
|
|
13
|
-
"node-avo-inspector": "file:../../"
|
|
14
|
-
}
|
|
15
|
-
}
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importStar = (this && this.__importStar) || function (mod) {
|
|
3
|
-
if (mod && mod.__esModule) return mod;
|
|
4
|
-
var result = {};
|
|
5
|
-
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
|
|
6
|
-
result["default"] = mod;
|
|
7
|
-
return result;
|
|
8
|
-
};
|
|
9
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
10
|
-
const Inspector = __importStar(require("node-avo-inspector"));
|
|
11
|
-
const inspector = new Inspector.AvoInspector({
|
|
12
|
-
apiKey: "My Api Key",
|
|
13
|
-
env: Inspector.AvoInspectorEnv.Prod,
|
|
14
|
-
version: "1.0.0",
|
|
15
|
-
appName: "My App"
|
|
16
|
-
});
|
|
17
|
-
let eventName = "App Launched";
|
|
18
|
-
let eventParams = {
|
|
19
|
-
"userId": "odsbet455d",
|
|
20
|
-
"isAdmin": true,
|
|
21
|
-
"answer": 42,
|
|
22
|
-
"pi": 3.14,
|
|
23
|
-
"void": null,
|
|
24
|
-
"shoppingList": ["Bread", "Butter", "Salt"],
|
|
25
|
-
"birthdayGift": {
|
|
26
|
-
"name": "pool",
|
|
27
|
-
"radius": 7,
|
|
28
|
-
"depth": 2.1
|
|
29
|
-
}
|
|
30
|
-
};
|
|
31
|
-
inspector.enableLogging(true); // default is true for dev and false for prod
|
|
32
|
-
inspector.trackSchemaFromEvent(eventName, eventParams).then((eventSchema) => {
|
|
33
|
-
console.log("Event schema sent to Avo Inspector", eventSchema);
|
|
34
|
-
});
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import * as Inspector from "node-avo-inspector";
|
|
2
|
-
|
|
3
|
-
const inspector = new Inspector.AvoInspector({
|
|
4
|
-
apiKey: "My Api Key",
|
|
5
|
-
env: Inspector.AvoInspectorEnv.Prod,
|
|
6
|
-
version: "1.0.0",
|
|
7
|
-
appName: "My App"
|
|
8
|
-
});
|
|
9
|
-
|
|
10
|
-
let eventName = "App Launched";
|
|
11
|
-
let eventParams = {
|
|
12
|
-
"userId": "odsbet455d",
|
|
13
|
-
"isAdmin": true,
|
|
14
|
-
"answer": 42,
|
|
15
|
-
"pi": 3.14,
|
|
16
|
-
"void": null,
|
|
17
|
-
"shoppingList": ["Bread", "Butter", "Salt"],
|
|
18
|
-
"birthdayGift": {
|
|
19
|
-
"name": "pool",
|
|
20
|
-
"radius": 7,
|
|
21
|
-
"depth": 2.1
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
inspector.enableLogging(true) // default is true for dev and false for prod
|
|
26
|
-
|
|
27
|
-
inspector.trackSchemaFromEvent(eventName, eventParams).then((eventSchema) => {
|
|
28
|
-
console.log("Event schema sent to Avo Inspector", eventSchema)
|
|
29
|
-
})
|
|
30
|
-
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "node-inspector-ts-example",
|
|
3
|
-
"version": "1.0.0",
|
|
4
|
-
"description": "example app for avo inspector on node",
|
|
5
|
-
"main": "index.ts",
|
|
6
|
-
"private": true,
|
|
7
|
-
"scripts": {
|
|
8
|
-
"test": "echo \"Error: no test specified\" && exit 1"
|
|
9
|
-
},
|
|
10
|
-
"author": "Avo (https://www.avo.app)",
|
|
11
|
-
"license": "MIT",
|
|
12
|
-
"dependencies": {
|
|
13
|
-
"node-avo-inspector": "file:../../"
|
|
14
|
-
},
|
|
15
|
-
"devDependencies": {
|
|
16
|
-
"typescript": "^4.1.2"
|
|
17
|
-
}
|
|
18
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
|
|
2
|
-
# yarn lockfile v1
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
"node-avo-inspector@file:../..":
|
|
6
|
-
version "0.1.0"
|
|
7
|
-
|
|
8
|
-
typescript@^4.1.2:
|
|
9
|
-
version "4.1.2"
|
|
10
|
-
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.1.2.tgz#6369ef22516fe5e10304aae5a5c4862db55380e9"
|
|
11
|
-
integrity sha512-thGloWsGH3SOxv1SoY7QojKi0tc+8FnOmiarEGMbd/lar7QOEd3hvlx3Fp5y6FlDUGl9L+pd4n2e+oToGMmhRQ==
|