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

package/dist/types/types.d.ts

@@ -1,5 +1,6 @@
 import type { ArcGISIdentityManager } from '@esri/arcgis-rest-request';
 import type { AnalyticsInstance } from 'analytics';
+import { getBrowserClientInfo } from './plugins/utils/shared';
 export declare type GenericObject = {
     [key: string]: any;
 };
@@ -56,19 +57,14 @@ export declare type AmazonApp = {
     id?: string;
     version?: string;
 };
-export declare type AmazonTelemetryPinpointOptions = {
+export declare type AmazonTelemetryOptions = {
     userPoolID: string;
     app?: AmazonApp;
     fips?: boolean;
-    mode?: 'pinpoint';
-};
-export declare type AmazonTelemetryEsriOptions = {
-    userPoolID: string;
-    app?: AmazonApp;
-    fips?: boolean;
-    mode: 'esri';
+    dimensions?: Dimensions;
+    metrics?: Metrics;
+    mode?: AmazonTelemetryEndpointMode;
 };
-export declare type AmazonTelemetryOptions = AmazonTelemetryPinpointOptions | AmazonTelemetryEsriOptions;
 export declare type AmazonTelemetryEndpointMode = 'pinpoint' | 'esri';
 export declare type LogPageViewPayload = {
     name: string;
@@ -88,4 +84,82 @@ export declare type LogEventPayload = {
     hostname?: string;
     path?: string;
 };
+export declare type EventMetrics = Record<string, number>;
+export declare type EventAttributes = Record<string, string>;
+export declare type EsriBatchEventPayload = {
+    name?: string;
+    appTitle?: string;
+    appVersion?: string;
+    clientSdkVersion?: string;
+    deviceMake?: string;
+    deviceModel?: string;
+    city?: string;
+    country?: string;
+    lat?: string | number;
+    lon?: string | number;
+    [key: string]: any;
+};
+export declare type EsriBatchEvent = {
+    BatchEvent: {
+        Endpoint: {
+            Id: string;
+            Device: {
+                Locale: string;
+                Make: string;
+                Model: string;
+                ModelVersion: string;
+                Platform: string;
+                PlatformVersion?: string;
+            };
+            Location: Partial<{
+                City: string;
+                Country: string;
+                Lat: number;
+                Lon: number;
+            }>;
+            Application: {
+                AppTitle: string;
+                AppVersion: string | undefined;
+                ClientSdkVersion: string;
+            };
+        };
+        Events: Array<{
+            EventType: string;
+            Timestamp: string;
+            Session: {
+                Id: string;
+                StartTimestamp: string;
+                EndTimestamp: string;
+                Duration: number;
+            };
+            Attributes: EventAttributes;
+            Metrics: EventMetrics;
+        }>;
+    };
+};
+export declare type SessionContext = {
+    id: string;
+    startTimestamp: string;
+    startUnixMs: number;
+};
+export declare type TrackOptions = {
+    immediate?: boolean;
+};
+export declare type QueuedEvent = {
+    eventName: string;
+    payload: EsriBatchEventPayload;
+    session?: SessionContext;
+    browserInfo?: ReturnType<typeof getBrowserClientInfo>;
+    timestamp: string;
+    unixMs: number;
+};
+export declare type EsriPluginOptions = {
+    trackerName: string;
+    appId: string;
+    appName?: string;
+    appVersion?: string;
+    userPoolID?: string;
+    fips?: boolean;
+    debounceMs?: number;
+};
 export {};

package/dist/umd/telemetry-amazon.js

@@ -257,16 +257,13 @@
             },
             body: JSON.stringify({ IdentityPoolId }),
         };
-        return fetch(COGNITO_URL, fetchOptions)
-            .then((response) => {
-            if (!response.ok) {
-                throw new Error(response.statusText);
+        return (async () => {
+            const getIdResponse = await fetch(COGNITO_URL, fetchOptions);
+            if (!getIdResponse.ok) {
+                throw new Error(getIdResponse.statusText);
             }
-            return response.json();
-        })
-            .then((response) => {
-            const { IdentityId } = response;
-            const options = {
+            const { IdentityId } = await getIdResponse.json();
+            const credentialsOptions = {
                 method: 'POST',
                 headers: {
                     'Content-type': 'application/x-amz-json-1.1',
@@ -274,18 +271,14 @@
                 },
                 body: JSON.stringify({ IdentityId }),
             };
-            return fetch(COGNITO_URL, options);
-        })
-            .then((response) => {
-            if (!response.ok) {
-                throw new Error(response.statusText);
+            const getCredentialsResponse = await fetch(COGNITO_URL, credentialsOptions);
+            if (!getCredentialsResponse.ok) {
+                throw new Error(getCredentialsResponse.statusText);
             }
-            return response.json();
-        })
-            .then(({ Credentials }) => {
+            const { Credentials } = await getCredentialsResponse.json();
             storage.set(COGNITO_KEY, Credentials);
             return Credentials;
-        });
+        })();
     }
 
     /******************************************************************************
@@ -1805,7 +1798,6 @@
         };
     }
 
-    // Shared utilities for plugins
     const PINPOINT_ENDPOINT_KEY = 'TELEMETRY_PINPOINT_ENDPOINT_ID';
     const LOG_PREFIX = '[telemetry-amazon]';
     function isDebugEnabled() {
@@ -1865,6 +1857,7 @@
         const numeric = Number(value);
         return Number.isFinite(numeric) ? numeric : fallback;
     }
+    /** Splits an EsriBatchEventPayload into attributes and metrics */
     function splitEventData(payload) {
         const attributes = {};
         const metrics = {};
@@ -1901,6 +1894,7 @@
             metrics,
         };
     }
+    /** Constructs an event payload in the shape expected by the endpoint.  */
     function buildBatchEventPayload({ queuedEvents, trackerName, appName, appVersion, }) {
         var _a, _b, _c, _d, _e, _f;
         const endpointEvent = queuedEvents[queuedEvents.length - 1] ||
@@ -1928,13 +1922,9 @@
             BatchEvent: {
                 Endpoint: {
                     Id: endpointId,
-                    Demographic: Object.assign({ Locale: (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.language) || '', Make: (payload === null || payload === void 0 ? void 0 : payload.deviceMake) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.make) || '', Model: (payload === null || payload === void 0 ? void 0 : payload.deviceModel) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.model) || '', ModelVersion: (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.version) || '', Platform: ((_a = browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os) === null || _a === void 0 ? void 0 : _a.name) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.platform) || '' }, (((_b = browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os) === null || _b === void 0 ? void 0 : _b.version)
+                    Device: Object.assign({ Locale: (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.language) || '', Make: (payload === null || payload === void 0 ? void 0 : payload.deviceMake) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.make) || '', Model: (payload === null || payload === void 0 ? void 0 : payload.deviceModel) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.model) || '', ModelVersion: (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.version) || '', Platform: ((_a = browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os) === null || _a === void 0 ? void 0 : _a.name) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.platform) || '' }, (((_b = browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.os) === null || _b === void 0 ? void 0 : _b.version)
                         ? { PlatformVersion: browserInfo.os.version }
                         : {})),
-                    Device: {
-                        Make: (payload === null || payload === void 0 ? void 0 : payload.deviceMake) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.make) || '',
-                        Model: (payload === null || payload === void 0 ? void 0 : payload.deviceModel) || (browserInfo === null || browserInfo === void 0 ? void 0 : browserInfo.model) || '',
-                    },
                     Location: location,
                     Application: {
                         AppTitle: (_d = (_c = payload === null || payload === void 0 ? void 0 : payload.appTitle) !== null && _c !== void 0 ? _c : appName) !== null && _d !== void 0 ? _d : trackerName,
@@ -1943,7 +1933,6 @@
                     },
                 },
                 Events: queuedEvents.map((queuedEvent) => {
-                    console.log('queued event', queuedEvent.eventName);
                     const timestamp = queuedEvent.timestamp;
                     const { attributes, metrics } = splitEventData(queuedEvent.payload);
                     const sessionContext = queuedEvent.session ||
@@ -2058,53 +2047,53 @@
                 url,
                 eventCount: queuedEvents.length,
             });
-            void getCredentials(userPoolID, { fips })
-                .then((credentials) => {
-                const accessKeyId = (credentials === null || credentials === void 0 ? void 0 : credentials.AccessKeyId) || (credentials === null || credentials === void 0 ? void 0 : credentials.accessKeyId);
-                const secretAccessKey = (credentials === null || credentials === void 0 ? void 0 : credentials.SecretKey) || (credentials === null || credentials === void 0 ? void 0 : credentials.secretAccessKey);
-                const sessionToken = (credentials === null || credentials === void 0 ? void 0 : credentials.SessionToken) || (credentials === null || credentials === void 0 ? void 0 : credentials.sessionToken);
-                if (!accessKeyId || !secretAccessKey) {
-                    throw new Error('Signed endpoint credentials are missing required key fields.');
+            void (async () => {
+                var _a;
+                try {
+                    const credentials = await getCredentials(userPoolID, { fips });
+                    const accessKeyId = (credentials === null || credentials === void 0 ? void 0 : credentials.AccessKeyId) || (credentials === null || credentials === void 0 ? void 0 : credentials.accessKeyId);
+                    const secretAccessKey = (credentials === null || credentials === void 0 ? void 0 : credentials.SecretKey) || (credentials === null || credentials === void 0 ? void 0 : credentials.secretAccessKey);
+                    const sessionToken = (credentials === null || credentials === void 0 ? void 0 : credentials.SessionToken) || (credentials === null || credentials === void 0 ? void 0 : credentials.sessionToken);
+                    if (!accessKeyId || !secretAccessKey) {
+                        throw new Error('Signed endpoint credentials are missing required key fields.');
+                    }
+                    const client = new AwsClient({
+                        accessKeyId,
+                        secretAccessKey,
+                        sessionToken,
+                        service: ESRI_SIGNING_SERVICE,
+                        region: ESRI_SIGNING_REGION,
+                    });
+                    await client.fetch(url, {
+                        method: 'POST',
+                        headers: {
+                            'Content-Type': 'application/json',
+                        },
+                        body: JSON.stringify(buildBatchEventPayload({
+                            queuedEvents,
+                            trackerName,
+                            appName,
+                            appVersion,
+                        })),
+                    });
+                    debugLog('Endpoint event sent', {
+                        trackerName,
+                        eventCount: queuedEvents.length,
+                    });
                 }
-                const client = new AwsClient({
-                    accessKeyId,
-                    secretAccessKey,
-                    sessionToken,
-                    service: ESRI_SIGNING_SERVICE,
-                    region: ESRI_SIGNING_REGION,
-                });
-                return client.fetch(url, {
-                    method: 'POST',
-                    headers: {
-                        'Content-Type': 'application/json',
-                    },
-                    body: JSON.stringify(buildBatchEventPayload({
-                        queuedEvents,
+                catch (error) {
+                    isDisabled = true;
+                    clearIdleTimer();
+                    clearDebounceTimer();
+                    clearPendingEvents();
+                    removeAllLifecycleListeners();
+                    warnOnce('Esri telemetry disabled after endpoint track failure', {
+                        eventName: (_a = queuedEvents[queuedEvents.length - 1]) === null || _a === void 0 ? void 0 : _a.eventName,
                         trackerName,
-                        appName,
-                        appVersion,
-                    })),
-                });
-            })
-                .then(() => {
-                debugLog('Endpoint event sent', {
-                    trackerName,
-                    eventCount: queuedEvents.length,
-                });
-            })
-                .catch((error) => {
-                var _a;
-                isDisabled = true;
-                clearIdleTimer();
-                clearDebounceTimer();
-                clearPendingEvents();
-                removeAllLifecycleListeners();
-                warnOnce('Esri telemetry disabled after endpoint track failure', {
-                    eventName: (_a = queuedEvents[queuedEvents.length - 1]) === null || _a === void 0 ? void 0 : _a.eventName,
-                    trackerName,
-                    message: (error === null || error === void 0 ? void 0 : error.message) || String(error),
-                });
-            });
+                        message: (error === null || error === void 0 ? void 0 : error.message) || String(error),
+                    });
+                }
+            })();
         };
         const flushPendingEvents = (eventToAppend) => {
             clearDebounceTimer();
@@ -2112,8 +2101,6 @@
             if (eventToAppend) {
                 queuedEvents.push(eventToAppend);
             }
-            console.log('flushing', eventToAppend);
-            console.log('stack', queuedEvents);
             sendQueuedEvents(queuedEvents);
         };
         const scheduleDebounceFlush = () => {
@@ -2172,7 +2159,6 @@
             }, sessionOverride, undefined, true);
         };
         const stopSession = (reason) => {
-            console.log('stopping session');
             if (!hasSessionStarted || sessionStopSent) {
                 return false;
             }