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

package/src/AvoNetworkCallsHandler.ts

@@ -1,340 +0,0 @@
-import { AvoGuid } from "./AvoGuid";
-import { AvoInspector } from "./AvoInspector";
-import { AvoEncryption } from "./AvoEncryption";
-import { request } from "https";
-import { EventSpecMetadata, PropertyValidationResult } from "./eventSpec/AvoEventSpecFetchTypes";
-
-export interface BaseBody {
-  apiKey: string;
-  appName: string;
-  appVersion: string;
-  libVersion: string;
-  env: string;
-  libPlatform: "node";
-  messageId: string;
-  trackingId: string;
-  sessionId: string;
-  anonymousId: string;
-  createdAt: string;
-  samplingRate: number;
-  publicEncryptionKey?: string;
-}
-
-export interface EventPropertyEncrypted {
-  propertyName: string;
-  propertyType: string;
-  encryptedPropertyValue: string;
-  children?: any;
-}
-
-export interface EventPropertyPlain {
-  propertyName: string;
-  propertyType: string;
-  children?: any;
-}
-
-export interface EventPropertyValidation {
-  failedEventIds?: string[];
-  passedEventIds?: string[];
-}
-
-export type EventProperty = (EventPropertyEncrypted | EventPropertyPlain) & EventPropertyValidation;
-
-export interface EventSchemaBody extends BaseBody {
-  type: "event";
-  eventName: string;
-  eventProperties: Array<EventProperty>;
-  avoFunction: boolean;
-  eventId: string | null;
-  eventHash: string | null;
-  streamId?: string;
-  eventSpecMetadata?: EventSpecMetadata;
-}
-
-export type InspectorBody = EventSchemaBody;
-
-export class AvoNetworkCallsHandler {
-  private apiKey: string;
-  private envName: string;
-  private appName: string;
-  private appVersion: string;
-  private libVersion: string;
-  private samplingRate: number = 1.0;
-  private publicEncryptionKey?: string;
-
-  private static trackingEndpoint = "/inspector/v1/track";
-
-  constructor(
-    apiKey: string,
-    envName: string,
-    appName: string,
-    appVersion: string,
-    libVersion: string,
-    publicEncryptionKey?: string
-  ) {
-    this.apiKey = apiKey;
-    this.envName = envName;
-    this.appName = appName;
-    this.appVersion = appVersion;
-    this.libVersion = libVersion;
-    this.publicEncryptionKey = publicEncryptionKey;
-  }
-
-  callInspectorWithBatchBody(
-    inEvents: Array<InspectorBody>
-  ): Promise<void> {
-    const events = inEvents.filter((x) => x != null);
-
-    if (events.length === 0) {
-      return Promise.resolve();
-    }
-
-    if (Math.random() > this.samplingRate) {
-      if (AvoInspector.shouldLog) {
-        console.log(
-          "Avo Inspector: last event schema dropped due to sampling rate."
-        );
-      }
-      return Promise.resolve();
-    }
-
-    if (AvoInspector.shouldLog) {
-      events.forEach(function (event) {
-        const eventProps = event.eventProperties
-          .map(p => '\t"' + p.propertyName + '": "' + p.propertyType + '"')
-          .join(";\n");
-        const validated = event.eventSpecMetadata ? " (validated)" : "";
-        console.log(
-          "Avo Inspector: Sending event " +
-            event.eventName + validated +
-            " with schema {\n" + eventProps + "\n}"
-        );
-      });
-    }
-
-    return new Promise((resolve, reject) => {
-      const data = JSON.stringify(events);
-      const options = {
-        hostname: "api.avo.app",
-        port: 443,
-        path: AvoNetworkCallsHandler.trackingEndpoint,
-        method: "POST",
-        headers: {
-          "Accept": "application/json",
-          "Content-Type": "application/json",
-          "Content-Length": Buffer.byteLength(data),
-        },
-      };
-
-      if (AvoInspector.shouldLog) {
-        console.log("Avo Inspector: [network] POST https://" + options.hostname + options.path);
-        console.log("Avo Inspector: [network] Request body (" + Buffer.byteLength(data) + " bytes)");
-      }
-
-      const req = request(options, (res: any) => {
-        if (AvoInspector.shouldLog) {
-          console.log("Avo Inspector: [network] Response status: " + res.statusCode + " " + res.statusMessage);
-        }
-        const chunks: any = [];
-        res.on("data", (data: any) => chunks.push(data));
-        res.on("end", () => {
-          if (res.statusCode === 200) {
-            try {
-              const responseBody = Buffer.concat(chunks).toString();
-              const data = JSON.parse(responseBody);
-              if (typeof data.samplingRate === "number" && data.samplingRate >= 0 && data.samplingRate <= 1) {
-                this.samplingRate = data.samplingRate;
-              }
-            } catch (e) {
-              if (AvoInspector.shouldLog) {
-                console.warn("Avo Inspector: [network] Failed to parse response JSON: " + e);
-              }
-            }
-          } else if (AvoInspector.shouldLog) {
-            console.warn("Avo Inspector: [network] Non-200 response: " + res.statusCode);
-          }
-          resolve();
-        });
-      });
-      req.write(data);
-      req.setTimeout(10_000);
-      req.on("error", (err: any) => {
-        if (AvoInspector.shouldLog) {
-          console.error("Avo Inspector: [network] Request error: " + err);
-        }
-        reject("Request failed");
-      });
-      req.on("timeout", () => {
-        if (AvoInspector.shouldLog) {
-          console.error("Avo Inspector: [network] Request timed out after 10s");
-        }
-        req.destroy();
-        reject("Request timed out");
-      });
-      req.end();
-    });
-  }
-
-  bodyForEventSchemaCall(
-    anonymousId: string,
-    eventName: string,
-    eventProperties: Array<{
-      propertyName: string;
-      propertyType: string;
-      children?: any;
-    }>,
-    eventId: string | null,
-    eventHash: string | null,
-    rawEventProperties?: { [propName: string]: any }
-  ): EventSchemaBody {
-    let eventSchemaBody = this.createBaseCallBody(anonymousId) as EventSchemaBody;
-    eventSchemaBody.type = "event";
-    eventSchemaBody.eventName = eventName;
-
-    if (AvoEncryption.shouldEncrypt(this.envName, this.publicEncryptionKey) && rawEventProperties) {
-      eventSchemaBody.eventProperties = this.encryptProperties(eventProperties, rawEventProperties);
-    } else {
-      eventSchemaBody.eventProperties = eventProperties;
-    }
-
-    if (eventId != null) {
-      eventSchemaBody.avoFunction = true;
-      eventSchemaBody.eventId = eventId;
-      eventSchemaBody.eventHash = eventHash;
-    } else {
-      eventSchemaBody.avoFunction = false;
-      eventSchemaBody.eventId = null;
-      eventSchemaBody.eventHash = null;
-    }
-
-    return eventSchemaBody;
-  }
-
-  buildEventProperties(
-    eventProperties: Array<{
-      propertyName: string;
-      propertyType: string;
-      children?: any;
-    }>,
-    rawEventProperties?: { [propName: string]: any }
-  ): Array<EventProperty> {
-    if (AvoEncryption.shouldEncrypt(this.envName, this.publicEncryptionKey) && rawEventProperties) {
-      return this.encryptProperties(eventProperties, rawEventProperties);
-    }
-    return eventProperties;
-  }
-
-  bodyForValidatedEventSchemaCall(
-    anonymousId: string,
-    eventName: string,
-    eventProperties: Array<EventProperty>,
-    eventId: string | null,
-    eventHash: string | null,
-    eventSpecMetadata: EventSpecMetadata,
-    propertyResults: PropertyValidationResult[]
-  ): EventSchemaBody {
-    // Build a map of validation results by property name
-    const validationMap = new Map<string, PropertyValidationResult>();
-    for (const result of propertyResults) {
-      validationMap.set(result.propertyName, result);
-    }
-
-    // Merge validation results into eventProperties (matching Android)
-    const mergedProperties: Array<EventProperty> = eventProperties.map((prop) => {
-      const validation = validationMap.get(prop.propertyName);
-      if (validation) {
-        const merged: EventProperty = { ...prop };
-        if (validation.failedEventIds.length > 0) {
-          merged.failedEventIds = validation.failedEventIds;
-        }
-        if (validation.passedEventIds.length > 0) {
-          merged.passedEventIds = validation.passedEventIds;
-        }
-        return merged;
-      }
-      return prop;
-    });
-
-    let body = this.createBaseCallBody(anonymousId) as EventSchemaBody;
-    body.type = "event";
-    body.eventName = eventName;
-    body.eventProperties = mergedProperties;
-    body.streamId = anonymousId;
-    body.eventSpecMetadata = eventSpecMetadata;
-
-    if (eventId != null) {
-      body.avoFunction = true;
-      body.eventId = eventId;
-      body.eventHash = eventHash;
-    } else {
-      body.avoFunction = false;
-      body.eventId = null;
-      body.eventHash = null;
-    }
-
-    return body;
-  }
-
-  private encryptProperties(
-    properties: Array<{
-      propertyName: string;
-      propertyType: string;
-      children?: any;
-    }>,
-    rawEventProperties: { [propName: string]: any }
-  ): Array<EventProperty> {
-    const result: Array<EventProperty> = [];
-
-    for (const prop of properties) {
-      // List-type properties: omit entirely
-      if (AvoEncryption.isListType(prop.propertyType)) {
-        continue;
-      }
-
-      const rawValue = rawEventProperties[prop.propertyName];
-      const jsonValue = JSON.stringify(rawValue) ?? "null";
-
-      const encrypted = AvoEncryption.encryptValue(
-        jsonValue,
-        this.publicEncryptionKey!
-      );
-
-      if (encrypted === null) {
-        // Encryption failure: omit the property (warning already logged by encryptValue)
-        continue;
-      }
-
-      result.push({
-        propertyName: prop.propertyName,
-        propertyType: prop.propertyType,
-        encryptedPropertyValue: encrypted,
-        ...(prop.children !== undefined ? { children: prop.children } : {}),
-      });
-    }
-
-    return result;
-  }
-
-  private createBaseCallBody(anonymousId: string): BaseBody {
-    const body: BaseBody = {
-      apiKey: this.apiKey,
-      appName: this.appName,
-      appVersion: this.appVersion,
-      libVersion: this.libVersion,
-      env: this.envName,
-      libPlatform: "node",
-      messageId: AvoGuid.newGuid(),
-      trackingId: "",
-      sessionId: "",
-      anonymousId: anonymousId,
-      createdAt: new Date().toISOString(),
-      samplingRate: this.samplingRate,
-    };
-
-    if (this.publicEncryptionKey && this.publicEncryptionKey.length > 0) {
-      body.publicEncryptionKey = this.publicEncryptionKey;
-    }
-
-    return body;
-  }
-}

package/src/AvoSchemaParser.ts

@@ -1,115 +0,0 @@
-let isArray = (obj: any): boolean => {
-  return Object.prototype.toString.call(obj) === "[object Array]";
-};
-
-export class AvoSchemaParser {
-  static extractSchema(eventProperties: {
-    [propName: string]: any;
-  }): Array<{
-    propertyName: string;
-    propertyType: string;
-    children?: any;
-  }> {
-    if (eventProperties === null || eventProperties === undefined) {
-      return [];
-    }
-
-    let mapping = (object: any) => {
-      if (isArray(object)) {
-        let list = object.map((x: any) => {
-          return mapping(x);
-        });
-        return this.removeDuplicates(list);
-      } else if (typeof object === "object") {
-        let mappedResult: any = [];
-        for (var key in object) {
-          if (object.hasOwnProperty(key)) {
-            let val = object[key];
-
-            let mappedEntry: {
-              propertyName: string;
-              propertyType: string;
-              children?: any;
-            } = {
-              propertyName: key,
-              propertyType: this.getPropValueType(val),
-            };
-
-            if (typeof val === "object" && val != null) {
-              mappedEntry["children"] = mapping(val);
-            }
-
-            mappedResult.push(mappedEntry);
-          }
-        }
-
-        return mappedResult;
-      } else {
-        return this.getPropValueType(object);
-      }
-    };
-
-    var mappedEventProps = mapping(eventProperties);
-
-    return mappedEventProps;
-  }
-
-  private static removeDuplicates(array: Array<any>): Array<any> {
-    // XXX TODO fix any types
-    var primitives: any = { boolean: {}, number: {}, string: {} };
-    var objects: Array<any> = [];
-
-    return array.filter((item: any) => {
-      var type: string = typeof item;
-      if (type in primitives) {
-        return primitives[type].hasOwnProperty(item)
-          ? false
-          : (primitives[type][item] = true);
-      } else {
-        return objects.indexOf(item) >= 0 ? false : objects.push(item);
-      }
-    });
-  }
-
-
-  private static getBasicPropType(propValue: any): string {
-    let propType = typeof propValue;
-    if (propValue == null) {
-      return "null";
-    } else if (propType === "string") {
-      return "string";
-    } else if (propType === "number" || propType === "bigint") {
-      if ((propValue + "").indexOf(".") >= 0) {
-        return "float";
-      } else {
-        return "int";
-      }
-    } else if (propType === "boolean") {
-      return "boolean";
-    } else if (propType === "object") {
-      return "object"
-  }
-  else {
-  return "unknown";
-  }
-}
-
-  private static getPropValueType(propValue: any): string {
-    if (isArray(propValue)){
-
-      //we now know that propValue is an array. get first element in propValue array
-      let propElement = propValue[0];
-
-      if (propElement == null) {
-        return "list(string)"; // Default to list(string) if the list is empty.
-      }
-      else {
-      let propElementType = this.getBasicPropType(propElement);
-      return `list(${propElementType})`
-      }
-    }
-    else {
-      return this.getBasicPropType(propValue);
-    }
-  }
-}

package/src/AvoStreamId.ts

@@ -1,16 +0,0 @@
-export class AvoStreamId {
-  private _streamId: string;
-
-  constructor(streamId?: string) {
-    this._streamId = streamId ?? "";
-    if (this._streamId.includes(":")) {
-      console.warn(
-        "[Avo Inspector] Warning: streamId contains ':' which is not supported"
-      );
-    }
-  }
-
-  get streamId(): string {
-    return this._streamId;
-  }
-}