@esri/telemetry-amazon 6.0.0-beta.4 → 6.0.0-beta.5

package/dist/node/plugins/utils/browser.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBrowserClientInfo = void 0;
+const os_1 = require("./os");
+function getNavigatorSafe() {
+    if (typeof window === 'undefined' || !window.navigator) {
+        return undefined;
+    }
+    return window.navigator;
+}
+function getLanguageInfo(nav) {
+    if (!nav) {
+        return '';
+    }
+    const lang = nav.language ||
+        nav.browserLanguage ||
+        (Array.isArray(nav.languages) && nav.languages.length > 0
+            ? nav.languages[0]
+            : 'en_US') ||
+        '';
+    return String(lang).toLowerCase().replace('-', '_');
+}
+function getBrowserTimezone() {
+    const tzMatch = /\(([A-Za-z\s].*)\)/.exec(new Date().toString());
+    return tzMatch ? tzMatch[1] || '' : '';
+}
+function parseBrowserType(userAgent) {
+    const operaMatch = /.+(Opera[\s[A-Z]*|OPR[\sA-Z]*)\/([0-9\.]+).*/i.exec(userAgent);
+    if (operaMatch) {
+        return {
+            type: operaMatch[1],
+            version: operaMatch[2],
+        };
+    }
+    const edgeOrTridentMatch = /.+(Trident|Edge)\/([0-9\.]+).*/i.exec(userAgent);
+    if (edgeOrTridentMatch) {
+        return {
+            type: edgeOrTridentMatch[1],
+            version: edgeOrTridentMatch[2],
+        };
+    }
+    const headlessMatch = /(headlesschrome)(?:\/([\w\.]+)| )/i.exec(userAgent);
+    if (headlessMatch) {
+        return {
+            type: headlessMatch[1],
+            version: headlessMatch[2],
+        };
+    }
+    const browserMatch = /.+(Chrome|Firefox|FxiOS)\/([0-9\.]+).*/i.exec(userAgent);
+    if (browserMatch) {
+        return {
+            type: browserMatch[1],
+            version: browserMatch[2],
+        };
+    }
+    const safariMatch = /.+(Safari)\/([0-9\.]+).*/i.exec(userAgent);
+    if (safariMatch) {
+        return {
+            type: safariMatch[1],
+            version: safariMatch[2],
+        };
+    }
+    const webkitMatch = /.+(AppleWebKit)\/([0-9\.]+).*/i.exec(userAgent);
+    if (webkitMatch) {
+        return {
+            type: webkitMatch[1],
+            version: webkitMatch[2],
+        };
+    }
+    const anyMatch = /.*([A-Z]+)\/([0-9\.]+).*/i.exec(userAgent);
+    const fallback = anyMatch || ['', 'NA', '0.0.0'];
+    return {
+        type: fallback[1],
+        version: fallback[2],
+    };
+}
+function getBrowserClientInfo() {
+    const nav = getNavigatorSafe();
+    if (!nav) {
+        return {};
+    }
+    const userAgent = nav.userAgent || '';
+    const browser = parseBrowserType(userAgent);
+    const isBrave = (nav.brave && nav.brave.isBrave) || false;
+    const type = isBrave ? 'Brave' : browser.type;
+    const os = (0, os_1.parseOS)(userAgent);
+    const vendorToken = (nav.vendor || '').split(' ').filter(Boolean)[0];
+    const make = type === 'Brave' ? type : vendorToken || nav.product || '';
+    return {
+        language: getLanguageInfo(nav),
+        make,
+        model: type,
+        version: browser.version,
+        name: [type, browser.version].filter(Boolean).join('/'),
+        timezone: getBrowserTimezone(),
+        platform: nav.platform,
+        os,
+    };
+}
+exports.getBrowserClientInfo = getBrowserClientInfo;
+//# sourceMappingURL=browser.js.map

package/dist/node/plugins/utils/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../../src/plugins/utils/browser.ts"],"names":[],"mappings":";;;AAAA,6BAA8C;AAa9C,SAAS,gBAAgB;IACvB,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;QACtD,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,MAAM,CAAC,SAAS,CAAC;AAC1B,CAAC;AAED,SAAS,eAAe,CAAC,GAAe;IACtC,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,EAAE,CAAC;KACX;IACD,MAAM,IAAI,GACR,GAAG,CAAC,QAAQ;QACX,GAAW,CAAC,eAAe;QAC5B,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;YACvD,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YAClB,CAAC,CAAC,OAAO,CAAC;QACZ,EAAE,CAAC;IACL,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,kBAAkB;IACzB,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjE,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACzC,CAAC;AAED,SAAS,gBAAgB,CAAC,SAAiB;IAIzC,MAAM,UAAU,GAAG,+CAA+C,CAAC,IAAI,CACrE,SAAS,CACV,CAAC;IACF,IAAI,UAAU,EAAE;QACd,OAAO;YACL,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;YACnB,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;SACvB,CAAC;KACH;IAED,MAAM,kBAAkB,GAAG,iCAAiC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7E,IAAI,kBAAkB,EAAE;QACtB,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;YAC3B,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC;SAC/B,CAAC;KACH;IAED,MAAM,aAAa,GAAG,oCAAoC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3E,IAAI,aAAa,EAAE;QACjB,OAAO;YACL,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;YACtB,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC;SAC1B,CAAC;KACH;IAED,MAAM,YAAY,GAAG,yCAAyC,CAAC,IAAI,CACjE,SAAS,CACV,CAAC;IACF,IAAI,YAAY,EAAE;QAChB,OAAO;YACL,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;YACrB,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;SACzB,CAAC;KACH;IAED,MAAM,WAAW,GAAG,2BAA2B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChE,IAAI,WAAW,EAAE;QACf,OAAO;YACL,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;YACpB,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;SACxB,CAAC;KACH;IAED,MAAM,WAAW,GAAG,gCAAgC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrE,IAAI,WAAW,EAAE;QACf,OAAO;YACL,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;YACpB,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;SACxB,CAAC;KACH;IAED,MAAM,QAAQ,GAAG,2BAA2B,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7D,MAAM,QAAQ,GAAG,QAAQ,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACjD,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QACjB,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;KACrB,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB;IAClC,MAAM,GAAG,GAAG,gBAAgB,EAAE,CAAC;IAC/B,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,EAAE,CAAC;KACX;IAED,MAAM,SAAS,GAAG,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;IACtC,MAAM,OAAO,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,CAAE,GAAW,CAAC,KAAK,IAAK,GAAW,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC;IAC5E,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IAC9C,MAAM,EAAE,GAAG,IAAA,YAAO,EAAC,SAAS,CAAC,CAAC;IAC9B,MAAM,WAAW,GAAG,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,MAAM,IAAI,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,IAAI,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;IAExE,OAAO;QACL,QAAQ,EAAE,eAAe,CAAC,GAAG,CAAC;QAC9B,IAAI;QACJ,KAAK,EAAE,IAAI;QACX,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACvD,QAAQ,EAAE,kBAAkB,EAAE;QAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,EAAE;KACH,CAAC;AACJ,CAAC;AAxBD,oDAwBC"}

package/dist/node/plugins/utils/os.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseOS = void 0;
+function parseOS(userAgent) {
+    var _a;
+    const cleanAgent = userAgent.toLowerCase().replace(/ /g, '');
+    const osMatchers = [
+        {
+            name: 'Windows',
+            regex: /windowsnt/i,
+            versionRegex: /windowsnt([\d\.]+)/i,
+        },
+        {
+            name: 'MacOS',
+            regex: /macos|macosx|macintosh|macintel|darwin/i,
+            versionRegex: /osx([\d_\.]+)/i,
+        },
+        {
+            name: 'Android',
+            regex: /android/i,
+            versionRegex: /android([\d\.]+)/i,
+        },
+        {
+            name: 'iOS',
+            regex: /iphone|ipad|ipod/i,
+            versionRegex: /os([\d_\.]+)/i,
+        },
+        {
+            name: 'Linux',
+            regex: /linux/i,
+        },
+    ];
+    const matched = osMatchers.find((entry) => entry.regex.test(cleanAgent));
+    if (!matched) {
+        return {};
+    }
+    const version = matched.versionRegex
+        ? (_a = (cleanAgent.match(matched.versionRegex) || [])[1]) === null || _a === void 0 ? void 0 : _a.replace(/_/g, '.')
+        : undefined;
+    return {
+        name: matched.name,
+        version,
+    };
+}
+exports.parseOS = parseOS;
+//# sourceMappingURL=os.js.map

package/dist/node/plugins/utils/os.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"os.js","sourceRoot":"","sources":["../../../../src/plugins/utils/os.ts"],"names":[],"mappings":";;;AAKA,SAAgB,OAAO,CAAC,SAAiB;;IACvC,MAAM,UAAU,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC7D,MAAM,UAAU,GAIX;QACH;YACE,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,YAAY;YACnB,YAAY,EAAE,qBAAqB;SACpC;QACD;YACE,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,yCAAyC;YAChD,YAAY,EAAE,gBAAgB;SAC/B;QACD;YACE,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,UAAU;YACjB,YAAY,EAAE,mBAAmB;SAClC;QACD;YACE,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,mBAAmB;YAC1B,YAAY,EAAE,eAAe;SAC9B;QACD;YACE,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,QAAQ;SAChB;KACF,CAAC;IAEF,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IACzE,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,EAAE,CAAC;KACX;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY;QAClC,CAAC,CAAC,MAAA,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;QACvE,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO;QACL,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,OAAO;KACR,CAAC;AACJ,CAAC;AA9CD,0BA8CC"}

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import { AmazonAnalytics, AmazonTelemetryOptions, AmazonTelemetryEndpointMode, Dimensions, Metrics, IAmazon, PageViewOptions, EventOptions, ISetAccessPermissionsParams, IGetAccessPermissionsParams } from './types';
+import { AmazonAnalytics, AmazonTelemetryOptions, AmazonTelemetryEndpointMode, Dimensions, Metrics, IAmazon, PageViewOptions, EventOptions, EventTrackOptions, ISetAccessPermissionsParams, IGetAccessPermissionsParams } from './types';
 /**
  * Amazon Telemetry
  * Supports Pinpoint and Esri endpoint modes
@@ -20,5 +20,5 @@ export declare class Amazon implements IAmazon<Dimensions, Metrics> {
     static setAccessPermissions({ id, authentication, username, accessChangeset, }: ISetAccessPermissionsParams): Promise<import("@esri/arcgis-rest-portal").IUpdateItemResponse>;
     static getAccessPermissions({ id, authentication, }: IGetAccessPermissionsParams): Promise<Record<string, any>>;
     logPageView(page: string, options?: PageViewOptions): boolean;
-    logEvent(event?: EventOptions): boolean;
+    logEvent(event?: EventOptions, trackOptions?: EventTrackOptions): boolean;
 }

package/dist/types/plugins/esri.d.ts

@@ -6,6 +6,7 @@ declare type EsriPluginOptions = {
     appVersion?: string;
     userPoolID?: string;
     fips?: boolean;
+    debounceMs?: number;
 };
-export declare function createEsriPlugin({ trackerName, appName, appId, appVersion, userPoolID, fips, }: EsriPluginOptions): AmazonTracker;
+export declare function createEsriPlugin({ trackerName, appName, appId, appVersion, userPoolID, fips, debounceMs, }: EsriPluginOptions): AmazonTracker;
 export {};

package/dist/types/plugins/shared.d.ts

@@ -1,3 +1,4 @@
+export { getBrowserClientInfo } from './utils/browser';
 export declare const PINPOINT_ENDPOINT_KEY = "TELEMETRY_PINPOINT_ENDPOINT_ID";
 export declare const DEFAULT_PINPOINT_REGION = "us-east-1";
 export declare const LOG_PREFIX = "[telemetry-amazon]";

package/dist/types/plugins/utils/browser.d.ts

@@ -0,0 +1,12 @@
+import { BrowserOSInfo } from './os';
+export declare type BrowserClientInfo = {
+    language?: string;
+    make?: string;
+    model?: string;
+    version?: string;
+    name?: string;
+    timezone?: string;
+    platform?: string;
+    os?: BrowserOSInfo;
+};
+export declare function getBrowserClientInfo(): BrowserClientInfo;

package/dist/types/plugins/utils/os.d.ts

@@ -0,0 +1,5 @@
+export declare type BrowserOSInfo = {
+    name?: string;
+    version?: string;
+};
+export declare function parseOS(userAgent: string): BrowserOSInfo;

package/dist/types/types.d.ts

@@ -18,7 +18,9 @@ export interface IAccessChangeset {
     ids?: string[];
 }
 export interface AmazonTracker {
-    track(eventName: string, payload: Record<string, any>): boolean | void | Promise<any>;
+    track(eventName: string, payload: Record<string, any>, options?: {
+        immediate?: boolean;
+    }): boolean | void | Promise<any>;
 }
 export declare type AmazonAnalytics = AmazonTracker | AnalyticsInstance;
 export interface IAmazon<D, M> {
@@ -33,12 +35,15 @@ export interface IAmazon<D, M> {
     metrics: M;
     init(): Promise<void>;
     logPageView: (page: string, options?: PageViewOptions) => boolean;
-    logEvent: (event?: EventOptions) => boolean;
+    logEvent: (event?: EventOptions, trackOptions?: EventTrackOptions) => boolean;
 }
 export declare type Dimensions = GenericObject;
 export declare type Metrics = GenericObject;
 export declare type PageViewOptions = GenericObject;
 export declare type EventOptions = GenericObject;
+export declare type EventTrackOptions = {
+    immediate?: boolean;
+};
 export declare type EventData = {
     category?: string;
     action?: string;