@aws-amplify/analytics 7.0.1-console-preview.f63250a.0 → 7.0.1-console-preview.e8aa063.0

package/src/trackers/EventTracker.ts

@@ -1,115 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { delegate } from '../vendor/dom-utils';
-import { EventTrackOpts } from '../types';
-import { ConsoleLogger as Logger, browserOrNode } from '@aws-amplify/core';
-
-const logger = new Logger('EventTracker');
-
-const defaultOpts: EventTrackOpts = {
-	enable: false,
-	events: ['click'],
-	selectorPrefix: 'data-amplify-analytics-',
-	provider: 'AWSPinpoint',
-};
-
-export class EventTracker {
-	private _tracker;
-	private _config: EventTrackOpts;
-	private _delegates;
-
-	constructor(tracker, opts) {
-		if (!browserOrNode().isBrowser || !window.addEventListener) {
-			logger.debug('not in the supported web environment');
-			return;
-		}
-
-		this._config = Object.assign({}, defaultOpts, opts);
-		this._tracker = tracker;
-		this._delegates = {};
-		this._trackFunc = this._trackFunc.bind(this);
-
-		logger.debug('initialize pageview tracker with opts', this._config);
-
-		this.configure(this._config);
-	}
-
-	configure(opts?: EventTrackOpts) {
-		Object.assign(this._config, opts);
-
-		if (!this._config.enable) {
-			Object.keys(this._delegates).forEach(key => {
-				if (typeof this._delegates[key].destroy === 'function')
-					this._delegates[key].destroy();
-			});
-			this._delegates = {};
-		} else if (
-			this._config.enable &&
-			Object.keys(this._delegates).length === 0
-		) {
-			const selector = '[' + this._config.selectorPrefix + 'on]';
-			this._config.events.forEach(evt => {
-				this._delegates[evt] = delegate(
-					document,
-					evt,
-					selector,
-					this._trackFunc,
-					{ composed: true, useCapture: true }
-				);
-			});
-		}
-
-		return this._config;
-	}
-
-	private async _trackFunc(event, element) {
-		// the events specifed in 'amplify-analytics-on' selector
-		const customAttrs = {};
-		const events = element
-			.getAttribute(this._config.selectorPrefix + 'on')
-			.split(/\s*,\s*/);
-		const eventName = element.getAttribute(
-			this._config.selectorPrefix + 'name'
-		);
-
-		const attrs = element.getAttribute(this._config.selectorPrefix + 'attrs');
-		if (attrs) {
-			attrs.split(/\s*,\s*/).forEach(attr => {
-				const tmp = attr.trim().split(/\s*:\s*/);
-				customAttrs[tmp[0]] = tmp[1];
-			});
-		}
-
-		const defaultAttrs =
-			typeof this._config.attributes === 'function'
-				? await this._config.attributes()
-				: this._config.attributes;
-
-		const attributes = Object.assign(
-			{
-				type: event.type,
-				target: `${event.target.localName} with id ${event.target.id}`,
-			},
-			defaultAttrs,
-			customAttrs
-		);
-
-		logger.debug('events needed to be recorded', events);
-		logger.debug('attributes needed to be attached', customAttrs);
-		if (events.indexOf(event.type) < 0) {
-			logger.debug(`event ${event.type} is not selected to be recorded`);
-			return;
-		}
-
-		this._tracker(
-			{
-				name: eventName || 'event',
-				attributes,
-			},
-			this._config.provider
-		).catch(e => {
-			logger.debug(`Failed to record the ${event.type} event', ${e}`);
-		});
-	}
-}

package/src/trackers/PageViewTracker.ts

@@ -1,157 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { pageViewTrackOpts } from '../types';
-import { MethodEmbed } from '../utils/MethodEmbed';
-import { ConsoleLogger as Logger, browserOrNode } from '@aws-amplify/core';
-
-const logger = new Logger('PageViewTracker');
-const PREV_URL_KEY = 'aws-amplify-analytics-prevUrl';
-
-const getUrl = () => {
-	if (!browserOrNode().isBrowser) return '';
-	else return window.location.origin + window.location.pathname;
-};
-
-const defaultOpts: pageViewTrackOpts = {
-	enable: false,
-	provider: 'AWSPinpoint',
-	getUrl,
-};
-
-export class PageViewTracker {
-	private _config: pageViewTrackOpts;
-	private _tracker;
-	private _hasEnabled;
-
-	constructor(tracker, opts) {
-		logger.debug('initialize pageview tracker with opts', opts);
-		this._config = Object.assign({}, defaultOpts, opts);
-		this._tracker = tracker;
-		this._hasEnabled = false;
-		this._trackFunc = this._trackFunc.bind(this);
-
-		if (this._config.type === 'SPA') {
-			this._pageViewTrackSPA();
-		} else {
-			this._pageViewTrackDefault();
-		}
-	}
-
-	public configure(opts?: pageViewTrackOpts) {
-		Object.assign(this._config, opts);
-
-		// if spa, need to remove those listeners if disabled
-		if (this._config.type === 'SPA') {
-			this._pageViewTrackSPA();
-		}
-
-		return this._config;
-	}
-
-	private _isSameUrl() {
-		const prevUrl = sessionStorage.getItem(PREV_URL_KEY);
-		const curUrl = this._config.getUrl();
-
-		if (prevUrl === curUrl) {
-			logger.debug('the url is same');
-			return true;
-		} else return false;
-	}
-
-	private async _pageViewTrackDefault() {
-		if (
-			!browserOrNode().isBrowser ||
-			!window.addEventListener ||
-			!window.sessionStorage
-		) {
-			logger.debug('not in the supported web enviroment');
-			return;
-		}
-		const url = this._config.getUrl();
-		const customAttrs =
-			typeof this._config.attributes === 'function'
-				? await this._config.attributes()
-				: this._config.attributes;
-		const attributes = Object.assign(
-			{
-				url,
-			},
-			customAttrs
-		);
-
-		if (this._config.enable && !this._isSameUrl()) {
-			this._tracker(
-				{
-					name: this._config.eventName || 'pageView',
-					attributes,
-				},
-				this._config.provider
-			).catch(e => {
-				logger.debug('Failed to record the page view event', e);
-			});
-			sessionStorage.setItem(PREV_URL_KEY, url);
-		}
-	}
-
-	private async _trackFunc() {
-		if (
-			!browserOrNode().isBrowser ||
-			!window.addEventListener ||
-			!history.pushState ||
-			!window.sessionStorage
-		) {
-			logger.debug('not in the supported web enviroment');
-			return;
-		}
-
-		const url = this._config.getUrl();
-		const customAttrs =
-			typeof this._config.attributes === 'function'
-				? await this._config.attributes()
-				: this._config.attributes;
-		const attributes = Object.assign(
-			{
-				url,
-			},
-			customAttrs
-		);
-
-		if (!this._isSameUrl()) {
-			this._tracker(
-				{
-					name: this._config.eventName || 'pageView',
-					attributes,
-				},
-				this._config.provider
-			).catch(e => {
-				logger.debug('Failed to record the page view event', e);
-			});
-			sessionStorage.setItem(PREV_URL_KEY, url);
-		}
-	}
-
-	private _pageViewTrackSPA() {
-		if (
-			!browserOrNode().isBrowser ||
-			!window.addEventListener ||
-			!history.pushState
-		) {
-			logger.debug('not in the supported web enviroment');
-			return;
-		}
-
-		if (this._config.enable && !this._hasEnabled) {
-			MethodEmbed.add(history, 'pushState', this._trackFunc);
-			MethodEmbed.add(history, 'replaceState', this._trackFunc);
-			window.addEventListener('popstate', this._trackFunc);
-			this._trackFunc();
-			this._hasEnabled = true;
-		} else {
-			MethodEmbed.remove(history, 'pushState');
-			MethodEmbed.remove(history, 'replaceState');
-			window.removeEventListener('popstate', this._trackFunc);
-			this._hasEnabled = false;
-		}
-	}
-}

package/src/trackers/SessionTracker-rn.ts

@@ -1,134 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-// the session tracker for react native
-
-import { ConsoleLogger as Logger } from '@aws-amplify/core';
-import { SessionTrackOpts } from '../types';
-import { AppState } from 'react-native';
-
-const logger = new Logger('SessionTracker');
-
-const defaultOpts: SessionTrackOpts = {
-	enable: false,
-	provider: 'AWSPinpoint',
-};
-
-let initialEventSent = false;
-
-export class SessionTracker {
-	private _tracker;
-	private _hasEnabled;
-	private _config: SessionTrackOpts;
-	private _currentState;
-
-	constructor(tracker, opts) {
-		this._config = Object.assign({}, defaultOpts, opts);
-		this._tracker = tracker;
-
-		this._hasEnabled = false;
-		this._trackFunc = this._trackFunc.bind(this);
-		this._currentState = AppState.currentState;
-		this.configure(this._config);
-	}
-
-	private _envCheck() {
-		if (!AppState) {
-			logger.debug('not in the supported react native environment');
-			return false;
-		}
-		return true;
-	}
-
-	private async _trackFunc(nextAppState) {
-		const customAttrs =
-			typeof this._config.attributes === 'function'
-				? await this._config.attributes()
-				: this._config.attributes;
-		const attributes = Object.assign({}, customAttrs);
-
-		if (
-			this._currentState.match(/inactive|background/) &&
-			nextAppState === 'active'
-		) {
-			logger.debug('App has come to the foreground, recording start session');
-			this._tracker(
-				{
-					name: '_session.start',
-					attributes,
-					immediate: false,
-				},
-				this._config.provider
-			).catch(e => {
-				logger.debug('record session start event failed.', e);
-			});
-		}
-		if (
-			this._currentState.match(/active/) &&
-			nextAppState.match(/inactive|background/)
-		) {
-			logger.debug(
-				'App has come to inactive/background, recording stop session'
-			);
-			this._tracker(
-				{
-					name: '_session.stop',
-					attributes,
-					immediate: false,
-				},
-				this._config.provider
-			).catch(e => {
-				logger.debug('record session stop event failed.', e);
-			});
-		}
-
-		this._currentState = nextAppState;
-	}
-
-	// to keep configure a synchronized function
-	private async _sendInitialEvent() {
-		if (initialEventSent) {
-			logger.debug('the start session has been sent when the page is loaded');
-			return;
-		} else {
-			initialEventSent = true;
-		}
-
-		const customAttrs =
-			typeof this._config.attributes === 'function'
-				? await this._config.attributes()
-				: this._config.attributes;
-		const attributes = Object.assign({}, customAttrs);
-
-		this._tracker(
-			{
-				name: '_session.start',
-				attributes,
-				immediate: false,
-			},
-			this._config.provider
-		).catch(e => {
-			logger.debug('record session start event failed.', e);
-		});
-	}
-
-	configure(opts?: SessionTrackOpts) {
-		if (!this._envCheck()) {
-			return this._config;
-		}
-
-		Object.assign(this._config, opts);
-		if (this._config.enable && !this._hasEnabled) {
-			// send a start session as soon as it's enabled
-			this._sendInitialEvent();
-			// listen on events
-			AppState.addEventListener('change', this._trackFunc, false);
-			this._hasEnabled = true;
-		} else if (!this._config.enable && this._hasEnabled) {
-			AppState.removeEventListener('change', this._trackFunc, false);
-			this._hasEnabled = false;
-		}
-
-		return this._config;
-	}
-}

package/src/trackers/SessionTracker.ts

@@ -1,179 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-// the session tracker for web
-
-import {
-	ConsoleLogger as Logger,
-	Hub,
-	Constants,
-	browserOrNode,
-} from '@aws-amplify/core';
-import { SessionTrackOpts } from '../types';
-
-const logger = new Logger('SessionTracker');
-
-const defaultOpts: SessionTrackOpts = {
-	enable: false,
-	provider: 'AWSPinpoint',
-};
-
-let initialEventSent = false;
-
-export class SessionTracker {
-	private _tracker;
-	private _hasEnabled;
-	private _config: SessionTrackOpts;
-
-	private _hidden;
-	private _visibilityChange;
-
-	constructor(tracker, opts) {
-		this._config = Object.assign({}, defaultOpts, opts);
-		this._tracker = tracker;
-
-		this._hasEnabled = false;
-		this._trackFunc = this._trackFunc.bind(this);
-		this._trackBeforeUnload = this._trackBeforeUnload.bind(this);
-
-		this.configure(this._config);
-	}
-
-	private _envCheck() {
-		if (!browserOrNode().isBrowser) {
-			return false;
-		}
-
-		if (!document || !document.addEventListener) {
-			logger.debug('not in the supported web environment');
-			return false;
-		}
-
-		if (typeof document.hidden !== 'undefined') {
-			this._hidden = 'hidden';
-			this._visibilityChange = 'visibilitychange';
-		} else if (typeof document['msHidden'] !== 'undefined') {
-			this._hidden = 'msHidden';
-			this._visibilityChange = 'msvisibilitychange';
-		} else if (typeof document['webkitHidden'] !== 'undefined') {
-			this._hidden = 'webkitHidden';
-			this._visibilityChange = 'webkitvisibilitychange';
-		} else {
-			logger.debug('not in the supported web environment');
-			return false;
-		}
-		return true;
-	}
-
-	private async _trackFunc() {
-		const customAttrs =
-			typeof this._config.attributes === 'function'
-				? await this._config.attributes()
-				: this._config.attributes;
-
-		const attributes = Object.assign({}, customAttrs);
-
-		if (document.visibilityState === this._hidden) {
-			this._tracker(
-				{
-					name: '_session.stop',
-					attributes,
-				},
-				this._config.provider
-			).catch(e => {
-				logger.debug('record session stop event failed.', e);
-			});
-		} else {
-			this._tracker(
-				{
-					name: '_session.start',
-					attributes,
-				},
-				this._config.provider
-			).catch(e => {
-				logger.debug('record session start event failed.', e);
-			});
-		}
-	}
-
-	private _trackBeforeUnload(event) {
-		// before unload callback cannot be async => https://github.com/aws-amplify/amplify-js/issues/2088
-
-		const customAttrs =
-			typeof this._config.attributes === 'function'
-				? Promise.resolve(this._config.attributes())
-				: Promise.resolve(this._config.attributes);
-
-		customAttrs.then(custom => {
-			const attributes = Object.assign({}, custom);
-
-			this._tracker(
-				{
-					name: '_session.stop',
-					attributes,
-					immediate: true,
-				},
-				this._config.provider
-			).catch(e => {
-				logger.debug('record session stop event failed.', e);
-			});
-		});
-	}
-
-	// to keep configure a synchronized function
-	private async _sendInitialEvent() {
-		if (initialEventSent) {
-			logger.debug('the start session has been sent when the page is loaded');
-			return;
-		} else {
-			initialEventSent = true;
-		}
-
-		const customAttrs =
-			typeof this._config.attributes === 'function'
-				? await this._config.attributes()
-				: this._config.attributes;
-
-		const attributes = Object.assign({}, customAttrs);
-
-		this._tracker(
-			{
-				name: '_session.start',
-				attributes,
-			},
-			this._config.provider
-		).catch(e => {
-			logger.debug('record session start event failed.', e);
-		});
-	}
-
-	configure(opts?: SessionTrackOpts) {
-		if (!this._envCheck()) {
-			return this._config;
-		}
-
-		Object.assign(this._config, opts);
-		if (this._config.enable && !this._hasEnabled) {
-			// send a start session as soon as it's enabled
-			this._sendInitialEvent();
-			// listen on events
-			document.addEventListener(this._visibilityChange, this._trackFunc, false);
-			window.addEventListener('beforeunload', this._trackBeforeUnload, false);
-			this._hasEnabled = true;
-		} else if (!this._config.enable && this._hasEnabled) {
-			document.removeEventListener(
-				this._visibilityChange,
-				this._trackFunc,
-				false
-			);
-			window.removeEventListener(
-				'beforeunload',
-				this._trackBeforeUnload,
-				false
-			);
-			this._hasEnabled = false;
-		}
-
-		return this._config;
-	}
-}

package/src/trackers/index.ts

@@ -1,5 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export { PageViewTracker } from './PageViewTracker';
-export { EventTracker } from './EventTracker';
-export { SessionTracker } from './SessionTracker';

package/src/trackers/reactnative.ts

@@ -1,13 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { SessionTracker } from './SessionTracker-rn';
-
-class EventTracker {
-	constructor(tracker, opts) {}
-}
-
-class PageViewTracker {
-	constructor(tracker, opts) {}
-}
-
-export { EventTracker, PageViewTracker, SessionTracker };

package/src/types/Provider.ts

@@ -1,26 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-export interface PromiseHandlers {
-	resolve: Function;
-	reject: Function;
-}
-
-// CAUTION: The AnalyticsProvider interface is publicly available and allows customers to implement their own custom
-// analytics providers. Exercise caution when modifying this class as additive changes to this interface can break
-// customers when not marked as optional.
-export interface AnalyticsProvider {
-	// you need to implement those methods
-
-	// configure your provider
-	configure(config: object): object;
-
-	// record events and returns true if succeeds
-	record(params: object, handlers?: PromiseHandlers): Promise<boolean>;
-
-	// return 'Analytics';
-	getCategory(): string;
-
-	// return the name of you provider
-	getProviderName(): string;
-}

package/src/types/providers/AWSKinesisProvider.ts

@@ -1,8 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export interface KinesisAnalyticsEvent {
-	data: object | string;
-	partitionKey: string;
-	streamName: string;
-	immediate?: boolean;
-}

package/src/types/providers/AWSPinpointProvider.ts

@@ -1,60 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import { PromiseHandlers } from '../Provider';
-
-export type Event = {
-	eventId: string;
-	name: string;
-	attributes: string;
-	metrics: string;
-	session: object;
-	immediate: boolean;
-};
-
-export type EventConfig = {
-	appId: string;
-	endpointId: string;
-	region: string;
-	resendLimit: number;
-};
-
-export type EventParams = {
-	event: Event;
-	timestamp: string;
-	config: EventConfig;
-	credentials: object;
-	resendLimit: number;
-};
-
-export type EventObject = {
-	params: EventParams;
-	handlers: PromiseHandlers;
-};
-
-export type EventMap = {
-	[key: string]: EventObject;
-};
-
-export type EventBuffer = Array<EventMap>;
-export type EndpointBuffer = Array<EventObject>;
-
-export type PutEventsResponse = {
-	EventsResponse: {
-		Results?: {
-			[endpointId: string]: {
-				EventsItemResponse?: {
-					[eventId: string]: {
-						StatusCode?: number;
-						Message?: string;
-					};
-				};
-			};
-		};
-	};
-};
-
-export type EndpointFailureData = {
-	err: any;
-	update_params: any;
-	endpointObject: EventObject;
-};

package/src/types/providers/AmazonPersonalizeProvider.ts

@@ -1,9 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export interface PersonalizeAnalyticsEvent {
-	eventType?: string;
-	userId?: string;
-	properties?: {
-		[key: string]: string;
-	};
-}