@aws-amplify/analytics 7.0.1-unstable.cfbde4c.0 → 7.0.1

package/lib/providers/kinesis-firehose/utils/resolveConfig.d.ts

@@ -1,7 +0,0 @@
-export declare const resolveConfig: () => {
-    region: string;
-    bufferSize: number;
-    flushSize: number;
-    flushInterval: number;
-    resendLimit: number;
-};

package/lib/providers/personalize/apis/flushEvents.d.ts

@@ -1,8 +0,0 @@
-/**
- * Flushes all buffered Personalize events to the service.
- *
- * @note
- * This API will make a best-effort attempt to flush events from the buffer. Events recorded immediately after invoking
- * this API may not be included in the flush.
- */
-export declare const flushEvents: () => void;

package/lib/providers/personalize/apis/index.d.ts

@@ -1,2 +0,0 @@
-export { record } from './record';
-export { flushEvents } from './flushEvents';

package/lib/providers/personalize/apis/record.d.ts

@@ -1,2 +0,0 @@
-import { RecordInput } from '../types';
-export declare const record: ({ userId, eventId, eventType, properties, }: RecordInput) => void;

package/lib/providers/personalize/index.d.ts

@@ -1 +0,0 @@
-export { record, flushEvents } from './apis';

package/lib/providers/personalize/types/buffer.d.ts

@@ -1,16 +0,0 @@
-import { PersonalizeEvent } from './';
-import { EventBufferConfig } from '../../../utils';
-import { AWSCredentials } from '@aws-amplify/core/internals/utils';
-export type PersonalizeBufferEvent = {
-    trackingId: string;
-    sessionId?: string;
-    userId?: string;
-    event: PersonalizeEvent;
-    timestamp: number;
-};
-export type PersonalizeBufferConfig = EventBufferConfig & {
-    region: string;
-    credentials: AWSCredentials;
-    identityId?: string;
-    userAgentValue?: string;
-};

package/lib/providers/personalize/types/index.d.ts

@@ -1,2 +0,0 @@
-export { RecordInput, PersonalizeEvent } from './inputs';
-export { PersonalizeBufferEvent, PersonalizeBufferConfig } from './buffer';

package/lib/providers/personalize/types/inputs.d.ts

@@ -1,7 +0,0 @@
-export type PersonalizeEvent = {
-    userId?: string;
-    eventId?: string;
-    eventType: string;
-    properties: Record<string, unknown>;
-};
-export type RecordInput = PersonalizeEvent;

package/lib/providers/personalize/utils/autoTrackMedia.d.ts

@@ -1,10 +0,0 @@
-import { EventBuffer } from '../../../utils';
-import { PersonalizeBufferEvent, PersonalizeEvent } from '../types';
-type MediaAutoTrackConfig = {
-    trackingId: string;
-    sessionId: string;
-    userId?: string;
-    event: PersonalizeEvent;
-};
-export declare const autoTrackMedia: (config: MediaAutoTrackConfig, eventBuffer: EventBuffer<PersonalizeBufferEvent>) => Promise<void>;
-export {};

package/lib/providers/personalize/utils/cachedSession.d.ts

@@ -1,5 +0,0 @@
-export declare const resolveCachedSession: () => Promise<{
-    sessionId: string;
-    userId: string | undefined;
-}>;
-export declare const updateCachedSession: (newUserId?: string, currentSessionId?: string, currentUserId?: string) => void;

package/lib/providers/personalize/utils/constants.d.ts

@@ -1,7 +0,0 @@
-export declare const DEFAULT_PERSONALIZE_CONFIG: {
-    flushSize: number;
-    flushInterval: number;
-};
-export declare const PERSONALIZE_FLUSH_SIZE_MAX = 10;
-export declare const IDENTIFY_EVENT_TYPE = "Identify";
-export declare const MEDIA_AUTO_TRACK_EVENT_TYPE = "MediaAutoTrack";

package/lib/providers/personalize/utils/getEventBuffer.d.ts

@@ -1,3 +0,0 @@
-import { EventBuffer } from '../../../utils';
-import { PersonalizeBufferConfig, PersonalizeBufferEvent } from '../types';
-export declare const getEventBuffer: ({ region, flushSize, flushInterval, bufferSize, credentials, identityId, userAgentValue, }: PersonalizeBufferConfig) => EventBuffer<PersonalizeBufferEvent>;

package/lib/providers/personalize/utils/index.d.ts

@@ -1,5 +0,0 @@
-export { getEventBuffer } from './getEventBuffer';
-export { resolveConfig } from './resolveConfig';
-export { autoTrackMedia } from './autoTrackMedia';
-export { resolveCachedSession, updateCachedSession } from './cachedSession';
-export { DEFAULT_PERSONALIZE_CONFIG, PERSONALIZE_FLUSH_SIZE_MAX, } from './constants';

package/lib/providers/personalize/utils/resolveConfig.d.ts

@@ -1,7 +0,0 @@
-export declare const resolveConfig: () => {
-    region: string;
-    trackingId: string;
-    bufferSize: number;
-    flushSize: number;
-    flushInterval: number;
-};

package/lib/providers/pinpoint/apis/configureAutoTrack.d.ts

@@ -1,15 +0,0 @@
-import { ConfigureAutoTrackInput } from '../types';
-/**
- * Configures automatic event tracking for Pinpoint. This API will automatically transmit an analytic event when
- * configured events are detected within your application. This can include: DOM element events (via the `event`
- * tracker), session events (via the `session` tracker), and page view events (via the `pageView` tracker).
- *
- * @remark Only session tracking is currently supported on React Native.
- *
- * @param {ConfigureAutoTrackInput} params The input object to configure auto track behavior.
- *
- * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
- * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
- *  configuration is incorrect.
- */
-export declare const configureAutoTrack: (input: ConfigureAutoTrackInput) => void;

package/lib/providers/pinpoint/apis/flushEvents.d.ts

@@ -1,8 +0,0 @@
-/**
- * Flushes all buffered Pinpoint events to the service.
- *
- * @note
- * This API will make a best-effort attempt to flush events from the buffer. Events recorded immediately after invoking
- * this API may not be included in the flush.
- */
-export declare const flushEvents: () => void;

package/lib/providers/pinpoint/apis/identifyUser.d.ts

@@ -1,47 +0,0 @@
-import { IdentifyUserInput } from '../types';
-/**
- * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
- * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
- * the same `userId`.
- *
- * @param {IdentifyUserParameters} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
- *  API.
- *
- * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
- * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
- *  configuration is incorrect.
- *
- * @returns A promise that will resolve when the operation is complete.
- *
- * @example
- * ```ts
- * // Identify a user with Pinpoint
- * await identifyUser({
- *     userId,
- *     userProfile: {
- *         email: 'userEmail@example.com'
- *         customProperties: {
- *             phoneNumber: ['555-555-5555'],
- *         },
- *     }
- * });
- * ```
- *
- * @example
- * ```ts
- * // Identify a user with Pinpoint with some additional demographics
- * await identifyUser({
- *     userId,
- *     userProfile: {
- *         email: 'userEmail@example.com'
- *         customProperties: {
- *             phoneNumber: ['555-555-5555'],
- *         },
- *         demographic: {
- *             platform: 'ios',
- *             timezone: 'America/Los_Angeles'
- *         }
- *     }
- * });
- */
-export declare const identifyUser: ({ userId, userProfile, options, }: IdentifyUserInput) => Promise<void>;

package/lib/providers/pinpoint/apis/index.d.ts

@@ -1,4 +0,0 @@
-export { record } from './record';
-export { identifyUser } from './identifyUser';
-export { configureAutoTrack } from './configureAutoTrack';
-export { flushEvents } from './flushEvents';

package/lib/providers/pinpoint/apis/record.d.ts

@@ -1,30 +0,0 @@
-import { RecordInput } from '../types';
-/**
- * Records an Analytic event to Pinpoint. Events will be buffered and periodically sent to Pinpoint.
- *
- * @param {RecordInput} params The input object used to construct the request.
- *
- * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
- *  configuration is incorrect.
- *
- * @example
- * ```ts
- * // Send an event to Pinpoint
- * record({ name: eventName })
- * ```
- *
- * @example
- * ```ts
- * // Send an event to Pinpoint with metrics & custom attributes
- * record({
- *     name: eventName,
- *     attributes: {
- *         'my-attribute': attributeValue
- *     },
- *     metrics: {
- *         'my-metric': metricValue
- *     }
- * })
- * ```
- */
-export declare const record: (input: RecordInput) => void;

package/lib/providers/pinpoint/index.d.ts

@@ -1,2 +0,0 @@
-export { record, identifyUser, flushEvents, configureAutoTrack } from './apis';
-export { RecordInput, IdentifyUserInput, ConfigureAutoTrackInput, } from './types/inputs';

package/lib/providers/pinpoint/types/index.d.ts

@@ -1,2 +0,0 @@
-export { RecordInput, IdentifyUserInput, ConfigureAutoTrackInput, } from './inputs';
-export { IdentifyUserOptions } from './options';

package/lib/providers/pinpoint/types/inputs.d.ts

@@ -1,15 +0,0 @@
-import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
-import { IdentifyUserOptions } from '.';
-import { AnalyticsConfigureAutoTrackInput, AnalyticsIdentifyUserInput } from '../../../types';
-/**
- * Input type for Pinpoint record API.
- */
-export type RecordInput = PinpointAnalyticsEvent;
-/**
- * Input type for Pinpoint identifyUser API.
- */
-export type IdentifyUserInput = AnalyticsIdentifyUserInput<IdentifyUserOptions>;
-/**
- * Input type for Pinpoint configureAutoTrack API.
- */
-export type ConfigureAutoTrackInput = AnalyticsConfigureAutoTrackInput;

package/lib/providers/pinpoint/types/options.d.ts

@@ -1,5 +0,0 @@
-import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
-/**
- * Options specific to Pinpoint identityUser.
- */
-export type IdentifyUserOptions = Pick<PinpointServiceOptions, 'userAttributes'>;

package/lib/providers/pinpoint/utils/index.d.ts

@@ -1,2 +0,0 @@
-export { resolveConfig } from './resolveConfig';
-export { resolveCredentials } from './resolveCredentials';

package/lib/providers/pinpoint/utils/resolveConfig.d.ts

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare const resolveConfig: () => {
-    appId: string;
-    region: string;
-};

package/lib/providers/pinpoint/utils/resolveCredentials.d.ts

@@ -1,7 +0,0 @@
-/**
- * @internal
- */
-export declare const resolveCredentials: () => Promise<{
-    credentials: import("@aws-amplify/core/lib-esm/libraryUtils").AWSCredentials;
-    identityId: string | undefined;
-}>;

package/lib/setupTests.d.ts

@@ -1 +0,0 @@
-declare const anyGlobal: any;

package/lib/trackers/EventTracker.d.ts

@@ -1,10 +0,0 @@
-import { EventTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
-export declare class EventTracker implements TrackerInterface {
-    private trackerActive;
-    private options;
-    private eventRecorder;
-    constructor(eventRecorder: TrackerEventRecorder, options?: EventTrackingOptions);
-    configure(eventRecorder: TrackerEventRecorder, options?: EventTrackingOptions): void;
-    cleanup(): void;
-    private handleDocEvent;
-}

package/lib/trackers/PageViewTracker.d.ts

@@ -1,18 +0,0 @@
-import { PageViewTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
-export declare class PageViewTracker implements TrackerInterface {
-    private trackerActive;
-    private options;
-    private eventRecorder;
-    private spaTrackingActive;
-    private pushStateProxy?;
-    private replaceStateProxy?;
-    private originalPushState;
-    private originalReplaceState;
-    constructor(eventRecorder: TrackerEventRecorder, options?: PageViewTrackingOptions);
-    configure(eventRecorder: TrackerEventRecorder, options?: PageViewTrackingOptions): void;
-    cleanup(): void;
-    private setupSPATracking;
-    private setupMPATracking;
-    private handleLocationChange;
-    private urlHasChanged;
-}

package/lib/trackers/SessionTracker.d.ts

@@ -1,13 +0,0 @@
-import { SessionTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
-export declare class SessionTracker implements TrackerInterface {
-    private options;
-    private eventRecorder;
-    private sessionTrackingActive;
-    private initialEventSent;
-    constructor(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions);
-    configure(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions): void;
-    cleanup(): void;
-    private handleStateChange;
-    private sessionStarted;
-    private sessionStopped;
-}

package/lib/trackers/SessionTracker.native.d.ts

@@ -1,13 +0,0 @@
-import { SessionTrackingOptions, TrackerEventRecorder, TrackerInterface } from '../types/trackers';
-export declare class SessionTracker implements TrackerInterface {
-    private options;
-    private eventRecorder;
-    private initialEventSent;
-    private sessionTrackingActive;
-    constructor(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions);
-    configure(eventRecorder: TrackerEventRecorder, options?: SessionTrackingOptions): void;
-    cleanup(): void;
-    private handleStateChange;
-    private sessionStarted;
-    private sessionStopped;
-}

package/lib/trackers/index.d.ts

@@ -1,3 +0,0 @@
-export { EventTracker } from './EventTracker';
-export { PageViewTracker } from './PageViewTracker';
-export { SessionTracker } from './SessionTracker';