node-avo-inspector 1.1.1 → 1.2.0

package/.claude/scheduled_tasks.lock

@@ -0,0 +1 @@
+{"sessionId":"807772ee-303b-4671-8556-d4549bdcb1c0","pid":8979,"acquiredAt":1774537920892}

package/.claude/settings.local.json

@@ -0,0 +1,11 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(grep -n \"propertyType\\\\|propertyName\\\\|encryptedPropertyValue\" /Users/alexverein/code/avo/android-avo-inspector/avoinspector/src/main/java/app/avo/inspector/*.java)",
+      "Bash(grep -n \"bodyForEventSchemaCall\\\\|bodyForValidatedEventSchemaCall\\\\|remapProperties\\\\|addEncryptedValues\" /Users/alexverein/code/avo/android-avo-inspector/avoinspector/src/main/java/app/avo/inspector/*.java)",
+      "Bash(npm ls:*)",
+      "Bash(find /Users/alexverein/code/avo/avo -name CONTRIBUTING* -o -name DEVELOPMENT* -o -name .env.example)",
+      "WebSearch"
+    ]
+  }
+}

package/.claude/worktrees/release-1.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Avo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/.claude/worktrees/release-1.1.1/README.md

@@ -0,0 +1,69 @@
+# Avo Inspector SDK for Node.js
+
+[![npm version](https://badge.fury.io/js/node-avo-inspector.svg)](https://badge.fury.io/js/node-avo-inspector)
+
+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).
+
+# Installation
+
+The library is distributed with npm, install with npm:
+```
+    npm i node-avo-inspector
+```
+
+or yarn:
+```
+    yarn add node-avo-inspector
+```
+
+# Initialization
+
+Obtain the API key from the Inspector tab (Inspector > Manage Sources) in your [Avo workspace](https://www.avo.app/welcome)
+
+```javascript
+import * as Inspector from "node-avo-inspector";
+
+let inspector = new Inspector.AvoInspector({
+  apiKey: "your api key",
+  env: Inspector.AvoInspectorEnv.Dev,
+  version: "1.0.0",
+  appName: "My app",
+});
+```
+
+# Integrating with Avo Codegen
+
+The setup is lightweight and is covered [in this guide](https://www.avo.app/docs/implementation/start-using-inspector-with-avo-functions).
+
+Every event sent with your Codegen after this integration will automatically be sent to Inspector.
+
+# Sending event schemas for events reported outside of Codegen
+
+Whenever you send tracking event call the following methods:
+
+Read more in the [Avo documentation](https://www.avo.app/docs/implementation/devs-101#inspecting-events)
+
+This method gets actual tracking event parameters, extracts schema automatically and sends it to the Inspector backend.
+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.
+
+```javascript
+inspector.trackSchemaFromEvent("Event name", {
+  "String Prop": "Prop Value",
+  "Float Prop": 1.0,
+  "Boolean Prop": true,
+});
+```
+
+# Enabling logs
+
+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:
+
+```javascript
+inspector.enableLogging(true | false);
+```
+
+## Author
+Avo (https://www.avo.app), hi@avo.app
+
+## License
+AvoInspector is available under the MIT license.

package/.claude/worktrees/release-1.1.1/examples/node-inspector-js/index.js

@@ -0,0 +1,30 @@
+const Inspector = require("node-avo-inspector");
+
+const inspector = new Inspector.AvoInspector({
+    apiKey: "My Api Key",
+    env: Inspector.AvoInspectorEnv.Prod,
+    version: "1.0.0",
+    appName: "My App"
+  });
+
+let eventName = "App Launched";
+let eventParams = {
+    "userId": "odsbet455d",
+    "isAdmin": true,
+    "answer": 42,
+    "pi": 3.14,
+    "void": null,
+    "shoppingList": ["Bread", "Butter", "Salt"],
+    "birthdayGift": {
+        "name": "pool",
+        "radius": 7,
+        "depth": 2.1
+    }
+}
+
+inspector.enableLogging(true) // default is true for dev and false for prod
+
+inspector.trackSchemaFromEvent(eventName, eventParams).then((eventSchema) => {
+    console.log("Event schema sent to Avo Inspector", eventSchema)
+})
+

package/.claude/worktrees/release-1.1.1/examples/node-inspector-js/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "node-inspector-js-example",
+  "version": "1.0.0",
+  "description": "example app for avo inspector on node",
+  "main": "index.js",
+  "private": true,
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Avo (https://www.avo.app)",
+  "license": "MIT",
+  "dependencies": {
+    "node-avo-inspector": "file:../../"
+  }
+}

package/.claude/worktrees/release-1.1.1/examples/node-inspector-js/yarn.lock

@@ -0,0 +1,6 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"node-avo-inspector@file:../..":
+  version "1.0.4-beta.0"

package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/dist/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Inspector = __importStar(require("node-avo-inspector"));
+const inspector = new Inspector.AvoInspector({
+    apiKey: "My Api Key",
+    env: Inspector.AvoInspectorEnv.Prod,
+    version: "1.0.0",
+    appName: "My App"
+});
+let eventName = "App Launched";
+let eventParams = {
+    "userId": "odsbet455d",
+    "isAdmin": true,
+    "answer": 42,
+    "pi": 3.14,
+    "void": null,
+    "shoppingList": ["Bread", "Butter", "Salt"],
+    "birthdayGift": {
+        "name": "pool",
+        "radius": 7,
+        "depth": 2.1
+    }
+};
+inspector.enableLogging(true); // default is true for dev and false for prod
+inspector.trackSchemaFromEvent(eventName, eventParams).then((eventSchema) => {
+    console.log("Event schema sent to Avo Inspector", eventSchema);
+});

package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/index.ts

@@ -0,0 +1,30 @@
+import * as Inspector from "node-avo-inspector";
+
+const inspector = new Inspector.AvoInspector({
+    apiKey: "My Api Key",
+    env: Inspector.AvoInspectorEnv.Prod,
+    version: "1.0.0",
+    appName: "My App"
+  });
+
+let eventName = "App Launched";
+let eventParams = {
+    "userId": "odsbet455d",
+    "isAdmin": true,
+    "answer": 42,
+    "pi": 3.14,
+    "void": null,
+    "shoppingList": ["Bread", "Butter", "Salt"],
+    "birthdayGift": {
+        "name": "pool",
+        "radius": 7,
+        "depth": 2.1
+    }
+}
+
+inspector.enableLogging(true) // default is true for dev and false for prod
+
+inspector.trackSchemaFromEvent(eventName, eventParams).then((eventSchema) => {
+    console.log("Event schema sent to Avo Inspector", eventSchema)
+})
+

package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "node-inspector-ts-example",
+  "version": "1.0.0",
+  "description": "example app for avo inspector on node",
+  "main": "index.ts",
+  "private": true,
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Avo (https://www.avo.app)",
+  "license": "MIT",
+  "dependencies": {
+    "node-avo-inspector": "file:../../"
+  },
+  "devDependencies": {
+    "typescript": "^4.1.2"
+  }
+}

package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/tsconfig.json

@@ -0,0 +1,15 @@
+{
+    "compilerOptions": {
+      "target": "ES2015",
+      "module": "commonjs",
+      "lib": [
+        "ES6"
+      ],
+      "outDir": "./dist",
+      "strict": true,
+      "esModuleInterop": true,
+      "skipLibCheck": true,
+      "forceConsistentCasingInFileNames": true
+    }
+  }
+  

package/.claude/worktrees/release-1.1.1/examples/node-inspector-ts/yarn.lock

@@ -0,0 +1,11 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"node-avo-inspector@file:../..":
+  version "0.1.0"
+
+typescript@^4.1.2:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.1.2.tgz#6369ef22516fe5e10304aae5a5c4862db55380e9"
+  integrity sha512-thGloWsGH3SOxv1SoY7QojKi0tc+8FnOmiarEGMbd/lar7QOEd3hvlx3Fp5y6FlDUGl9L+pd4n2e+oToGMmhRQ==