node-avo-inspector 1.2.0 → 2.0.0-beta.1

package/dist/__tests__/constants.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackingEndpoint = exports.type = exports.sessionTimeMs = exports.requestMsg = exports.networkCallType = exports.mockedReturns = exports.error = exports.defaultOptions = void 0;
-const AvoInspectorEnv_1 = require("../AvoInspectorEnv");
-const defaultOptions = {
-    apiKey: "api-key-xxx",
-    env: AvoInspectorEnv_1.AvoInspectorEnv.Dev,
-    version: "1",
-    shouldLog: true,
-    appName: "my-test-app",
-};
-exports.defaultOptions = defaultOptions;
-const error = {
-    API_KEY: "[Avo Inspector] No API key provided. Inspector can't operate without API key.",
-    VERSION: "[Avo Inspector] No version provided. Many features of Inspector rely on versioning. Please provide comparable string version, i.e. integer or semantic.",
-};
-exports.error = error;
-const mockedReturns = {
-    INSTALLATION_ID: "avo-instalation-id",
-    GUID: "generated-guid",
-    SESSION_ID: "session-id",
-};
-exports.mockedReturns = mockedReturns;
-const networkCallType = {
-    EVENT: "event",
-    SESSION_STARTED: "sessionStarted",
-};
-exports.networkCallType = networkCallType;
-const requestMsg = {
-    ERROR: "Request failed",
-    TIMEOUT: "Request timed out",
-};
-exports.requestMsg = requestMsg;
-const trackingEndpoint = "https://api.avo.app/inspector/v1/track";
-exports.trackingEndpoint = trackingEndpoint;
-const sessionTimeMs = 5 * 60 * 1000;
-exports.sessionTimeMs = sessionTimeMs;
-const type = {
-    STRING: "string",
-    STRINGLIST: "list(string)",
-    INT: "int",
-    INTLIST: "list(int)",
-    OBJECT: "object",
-    OBJECTLIST: "list(object)",
-    FLOAT: "float",
-    FLOATLIST: "list(float)",
-    BOOL: "boolean",
-    BOOLLIST: "list(boolean)",
-    NULL: "null",
-    UNKNOWN: "unknown",
-    UNKNOWNLIST: "list(unknown)",
-};
-exports.type = type;

package/examples/node-inspector-js/index.js

@@ -1,30 +0,0 @@
-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/examples/node-inspector-js/package.json

@@ -1,15 +0,0 @@
-{
-  "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/examples/node-inspector-js/yarn.lock

@@ -1,6 +0,0 @@
-# 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/examples/node-inspector-ts/dist/index.js

@@ -1,34 +0,0 @@
-"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/examples/node-inspector-ts/index.ts

@@ -1,30 +0,0 @@
-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/examples/node-inspector-ts/package.json

@@ -1,18 +0,0 @@
-{
-  "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/examples/node-inspector-ts/tsconfig.json

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

package/examples/node-inspector-ts/yarn.lock

@@ -1,11 +0,0 @@
-# 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==

package/reason/AvoInspector.rei

@@ -1,11 +0,0 @@
-type t; 
-
-type env = [
-  | `Dev
-  | `Staging
-  | `Prod
-];
-
-let make: (~apiKey: string, ~env: env, ~version: string, , ~appName: string, unit) => t;
-
-let trackSchemaFromEvent: t => string => Js.Json.t => Js.Promise.t(unit);

package/reason/NodeAvoInspector.re

@@ -1,27 +0,0 @@
-type t;
-
-[@bs.deriving jsConverter]
-type env = [
-  | [@bs.as "dev"] `Dev
-  | [@bs.as "staging"] `Staging
-  | [@bs.as "prod"] `Prod
-];
-
-[@bs.deriving abstract]
-type options = {
-  apiKey: string,
-  env: string,
-  version: string,
-  appName: string,
-};
-
-[@bs.new] [@bs.module "node-avo-inspector"]
-external make: options => t = "AvoInspector";
-
-let make = (~apiKey, ~env, ~version, ~appName, ()) => {
-  make(options(~apiKey, ~env=envToJs(env), ~version, ~appName));
-};
-
-[@bs.send]
-external trackSchemaFromEvent: (t, string, Js.Json.t) => Js.Promise.t(unit) =
-  "trackSchemaFromEvent";

package/src/AvoDeduplicator.ts

@@ -1,150 +0,0 @@
-import { deepEquals } from "./utils";
-
-export class AvoDeduplicator {
-  avoFunctionsEvents: { [time: number]: string } = {};
-  manualEvents: { [time: number]: string } = {};
-  private msToConsiderOld = 500;
-
-  // Keyed by streamId\0eventName to prevent cross-stream suppression on server
-  avoFunctionsEventsParams: {
-    [key: string]: { [propName: string]: any };
-  } = {};
-  manualEventsParams: { [key: string]: { [propName: string]: any } } = {};
-
-  private static dedupKey(eventName: string, streamId: string): string {
-    return streamId + "\0" + eventName;
-  }
-
-  shouldRegisterEvent(
-    eventName: string,
-    params: { [propName: string]: any },
-    fromAvoFunction: boolean,
-    streamId: string = ""
-  ): boolean {
-    this.clearOldEvents();
-
-    const key = AvoDeduplicator.dedupKey(eventName, streamId);
-
-    if (fromAvoFunction) {
-      this.avoFunctionsEvents[Date.now()] = key;
-      this.avoFunctionsEventsParams[key] = params;
-    } else {
-      this.manualEvents[Date.now()] = key;
-      this.manualEventsParams[key] = params;
-    }
-
-    let checkInAvoFunctions = !fromAvoFunction;
-
-    return !this.hasSameEventAs(key, params, checkInAvoFunctions);
-  }
-
-  private hasSameEventAs(
-    key: string,
-    params: { [propName: string]: any },
-    checkInAvoFunctions: boolean
-  ): boolean {
-    let result = false;
-
-    if (checkInAvoFunctions) {
-      if (
-        this.lookForEventIn(key, params, this.avoFunctionsEventsParams)
-      ) {
-        result = true;
-      }
-    } else {
-      if (this.lookForEventIn(key, params, this.manualEventsParams)) {
-        result = true;
-      }
-    }
-
-    if (result) {
-      delete this.avoFunctionsEventsParams[key];
-      delete this.manualEventsParams[key];
-    }
-
-    return result;
-  }
-
-  private lookForEventIn(
-    key: string,
-    params: { [propName: string]: any },
-    eventsStorage: { [key: string]: { [propName: string]: any } }
-  ): boolean {
-    if (eventsStorage.hasOwnProperty(key)) {
-      const otherParams = eventsStorage[key];
-      if (otherParams && deepEquals(params, otherParams)) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  hasSeenEventParams(
-    params: { [propName: string]: any },
-    checkInAvoFunctions: boolean
-  ) {
-    let result = false;
-
-    if (checkInAvoFunctions) {
-      if (this.lookForEventParamsIn(params, this.avoFunctionsEventsParams)) {
-        result = true;
-      }
-    } else {
-      if (this.lookForEventParamsIn(params, this.manualEventsParams)) {
-        result = true;
-      }
-    }
-
-    return result;
-  }
-
-  private lookForEventParamsIn(
-    params: { [propName: string]: any },
-    eventsStorage: { [eventName: string]: { [propName: string]: any } }
-  ): boolean {
-    for (const otherEventName in eventsStorage) {
-      if (eventsStorage.hasOwnProperty(otherEventName)) {
-        const otherParams = eventsStorage[otherEventName];
-        if (otherParams && deepEquals(params, otherParams)) {
-          return true;
-        }
-      }
-    }
-    return false;
-  }
-
-  private clearOldEvents() {
-    const now = Date.now();
-
-    for (const time in this.avoFunctionsEvents) {
-      if (this.avoFunctionsEvents.hasOwnProperty(time)) {
-        const timestamp = Number(time) || 0;
-        if (now - timestamp > this.msToConsiderOld) {
-          const key = this.avoFunctionsEvents[time];
-          delete this.avoFunctionsEvents[time];
-          delete this.avoFunctionsEventsParams[key];
-        }
-      }
-    }
-
-    for (const time in this.manualEvents) {
-      if (this.manualEvents.hasOwnProperty(time)) {
-        const timestamp = Number(time) || 0;
-        if (now - timestamp > this.msToConsiderOld) {
-          const key = this.manualEvents[time];
-          delete this.manualEvents[time];
-          delete this.manualEventsParams[key];
-        }
-      }
-    }
-  }
-
-  // used in tests
-  private _clearEvents() {
-    this.avoFunctionsEvents = {};
-    this.manualEvents = {};
-
-    this.avoFunctionsEventsParams = {};
-    this.manualEventsParams = {};
-  }
-}

package/src/AvoEncryption.ts

@@ -1,90 +0,0 @@
-import * as crypto from "crypto";
-
-export class AvoEncryption {
-  /**
-   * Determines whether encryption should be applied.
-   *
-   * Truth table:
-   *   dev + key    => true
-   *   staging + key => true
-   *   prod + key   => false
-   *   dev + null   => false
-   *   dev + ""     => false
-   */
-  static shouldEncrypt(
-    env: string,
-    publicEncryptionKey: string | undefined | null
-  ): boolean {
-    if (!publicEncryptionKey || publicEncryptionKey.length === 0) {
-      return false;
-    }
-    if (env === "prod") {
-      return false;
-    }
-    return true;
-  }
-
-  /**
-   * Returns true if the propertyType represents a list type (e.g. "list(string)").
-   */
-  static isListType(propertyType: string): boolean {
-    return propertyType.startsWith("list(");
-  }
-
-  /**
-   * Encrypts a string value using ECIES with prime256v1.
-   *
-   * Wire format: [0x00][65-byte ephemeral pubkey][16-byte IV][16-byte auth tag][ciphertext]
-   * Output is base64-encoded.
-   *
-   * Returns null on failure, logging a warning.
-   */
-  static encryptValue(
-    value: string,
-    recipientPubKeyHex: string
-  ): string | null {
-    try {
-      const recipientPubKey = Buffer.from(recipientPubKeyHex, "hex");
-
-      // Generate ephemeral key pair
-      const ecdh = crypto.createECDH("prime256v1");
-      ecdh.generateKeys();
-      const ephemeralPubKey = ecdh.getPublicKey(); // 65 bytes, uncompressed
-
-      // Compute shared secret (raw 32-byte X-coordinate)
-      const sharedSecret = ecdh.computeSecret(recipientPubKey);
-
-      // Derive AES key via SHA-256
-      const aesKey = crypto.createHash("sha256").update(sharedSecret).digest();
-
-      // Generate random 16-byte IV
-      const iv = crypto.randomBytes(16);
-
-      // Encrypt with AES-256-GCM
-      const cipher = crypto.createCipheriv("aes-256-gcm", aesKey, iv, {
-        authTagLength: 16,
-      });
-      const encrypted = Buffer.concat([
-        cipher.update(value, "utf8"),
-        cipher.final(),
-      ]);
-      const authTag = cipher.getAuthTag(); // 16 bytes
-
-      // Assemble wire format: [version][ephemeralPubKey][IV][authTag][ciphertext]
-      const wire = Buffer.concat([
-        Buffer.from([0x00]), // version byte
-        ephemeralPubKey, // 65 bytes
-        iv, // 16 bytes
-        authTag, // 16 bytes
-        encrypted, // variable length
-      ]);
-
-      return wire.toString("base64");
-    } catch (e) {
-      console.warn(
-        `[Avo Inspector] Warning: encryption failed for value, omitting property. ${e}`
-      );
-      return null;
-    }
-  }
-}

package/src/AvoGuid.ts

@@ -1,9 +0,0 @@
-export class AvoGuid {
-  static newGuid(): string {
-    return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
-      var r = (Math.random() * 16) | 0,
-        v = c == "x" ? r : (r & 0x3) | 0x8;
-      return v.toString(16);
-    });
-  }
-}