@esri/telemetry-amazon 6.0.0-beta.1 → 6.0.0-beta.10

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/browser.test.d.ts

@@ -0,0 +1 @@
+export {};

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/plugins/utils/os.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/plugins/{shared.d.ts → utils/shared.d.ts}

@@ -1,3 +1,4 @@
+export { getBrowserClientInfo } from './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/types.d.ts

@@ -1,4 +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;
 };
@@ -17,10 +19,14 @@ export interface IAccessChangeset {
     ids?: string[];
 }
 export interface AmazonTracker {
-    track(eventName: string, payload: Record<string, any>): boolean;
+    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> {
-    analytics: AmazonTracker;
+    analytics: AmazonAnalytics;
+    /** `name` is the core telemetry property mapped to `EventType` in telemetry-amazon */
     name: string;
     previousPage: {
         pageUrl?: string;
@@ -31,18 +37,10 @@ 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 EventData = {
-    category?: string;
-    action?: string;
-    label?: string;
-    pathname?: string;
-    eventType?: string;
+export declare type EventTrackOptions = {
+    immediate?: boolean;
 };
 export declare type AmazonApp = {
     name?: string;
@@ -53,14 +51,16 @@ export declare type AmazonTelemetryOptions = {
     userPoolID: string;
     app?: AmazonApp;
     fips?: boolean;
+    dimensions?: Dimensions;
+    metrics?: Metrics;
+    /**
+     * @deprecated Pinpoint is retiring on October 31, 2026. After this date all traffic will be routed to the `esri` mode.
+     * This property should not be used except for regression testing events being logged via pinpoint vs. the updated endpoint
+     * during integration.
+     */
     mode?: AmazonTelemetryEndpointMode;
-    endpoint?: AmazonTelemetryEndpointOptions;
 };
 export declare type AmazonTelemetryEndpointMode = 'pinpoint' | 'esri';
-export declare type AmazonTelemetryEndpointOptions = {
-    url?: string;
-    headers?: Record<string, string>;
-};
 export declare type LogPageViewPayload = {
     name: string;
     referrer: string;
@@ -79,4 +79,94 @@ export declare type LogEventPayload = {
     hostname?: string;
     path?: string;
 };
+/** Dimensions, Metrics are defined with 20 fields each in the DB schema */
+declare type AmazonFieldIndex = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20;
+declare type AmazonDimensionKey = `dimension${AmazonFieldIndex}`;
+declare type AmazonMetricKey = `metric${AmazonFieldIndex}`;
+export declare const AMAZON_EVENT_METRIC_KEYS: readonly ["count", "duration", "number", "position", "size", "metric1", "metric2", "metric3", "metric4", "metric5", "metric6", "metric7", "metric8", "metric9", "metric10", "metric11", "metric12", "metric13", "metric14", "metric15", "metric16", "metric17", "metric18", "metric19", "metric20"];
+declare type AmazonEventMetrics = typeof AMAZON_EVENT_METRIC_KEYS[number];
+export declare type EventMetrics = Partial<Record<AmazonEventMetrics, number>>;
+export declare const AMAZON_EVENT_ATTRIBUTE_KEYS: readonly ["action", "attribute", "category", "datasetId", "details", "error", "facetValue", "hostname", "json", "label", "lastLogin", "objectId", "org", "pageUrl", "path", "pageName", "previousPageName", "previousPageUrl", "referrer", "searchQuery", "serviceQuery", "statusCode", "user", "userSince", "urlRequested", "internalUser", "accountType", "workflowId", "browserWebCapabilities", "dimension1", "dimension2", "dimension3", "dimension4", "dimension5", "dimension6", "dimension7", "dimension8", "dimension9", "dimension10", "dimension11", "dimension12", "dimension13", "dimension14", "dimension15", "dimension16", "dimension17", "dimension18", "dimension19", "dimension20", "eventType", "pathname"];
+export declare type AmazonEventAttribute = typeof AMAZON_EVENT_ATTRIBUTE_KEYS[number];
+export declare type EventAttributes = Partial<Record<AmazonEventAttribute, string>>;
+export declare type Dimensions = Partial<Record<AmazonDimensionKey, string>>;
+export declare type Metrics = Partial<Record<AmazonMetricKey, number>>;
+export declare type PageViewOptions = GenericObject;
+export declare type EventOptions = GenericObject;
+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 {};