avo-inspector 2.1.0 → 2.2.0

package/dist-native/AvoInspector.js

@@ -1,220 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvoInspector = void 0;
-var AvoInspectorEnv_1 = require("./AvoInspectorEnv");
-var AvoSchemaParser_1 = require("./AvoSchemaParser");
-var AvoSessionTracker_1 = require("./AvoSessionTracker");
-var AvoBatcher_1 = require("./AvoBatcher");
-var AvoNetworkCallsHandler_1 = require("./AvoNetworkCallsHandler");
-var AvoStorage_1 = require("./AvoStorage");
-var AvoDeduplicator_1 = require("./AvoDeduplicator");
-var utils_1 = require("./utils");
-var libVersion = require("../package.json").version;
-var AvoInspector = /** @class */ (function () {
-    // constructor(apiKey: string, env: AvoInspectorEnv, version: string) {
-    function AvoInspector(options) {
-        var _this = this;
-        // the constructor does aggressive null/undefined checking because same code paths will be accessible from JS
-        if ((0, utils_1.isValueEmpty)(options.env)) {
-            this.environment = AvoInspectorEnv_1.AvoInspectorEnv.Dev;
-            console.warn("[Avo Inspector] No environment provided. Defaulting to dev.");
-        }
-        else if (Object.values(AvoInspectorEnv_1.AvoInspectorEnv).indexOf(options.env) === -1) {
-            this.environment = AvoInspectorEnv_1.AvoInspectorEnv.Dev;
-            console.warn("[Avo Inspector] Unsupported environment provided. Defaulting to dev. Supported environments - Dev, Staging, Prod.");
-        }
-        else {
-            this.environment = options.env;
-        }
-        if ((0, utils_1.isValueEmpty)(options.apiKey)) {
-            throw new Error("[Avo Inspector] No API key provided. Inspector can't operate without API key.");
-        }
-        else {
-            this.apiKey = options.apiKey;
-        }
-        if ((0, utils_1.isValueEmpty)(options.version)) {
-            throw new Error("[Avo Inspector] No version provided. Many features of Inspector rely on versioning. Please provide comparable string version, i.e. integer or semantic.");
-        }
-        else {
-            this.version = options.version;
-        }
-        if (this.environment === AvoInspectorEnv_1.AvoInspectorEnv.Dev) {
-            AvoInspector._batchSize = 1;
-            AvoInspector._shouldLog = true;
-        }
-        else {
-            AvoInspector._batchSize = 30;
-            AvoInspector._batchFlushSeconds = 30;
-            AvoInspector._shouldLog = false;
-        }
-        AvoInspector.avoStorage = new AvoStorage_1.AvoStorage(AvoInspector._shouldLog);
-        var avoNetworkCallsHandler = new AvoNetworkCallsHandler_1.AvoNetworkCallsHandler(this.apiKey, this.environment.toString(), options.appName || "", this.version, libVersion);
-        this.avoBatcher = new AvoBatcher_1.AvoBatcher(avoNetworkCallsHandler);
-        this.sessionTracker = new AvoSessionTracker_1.AvoSessionTracker(this.avoBatcher);
-        this.avoDeduplicator = new AvoDeduplicator_1.AvoDeduplicator();
-        try {
-            if (process.env.BROWSER) {
-                // XXX make node/browser split clearer
-                if (typeof window !== "undefined") {
-                    window.addEventListener("load", function () {
-                        _this.sessionTracker.startOrProlongSession(Date.now());
-                    }, false);
-                }
-            }
-            else {
-                this.sessionTracker.startOrProlongSession(Date.now());
-            }
-        }
-        catch (e) {
-            console.error("Avo Inspector: something went wrong. Please report to support@avo.app.", e);
-        }
-    }
-    Object.defineProperty(AvoInspector, "batchSize", {
-        get: function () {
-            return this._batchSize;
-        },
-        set: function (newSize) {
-            if (newSize < 1) {
-                this._batchSize = 1;
-            }
-            else {
-                this._batchSize = newSize;
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(AvoInspector, "batchFlushSeconds", {
-        get: function () {
-            return this._batchFlushSeconds;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(AvoInspector, "shouldLog", {
-        get: function () {
-            return this._shouldLog;
-        },
-        set: function (enable) {
-            this._shouldLog = enable;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    AvoInspector.prototype.trackSchemaFromEvent = function (eventName, eventProperties) {
-        try {
-            if (this.avoDeduplicator.shouldRegisterEvent(eventName, eventProperties, false)) {
-                if (AvoInspector.shouldLog) {
-                    console.log("Avo Inspector: supplied event " +
-                        eventName +
-                        " with params " +
-                        JSON.stringify(eventProperties));
-                }
-                var eventSchema = this.extractSchema(eventProperties, false);
-                this.trackSchemaInternal(eventName, eventSchema, null, null);
-                return eventSchema;
-            }
-            else {
-                if (AvoInspector.shouldLog) {
-                    console.log("Avo Inspector: Deduplicated event: " + eventName);
-                }
-                return [];
-            }
-        }
-        catch (e) {
-            console.error("Avo Inspector: something went wrong. Please report to support@avo.app.", e);
-            return [];
-        }
-    };
-    AvoInspector.prototype._avoFunctionTrackSchemaFromEvent = function (eventName, eventProperties, eventId, eventHash) {
-        try {
-            if (this.avoDeduplicator.shouldRegisterEvent(eventName, eventProperties, true)) {
-                if (AvoInspector.shouldLog) {
-                    console.log("Avo Inspector: supplied event " +
-                        eventName +
-                        " with params " +
-                        JSON.stringify(eventProperties));
-                }
-                var eventSchema = this.extractSchema(eventProperties, false);
-                this.trackSchemaInternal(eventName, eventSchema, eventId, eventHash);
-                return eventSchema;
-            }
-            else {
-                if (AvoInspector.shouldLog) {
-                    console.log("Avo Inspector: Deduplicated event: " + eventName);
-                }
-                return [];
-            }
-        }
-        catch (e) {
-            console.error("Avo Inspector: something went wrong. Please report to support@avo.app.", e);
-            return [];
-        }
-    };
-    AvoInspector.prototype.trackSchema = function (eventName, eventSchema) {
-        try {
-            if (this.avoDeduplicator.shouldRegisterSchemaFromManually(eventName, eventSchema)) {
-                if (AvoInspector.shouldLog) {
-                    console.log("Avo Inspector: supplied event " +
-                        eventName +
-                        " with schema " +
-                        JSON.stringify(eventSchema));
-                }
-                this.trackSchemaInternal(eventName, eventSchema, null, null);
-            }
-            else {
-                if (AvoInspector.shouldLog) {
-                    console.log("Avo Inspector: Deduplicated event: " + eventName);
-                }
-            }
-        }
-        catch (e) {
-            console.error("Avo Inspector: something went wrong. Please report to support@avo.app.", e);
-        }
-    };
-    AvoInspector.prototype.trackSchemaInternal = function (eventName, eventSchema, eventId, eventHash) {
-        try {
-            this.sessionTracker.startOrProlongSession(Date.now());
-            this.avoBatcher.handleTrackSchema(eventName, eventSchema, eventId, eventHash);
-        }
-        catch (e) {
-            console.error("Avo Inspector: something went wrong. Please report to support@avo.app.", e);
-        }
-    };
-    AvoInspector.prototype.enableLogging = function (enable) {
-        AvoInspector._shouldLog = enable;
-    };
-    AvoInspector.prototype.extractSchema = function (eventProperties, shouldLogIfEnabled) {
-        if (shouldLogIfEnabled === void 0) { shouldLogIfEnabled = true; }
-        try {
-            this.sessionTracker.startOrProlongSession(Date.now());
-            if (this.avoDeduplicator.hasSeenEventParams(eventProperties, true)) {
-                if (shouldLogIfEnabled && AvoInspector.shouldLog) {
-                    console.warn("Avo Inspector: WARNING! You are trying to extract schema shape that was just reported by your Avo functions. " +
-                        "This is an indicator of duplicate inspector reporting. " +
-                        "Please reach out to support@avo.app for advice if you are not sure how to handle this.");
-                }
-            }
-            if (AvoInspector.shouldLog) {
-                console.log("Avo Inspector: extracting schema from " +
-                    JSON.stringify(eventProperties));
-            }
-            return AvoSchemaParser_1.AvoSchemaParser.extractSchema(eventProperties);
-        }
-        catch (e) {
-            console.error("Avo Inspector: something went wrong. Please report to support@avo.app.", e);
-            return [];
-        }
-    };
-    AvoInspector.prototype.setBatchSize = function (newBatchSize) {
-        AvoInspector._batchSize = newBatchSize;
-    };
-    AvoInspector.prototype.setBatchFlushSeconds = function (newBatchFlushSeconds) {
-        AvoInspector._batchFlushSeconds = newBatchFlushSeconds;
-    };
-    AvoInspector._batchSize = 30;
-    AvoInspector._batchFlushSeconds = 30;
-    AvoInspector._shouldLog = false;
-    return AvoInspector;
-}());
-exports.AvoInspector = AvoInspector;

package/dist-native/AvoInspectorEnv.d.ts

@@ -1,7 +0,0 @@
-export declare const AvoInspectorEnv: {
-    readonly Prod: "prod";
-    readonly Dev: "dev";
-    readonly Staging: "staging";
-};
-export type AvoInspectorEnvType = typeof AvoInspectorEnv;
-export type AvoInspectorEnvValueType = AvoInspectorEnvType[keyof AvoInspectorEnvType];

package/dist-native/AvoInspectorEnv.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvoInspectorEnv = void 0;
-exports.AvoInspectorEnv = {
-    Prod: "prod",
-    Dev: "dev",
-    Staging: "staging",
-};

package/dist-native/AvoInstallationId.d.ts

@@ -1,5 +0,0 @@
-export declare class AvoInstallationId {
-    static installationId: null | string;
-    static getInstallationId(): string;
-    static get cacheKey(): string;
-}

package/dist-native/AvoInstallationId.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvoInstallationId = void 0;
-var AvoGuid_1 = require("./AvoGuid");
-var AvoInspector_1 = require("./AvoInspector");
-var AvoInstallationId = /** @class */ (function () {
-    function AvoInstallationId() {
-    }
-    AvoInstallationId.getInstallationId = function () {
-        if (AvoInstallationId.installationId !== null) {
-            return AvoInstallationId.installationId;
-        }
-        if (!AvoInspector_1.AvoInspector.avoStorage.isInitialized()) {
-            return "unknown";
-        }
-        var maybeInstallationId = AvoInspector_1.AvoInspector.avoStorage.getItem(AvoInstallationId.cacheKey);
-        if (maybeInstallationId === null || maybeInstallationId === undefined) {
-            AvoInstallationId.installationId = AvoGuid_1.default.newGuid();
-            AvoInspector_1.AvoInspector.avoStorage.setItem(AvoInstallationId.cacheKey, AvoInstallationId.installationId);
-        }
-        else {
-            AvoInstallationId.installationId = maybeInstallationId;
-        }
-        return AvoInstallationId.installationId;
-    };
-    Object.defineProperty(AvoInstallationId, "cacheKey", {
-        get: function () {
-            return "AvoInstallationId";
-        },
-        enumerable: false,
-        configurable: true
-    });
-    AvoInstallationId.installationId = null;
-    return AvoInstallationId;
-}());
-exports.AvoInstallationId = AvoInstallationId;

package/dist-native/AvoNetworkCallsHandler.d.ts

@@ -1,48 +0,0 @@
-export interface BaseBody {
-    apiKey: string;
-    appName: string;
-    appVersion: string;
-    libVersion: string;
-    env: string;
-    libPlatform: "web";
-    messageId: string;
-    trackingId: string;
-    createdAt: string;
-    sessionId: string;
-    samplingRate: number;
-}
-export interface SessionStartedBody extends BaseBody {
-    type: "sessionStarted";
-}
-export interface EventSchemaBody extends BaseBody {
-    type: "event";
-    eventName: string;
-    eventProperties: Array<{
-        propertyName: string;
-        propertyType: string;
-        children?: any;
-    }>;
-    avoFunction: boolean;
-    eventId: string | null;
-    eventHash: string | null;
-}
-export declare class AvoNetworkCallsHandler {
-    private apiKey;
-    private envName;
-    private appName;
-    private appVersion;
-    private libVersion;
-    private samplingRate;
-    private sending;
-    private static trackingEndpoint;
-    constructor(apiKey: string, envName: string, appName: string, appVersion: string, libVersion: string);
-    callInspectorWithBatchBody(inEvents: Array<SessionStartedBody | EventSchemaBody>, onCompleted: (error: string | null) => any): void;
-    private fixSessionAndTrackingIds;
-    bodyForSessionStartedCall(): SessionStartedBody;
-    bodyForEventSchemaCall(eventName: string, eventProperties: Array<{
-        propertyName: string;
-        propertyType: string;
-        children?: any;
-    }>, eventId: string | null, eventHash: string | null): EventSchemaBody;
-    private createBaseCallBody;
-}

package/dist-native/AvoNetworkCallsHandler.js

@@ -1,142 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvoNetworkCallsHandler = void 0;
-var AvoGuid_1 = require("./AvoGuid");
-var AvoSessionTracker_1 = require("./AvoSessionTracker");
-var AvoInspector_1 = require("./AvoInspector");
-var AvoInstallationId_1 = require("./AvoInstallationId");
-var AvoNetworkCallsHandler = /** @class */ (function () {
-    function AvoNetworkCallsHandler(apiKey, envName, appName, appVersion, libVersion) {
-        this.samplingRate = 1.0;
-        this.sending = false;
-        this.apiKey = apiKey;
-        this.envName = envName;
-        this.appName = appName;
-        this.appVersion = appVersion;
-        this.libVersion = libVersion;
-    }
-    AvoNetworkCallsHandler.prototype.callInspectorWithBatchBody = function (inEvents, onCompleted) {
-        var _this = this;
-        if (this.sending) {
-            onCompleted("Batch sending cancelled because another batch sending is in progress. Your events will be sent with next batch.");
-            return;
-        }
-        var events = inEvents.filter(function (x) { return x != null; });
-        this.fixSessionAndTrackingIds(events);
-        if (events.length === 0) {
-            return;
-        }
-        if (Math.random() > this.samplingRate) {
-            if (AvoInspector_1.AvoInspector.shouldLog) {
-                console.log("Avo Inspector: last event schema dropped due to sampling rate.");
-            }
-            return;
-        }
-        if (AvoInspector_1.AvoInspector.shouldLog) {
-            console.log("Avo Inspector: events", events);
-            events.forEach(function (event) {
-                if (event.type === "sessionStarted") {
-                    console.log("Avo Inspector: sending session started event.");
-                }
-                else if (event.type === "event") {
-                    var schemaEvent = event;
-                    console.log("Avo Inspector: sending event " + schemaEvent.eventName + " with schema " + JSON.stringify(schemaEvent.eventProperties));
-                }
-            });
-        }
-        this.sending = true;
-        var xmlhttp = new XMLHttpRequest();
-        xmlhttp.open("POST", AvoNetworkCallsHandler.trackingEndpoint, true);
-        xmlhttp.setRequestHeader("Content-Type", "text/plain");
-        xmlhttp.send(JSON.stringify(events));
-        xmlhttp.onload = function () {
-            if (xmlhttp.status != 200) {
-                onCompleted("Error ".concat(xmlhttp.status, ": ").concat(xmlhttp.statusText));
-            }
-            else {
-                var samplingRate = JSON.parse(xmlhttp.response).samplingRate;
-                if (samplingRate !== undefined) {
-                    _this.samplingRate = samplingRate;
-                }
-                onCompleted(null);
-            }
-        };
-        xmlhttp.onerror = function () {
-            onCompleted("Request failed");
-        };
-        xmlhttp.ontimeout = function () {
-            onCompleted("Request timed out");
-        };
-        this.sending = false;
-    };
-    AvoNetworkCallsHandler.prototype.fixSessionAndTrackingIds = function (events) {
-        var knownSessionId = null;
-        var knownTrackingId = null;
-        events.forEach(function (event) {
-            if (event.sessionId !== null && event.sessionId !== undefined && event.sessionId !== "unknown") {
-                knownSessionId = event.sessionId;
-            }
-            if (event.trackingId !== null && event.trackingId !== undefined && event.trackingId !== "unknown") {
-                knownTrackingId = event.trackingId;
-            }
-        });
-        events.forEach(function (event) {
-            if (event.sessionId === "unknown") {
-                if (knownSessionId != null) {
-                    event.sessionId = knownSessionId;
-                }
-                else {
-                    event.sessionId = AvoSessionTracker_1.AvoSessionTracker.sessionId;
-                }
-            }
-            if (event.trackingId === "unknown") {
-                if (knownTrackingId != null) {
-                    event.trackingId = knownTrackingId;
-                }
-                else {
-                    event.trackingId = AvoInstallationId_1.AvoInstallationId.getInstallationId();
-                }
-            }
-        });
-    };
-    AvoNetworkCallsHandler.prototype.bodyForSessionStartedCall = function () {
-        var sessionBody = this.createBaseCallBody();
-        sessionBody.type = "sessionStarted";
-        return sessionBody;
-    };
-    AvoNetworkCallsHandler.prototype.bodyForEventSchemaCall = function (eventName, eventProperties, eventId, eventHash) {
-        var eventSchemaBody = this.createBaseCallBody();
-        eventSchemaBody.type = "event";
-        eventSchemaBody.eventName = eventName;
-        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;
-    };
-    AvoNetworkCallsHandler.prototype.createBaseCallBody = function () {
-        return {
-            apiKey: this.apiKey,
-            appName: this.appName,
-            appVersion: this.appVersion,
-            libVersion: this.libVersion,
-            env: this.envName,
-            libPlatform: "web",
-            messageId: AvoGuid_1.default.newGuid(),
-            trackingId: AvoInstallationId_1.AvoInstallationId.getInstallationId(),
-            createdAt: new Date().toISOString(),
-            sessionId: AvoSessionTracker_1.AvoSessionTracker.sessionId,
-            samplingRate: this.samplingRate,
-        };
-    };
-    AvoNetworkCallsHandler.trackingEndpoint = "https://api.avo.app/inspector/v1/track";
-    return AvoNetworkCallsHandler;
-}());
-exports.AvoNetworkCallsHandler = AvoNetworkCallsHandler;

package/dist-native/AvoSchemaParser.d.ts

@@ -1,11 +0,0 @@
-export declare class AvoSchemaParser {
-    static extractSchema(eventProperties: {
-        [propName: string]: any;
-    }): Array<{
-        propertyName: string;
-        propertyType: string;
-        children?: any;
-    }>;
-    private static removeDuplicates;
-    private static getPropValueType;
-}

package/dist-native/AvoSchemaParser.js

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvoSchemaParser = void 0;
-var isArray = function (obj) {
-    return Object.prototype.toString.call(obj) === "[object Array]";
-};
-var AvoSchemaParser = /** @class */ (function () {
-    function AvoSchemaParser() {
-    }
-    AvoSchemaParser.extractSchema = function (eventProperties) {
-        var _this = this;
-        if (eventProperties === null || eventProperties === undefined) {
-            return [];
-        }
-        var mapping = function (object) {
-            if (isArray(object)) {
-                var list = object.map(function (x) {
-                    return mapping(x);
-                });
-                return _this.removeDuplicates(list);
-            }
-            else if (typeof object === "object") {
-                var mappedResult = [];
-                for (var key in object) {
-                    if (object.hasOwnProperty(key)) {
-                        var val = object[key];
-                        var mappedEntry = {
-                            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;
-    };
-    AvoSchemaParser.removeDuplicates = function (array) {
-        // XXX TODO fix any types
-        var primitives = { boolean: {}, number: {}, string: {} };
-        var objects = [];
-        return array.filter(function (item) {
-            var type = 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);
-            }
-        });
-    };
-    AvoSchemaParser.getPropValueType = function (propValue) {
-        var 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") {
-            if (isArray(propValue)) {
-                return "list";
-            }
-            else {
-                return "object";
-            }
-        }
-        else {
-            return "unknown";
-        }
-    };
-    return AvoSchemaParser;
-}());
-exports.AvoSchemaParser = AvoSchemaParser;

package/dist-native/AvoSessionTracker.d.ts

@@ -1,15 +0,0 @@
-import { AvoBatcherType } from "./AvoBatcher";
-export declare class AvoSessionTracker {
-    private static _sessionId;
-    static get sessionId(): string;
-    private _lastSessionTimestamp;
-    get lastSessionTimestamp(): number;
-    private _sessionLengthMillis;
-    get sessionLengthMillis(): number;
-    private avoBatcher;
-    constructor(avoBatcher: AvoBatcherType);
-    startOrProlongSession(atTime: number): void;
-    private static updateSessionId;
-    static get lastSessionTimestampKey(): string;
-    static get idCacheKey(): string;
-}