@amplitude/analytics-core 2.5.6 → 2.6.0

package/lib/esm/types/browser-config.d.ts

@@ -0,0 +1,216 @@
+import { UserSession } from './user-session';
+import { IdentityStorageType, Storage } from './storage';
+import { Transport } from './transport';
+import { IConfig } from '../config';
+import { ElementInteractionsOptions } from './element-interactions';
+import { PageTrackingOptions } from './page-view-tracking';
+export interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {
+}
+export interface ExternalBrowserConfig extends IConfig {
+    /**
+     * An app version for events tracked. This can be the version of your application.
+     * @defaultValue `undefined`
+     */
+    appVersion?: string;
+    /**
+     * @deprecated This property is deprecated and will be removed in future versions. Please migrate to using `autocapture` instead.
+     * The default event tracking configuration.
+     * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#tracking-default-events}.
+     * @defaultValue `true`
+     */
+    defaultTracking?: boolean | DefaultTrackingOptions;
+    /**
+     * The configurations for auto-captured events.
+     * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/autocapture/}.
+     */
+    autocapture?: boolean | AutocaptureOptions;
+    /**
+     * The identifier for the device running your application.
+     * @defaultValue `UUID()`
+     */
+    deviceId?: string;
+    /**
+     * Configuration for cookie.
+     */
+    cookieOptions?: CookieOptions;
+    /**
+     * The storage for user identify.
+     * @defaultValue `"cookie"`
+     */
+    identityStorage?: IdentityStorageType;
+    /**
+     * The partner identifier.
+     * Amplitude requires the customer who built an event ingestion integration to add the partner identifier to partner_id.
+     * @defaultValue `undefined`
+     */
+    partnerId?: string;
+    /**
+     * The custom Session ID for the current session.
+     * @defaultValue `timestamp`
+     */
+    sessionId?: number;
+    /**
+     * The period of inactivity from the last tracked event before a session expires in milliseconds.
+     * @defaultValue `1,800,000` (30 minutes)
+     */
+    sessionTimeout: number;
+    /**
+     * The configurations for tracking additional properties.
+     * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#optional-tracking}.
+     */
+    trackingOptions: TrackingOptions;
+    /**
+     * Network transport mechanism used to send events.
+     * @defaultValue `"fetch"`
+     */
+    transport?: 'fetch' | 'xhr' | 'beacon';
+    /**
+     * The identifier for the user being tracked.
+     * @defaultValue `undefined`
+     */
+    userId?: string;
+    /**
+     * User's Nth instance of performing a default Page Viewed event within a session.
+     * Used for landing page analysis.
+     */
+    pageCounter?: number;
+    /**
+     * Whether to fetch remote configuration.
+     * @defaultValue `false`
+     */
+    fetchRemoteConfig?: boolean;
+}
+interface InternalBrowserConfig {
+    cookieStorage: Storage<UserSession>;
+    lastEventTime?: number;
+    lastEventId?: number;
+    transportProvider: Transport;
+}
+/**
+ * @deprecated This interface is deprecated and will be removed in future versions. Please migrate to using `AutocaptureOptions` instead.
+ */
+export interface DefaultTrackingOptions {
+    /**
+     * Enables/disables marketing attribution tracking or config with detailed attribution options.
+     * @defaultValue `true`
+     */
+    attribution?: boolean | AttributionOptions;
+    /**
+     * Enables/disables form downloads tracking.
+     * @defaultValue `true`
+     */
+    fileDownloads?: boolean;
+    /**
+     * Enables/disables form interaction tracking.
+     * @defaultValue `true`
+     */
+    formInteractions?: boolean;
+    /**
+     * Enables/disables default page view tracking.
+     * @defaultValue `true`
+     */
+    pageViews?: boolean | PageTrackingOptions;
+    /**
+     * Enables/disables session tracking.
+     * @defaultValue `true`
+     */
+    sessions?: boolean;
+}
+export interface AutocaptureOptions {
+    /**
+     * Enables/disables marketing attribution tracking or config with detailed attribution options.
+     * @defaultValue `true`
+     */
+    attribution?: boolean | AttributionOptions;
+    /**
+     * Enables/disables form downloads tracking.
+     * @defaultValue `true`
+     */
+    fileDownloads?: boolean;
+    /**
+     * Enables/disables form interaction tracking.
+     * @defaultValue `true`
+     */
+    formInteractions?: boolean;
+    /**
+     * Enables/disables default page view tracking.
+     * @defaultValue `true`
+     */
+    pageViews?: boolean | PageTrackingOptions;
+    /**
+     * Enables/disables session tracking.
+     * @defaultValue `true`
+     */
+    sessions?: boolean;
+    /**
+     * Enables/disables user interactions tracking.
+     * @defaultValue `false`
+     */
+    elementInteractions?: boolean | ElementInteractionsOptions;
+}
+export interface TrackingOptions {
+    /**
+     * Enables/disables ip address tracking.
+     * @defaultValue `true`
+     */
+    ipAddress?: boolean;
+    /**
+     * Enables/disables language tracking.
+     * @defaultValue `true`
+     */
+    language?: boolean;
+    /**
+     * Enables/disables plantform tracking.
+     * @defaultValue `true`
+     */
+    platform?: boolean;
+}
+export interface AttributionOptions {
+    /**
+     * The rules to determine which referrers are excluded from being tracked as traffic source.
+     * @defaultValue `[/your-domain\.com$/]`
+     */
+    excludeReferrers?: (string | RegExp)[];
+    /**
+     * The value to represent undefined/no initial campaign parameter for first-touch attribution.
+     * @defaultValue `"EMPTY"`
+     */
+    initialEmptyValue?: string;
+    /**
+     * The flag of if Amplitude to start a new session if any campaign parameter changes.
+     * @defaultValue `false`
+     */
+    resetSessionOnNewCampaign?: boolean;
+}
+export interface CookieOptions {
+    /**
+     * The domain property of cookies created.
+     * @defaultValue `Your top level domain`
+     */
+    domain?: string;
+    /**
+     * The expiration of cookies created in days.
+     * @defaultValue `365`
+     */
+    expiration?: number;
+    /**
+     * How cookies are sent with cross-site requests.
+     * @defaultValue `"Lax"`
+     */
+    sameSite?: 'Strict' | 'Lax' | 'None';
+    /**
+     * The flag of if send cookies over secure protocols.
+     * @defaultValue `false`
+     */
+    secure?: boolean;
+    /**
+     * The flag of if upgrade the cookies created by maintenance Browser SDK.
+     * @defaultValue `true`
+     */
+    upgrade?: boolean;
+}
+type HiddenOptions = 'apiKey' | 'transportProvider' | 'requestMetadata';
+export interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {
+}
+export {};
+//# sourceMappingURL=browser-config.d.ts.map

package/lib/esm/types/browser-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-config.d.ts","sourceRoot":"","sources":["../../../src/types/browser-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAE3D,MAAM,WAAW,aAAc,SAAQ,qBAAqB,EAAE,qBAAqB;CAAG;AAEtF,MAAM,WAAW,qBAAsB,SAAQ,OAAO;IACpD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACnD;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC3C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;OAGG;IACH,eAAe,CAAC,EAAE,mBAAmB,CAAC;IACtC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,eAAe,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;IACvC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,UAAU,qBAAqB;IAC7B,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,SAAS,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC3C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,0BAA0B,CAAC;CAC5D;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACvC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;IACrC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,KAAK,aAAa,GAAG,QAAQ,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAGxE,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,aAAa,CAAC;CAAG"}

package/lib/esm/types/browser-config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=browser-config.js.map

package/lib/esm/types/browser-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-config.js","sourceRoot":"","sources":["../../../src/types/browser-config.ts"],"names":[],"mappings":"","sourcesContent":["import { UserSession } from './user-session';\nimport { IdentityStorageType, Storage } from './storage';\nimport { Transport } from './transport';\nimport { IConfig } from '../config';\nimport { ElementInteractionsOptions } from './element-interactions';\nimport { PageTrackingOptions } from './page-view-tracking';\n\nexport interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {}\n\nexport interface ExternalBrowserConfig extends IConfig {\n  /**\n   * An app version for events tracked. This can be the version of your application.\n   * @defaultValue `undefined`\n   */\n  appVersion?: string;\n  /**\n   * @deprecated This property is deprecated and will be removed in future versions. Please migrate to using `autocapture` instead.\n   * The default event tracking configuration.\n   * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#tracking-default-events}.\n   * @defaultValue `true`\n   */\n  defaultTracking?: boolean | DefaultTrackingOptions;\n  /**\n   * The configurations for auto-captured events.\n   * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/autocapture/}.\n   */\n  autocapture?: boolean | AutocaptureOptions;\n  /**\n   * The identifier for the device running your application.\n   * @defaultValue `UUID()`\n   */\n  deviceId?: string;\n  /**\n   * Configuration for cookie.\n   */\n  cookieOptions?: CookieOptions;\n  /**\n   * The storage for user identify.\n   * @defaultValue `\"cookie\"`\n   */\n  identityStorage?: IdentityStorageType;\n  /**\n   * The partner identifier.\n   * Amplitude requires the customer who built an event ingestion integration to add the partner identifier to partner_id.\n   * @defaultValue `undefined`\n   */\n  partnerId?: string;\n  /**\n   * The custom Session ID for the current session.\n   * @defaultValue `timestamp`\n   */\n  sessionId?: number;\n  /**\n   * The period of inactivity from the last tracked event before a session expires in milliseconds.\n   * @defaultValue `1,800,000` (30 minutes)\n   */\n  sessionTimeout: number;\n  /**\n   * The configurations for tracking additional properties.\n   * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#optional-tracking}.\n   */\n  trackingOptions: TrackingOptions;\n  /**\n   * Network transport mechanism used to send events.\n   * @defaultValue `\"fetch\"`\n   */\n  transport?: 'fetch' | 'xhr' | 'beacon';\n  /**\n   * The identifier for the user being tracked.\n   * @defaultValue `undefined`\n   */\n  userId?: string;\n  /**\n   * User's Nth instance of performing a default Page Viewed event within a session.\n   * Used for landing page analysis.\n   */\n  pageCounter?: number;\n  /**\n   * Whether to fetch remote configuration.\n   * @defaultValue `false`\n   */\n  fetchRemoteConfig?: boolean;\n}\n\ninterface InternalBrowserConfig {\n  cookieStorage: Storage<UserSession>;\n  lastEventTime?: number;\n  lastEventId?: number;\n  transportProvider: Transport;\n}\n\n/**\n * @deprecated This interface is deprecated and will be removed in future versions. Please migrate to using `AutocaptureOptions` instead.\n */\nexport interface DefaultTrackingOptions {\n  /**\n   * Enables/disables marketing attribution tracking or config with detailed attribution options.\n   * @defaultValue `true`\n   */\n  attribution?: boolean | AttributionOptions;\n  /**\n   * Enables/disables form downloads tracking.\n   * @defaultValue `true`\n   */\n  fileDownloads?: boolean;\n  /**\n   * Enables/disables form interaction tracking.\n   * @defaultValue `true`\n   */\n  formInteractions?: boolean;\n  /**\n   * Enables/disables default page view tracking.\n   * @defaultValue `true`\n   */\n  pageViews?: boolean | PageTrackingOptions;\n  /**\n   * Enables/disables session tracking.\n   * @defaultValue `true`\n   */\n  sessions?: boolean;\n}\n\nexport interface AutocaptureOptions {\n  /**\n   * Enables/disables marketing attribution tracking or config with detailed attribution options.\n   * @defaultValue `true`\n   */\n  attribution?: boolean | AttributionOptions;\n  /**\n   * Enables/disables form downloads tracking.\n   * @defaultValue `true`\n   */\n  fileDownloads?: boolean;\n  /**\n   * Enables/disables form interaction tracking.\n   * @defaultValue `true`\n   */\n  formInteractions?: boolean;\n  /**\n   * Enables/disables default page view tracking.\n   * @defaultValue `true`\n   */\n  pageViews?: boolean | PageTrackingOptions;\n  /**\n   * Enables/disables session tracking.\n   * @defaultValue `true`\n   */\n  sessions?: boolean;\n  /**\n   * Enables/disables user interactions tracking.\n   * @defaultValue `false`\n   */\n  elementInteractions?: boolean | ElementInteractionsOptions;\n}\n\nexport interface TrackingOptions {\n  /**\n   * Enables/disables ip address tracking.\n   * @defaultValue `true`\n   */\n  ipAddress?: boolean;\n  /**\n   * Enables/disables language tracking.\n   * @defaultValue `true`\n   */\n  language?: boolean;\n  /**\n   * Enables/disables plantform tracking.\n   * @defaultValue `true`\n   */\n  platform?: boolean;\n}\n\nexport interface AttributionOptions {\n  /**\n   * The rules to determine which referrers are excluded from being tracked as traffic source.\n   * @defaultValue `[/your-domain\\.com$/]`\n   */\n  excludeReferrers?: (string | RegExp)[];\n  /**\n   * The value to represent undefined/no initial campaign parameter for first-touch attribution.\n   * @defaultValue `\"EMPTY\"`\n   */\n  initialEmptyValue?: string;\n  /**\n   * The flag of if Amplitude to start a new session if any campaign parameter changes.\n   * @defaultValue `false`\n   */\n  resetSessionOnNewCampaign?: boolean;\n}\n\nexport interface CookieOptions {\n  /**\n   * The domain property of cookies created.\n   * @defaultValue `Your top level domain`\n   */\n  domain?: string;\n  /**\n   * The expiration of cookies created in days.\n   * @defaultValue `365`\n   */\n  expiration?: number;\n  /**\n   * How cookies are sent with cross-site requests.\n   * @defaultValue `\"Lax\"`\n   */\n  sameSite?: 'Strict' | 'Lax' | 'None';\n  /**\n   * The flag of if send cookies over secure protocols.\n   * @defaultValue `false`\n   */\n  secure?: boolean;\n  /**\n   * The flag of if upgrade the cookies created by maintenance Browser SDK.\n   * @defaultValue `true`\n   */\n  upgrade?: boolean;\n}\n\ntype HiddenOptions = 'apiKey' | 'transportProvider' | 'requestMetadata';\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {}\n"]}

package/lib/esm/types/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/types/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,MAAM,CAAC;AAC/B,eAAO,MAAM,gBAAgB,QAAQ,CAAC;AACtC,eAAO,MAAM,cAAc,QAA+B,CAAC;AAC3D,eAAO,MAAM,oBAAoB,yCAAyC,CAAC;AAC3E,eAAO,MAAM,uBAAuB,2CAA2C,CAAC;AAChF,eAAO,MAAM,0BAA0B,qCAAqC,CAAC;AAC7E,eAAO,MAAM,6BAA6B,uCAAuC,CAAC"}

package/lib/esm/types/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/types/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,IAAM,WAAW,GAAG,GAAG,CAAC;AAC/B,MAAM,CAAC,IAAM,gBAAgB,GAAG,KAAK,CAAC;AACtC,MAAM,CAAC,IAAM,cAAc,GAAG,UAAG,gBAAgB,YAAS,CAAC;AAC3D,MAAM,CAAC,IAAM,oBAAoB,GAAG,sCAAsC,CAAC;AAC3E,MAAM,CAAC,IAAM,uBAAuB,GAAG,wCAAwC,CAAC;AAChF,MAAM,CAAC,IAAM,0BAA0B,GAAG,kCAAkC,CAAC;AAC7E,MAAM,CAAC,IAAM,6BAA6B,GAAG,oCAAoC,CAAC","sourcesContent":["export const UNSET_VALUE = '-';\nexport const AMPLITUDE_PREFIX = 'AMP';\nexport const STORAGE_PREFIX = `${AMPLITUDE_PREFIX}_unsent`;\nexport const AMPLITUDE_SERVER_URL = 'https://api2.amplitude.com/2/httpapi';\nexport const EU_AMPLITUDE_SERVER_URL = 'https://api.eu.amplitude.com/2/httpapi';\nexport const AMPLITUDE_BATCH_SERVER_URL = 'https://api2.amplitude.com/batch';\nexport const EU_AMPLITUDE_BATCH_SERVER_URL = 'https://api.eu.amplitude.com/batch';\n"]}

package/lib/esm/types/element-interactions.d.ts

@@ -0,0 +1,73 @@
+import { ILogger } from '../logger';
+export type ActionType = 'click' | 'change';
+/**
+ * Default CSS selectors to define which elements on the page to track.
+ * Extend this list to include additional elements to track. For example:
+ * ```
+ * autocapturePlugin({
+ *    cssSelectorAllowlist: [...DEFAULT_CSS_SELECTOR_ALLOWLIST, ".my-class"],
+ * })
+ * ```
+ */
+export declare const DEFAULT_CSS_SELECTOR_ALLOWLIST: string[];
+/**
+ * Default prefix to allow the plugin to capture data attributes as an event property.
+ */
+export declare const DEFAULT_DATA_ATTRIBUTE_PREFIX = "data-amp-track-";
+/**
+ * Default list of elements on the page should be tracked when the page changes.
+ */
+export declare const DEFAULT_ACTION_CLICK_ALLOWLIST: string[];
+export interface ElementInteractionsOptions {
+    /**
+     * List of CSS selectors to allow auto tracking on.
+     * When provided, allow elements matching any selector to be tracked.
+     * Default is ['a', 'button', 'input', 'select', 'textarea', 'label', '[data-amp-default-track]', '.amp-default-track'].
+     */
+    cssSelectorAllowlist?: string[];
+    /**
+     * List of page URLs to allow auto tracking on.
+     * When provided, only allow tracking on these URLs.
+     * Both full URLs and regex are supported.
+     */
+    pageUrlAllowlist?: (string | RegExp)[];
+    /**
+     * Function to determine whether an event should be tracked.
+     * When provided, this function overwrites all other allowlists and configurations.
+     * If the function returns true, the event will be tracked.
+     * If the function returns false, the event will not be tracked.
+     * @param actionType - The type of action that triggered the event.
+     * @param element - The [Element](https://developer.mozilla.org/en-US/docs/Web/API/Element) that triggered the event.
+     */
+    shouldTrackEventResolver?: (actionType: ActionType, element: DomElement) => boolean;
+    /**
+     * Prefix for data attributes to allow auto collecting.
+     * Default is 'data-amp-track-'.
+     */
+    dataAttributePrefix?: string;
+    /**
+     * Options for integrating visual tagging selector.
+     */
+    visualTaggingOptions?: {
+        enabled?: boolean;
+        messenger?: Messenger;
+    };
+    /**
+     * Debounce time in milliseconds for tracking events.
+     * This is used to detect rage clicks.
+     */
+    debounceTime?: number;
+    /**
+     * CSS selector allowlist for tracking clicks that result in a DOM change/navigation on elements not already allowed by the cssSelectorAllowlist
+     */
+    actionClickAllowlist?: string[];
+}
+export interface Messenger {
+    logger?: ILogger;
+    setup: () => void;
+}
+type DomElement = typeof globalThis extends {
+    Element: new (...args: any) => infer T;
+} ? T : never;
+export {};
+//# sourceMappingURL=element-interactions.d.ts.map

package/lib/esm/types/element-interactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-interactions.d.ts","sourceRoot":"","sources":["../../../src/types/element-interactions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5C;;;;;;;;GAQG;AACH,eAAO,MAAM,8BAA8B,UAY1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,oBAAoB,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,8BAA8B,UAAsD,CAAC;AAElG,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAEvC;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,KAAK,OAAO,CAAC;IAEpF;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,CAAC,EAAE,SAAS,CAAC;KACvB,CAAC;IAEF;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,SAAS;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAKD,KAAK,UAAU,GAAG,OAAO,UAAU,SAAS;IAC1C,OAAO,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,KAAK,MAAM,CAAC,CAAC;CACxC,GACG,CAAC,GACD,KAAK,CAAC"}

package/lib/esm/types/element-interactions.js

@@ -0,0 +1,31 @@
+/**
+ * Default CSS selectors to define which elements on the page to track.
+ * Extend this list to include additional elements to track. For example:
+ * ```
+ * autocapturePlugin({
+ *    cssSelectorAllowlist: [...DEFAULT_CSS_SELECTOR_ALLOWLIST, ".my-class"],
+ * })
+ * ```
+ */
+export var DEFAULT_CSS_SELECTOR_ALLOWLIST = [
+    'a',
+    'button',
+    'input',
+    'select',
+    'textarea',
+    'label',
+    'video',
+    'audio',
+    '[contenteditable="true" i]',
+    '[data-amp-default-track]',
+    '.amp-default-track',
+];
+/**
+ * Default prefix to allow the plugin to capture data attributes as an event property.
+ */
+export var DEFAULT_DATA_ATTRIBUTE_PREFIX = 'data-amp-track-';
+/**
+ * Default list of elements on the page should be tracked when the page changes.
+ */
+export var DEFAULT_ACTION_CLICK_ALLOWLIST = ['div', 'span', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
+//# sourceMappingURL=element-interactions.js.map

package/lib/esm/types/element-interactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"element-interactions.js","sourceRoot":"","sources":["../../../src/types/element-interactions.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,MAAM,CAAC,IAAM,8BAA8B,GAAG;IAC5C,GAAG;IACH,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,UAAU;IACV,OAAO;IACP,OAAO;IACP,OAAO;IACP,4BAA4B;IAC5B,0BAA0B;IAC1B,oBAAoB;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,IAAM,6BAA6B,GAAG,iBAAiB,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,IAAM,8BAA8B,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC","sourcesContent":["import { ILogger } from '../logger';\n\nexport type ActionType = 'click' | 'change';\n\n/**\n * Default CSS selectors to define which elements on the page to track.\n * Extend this list to include additional elements to track. For example:\n * ```\n * autocapturePlugin({\n *    cssSelectorAllowlist: [...DEFAULT_CSS_SELECTOR_ALLOWLIST, \".my-class\"],\n * })\n * ```\n */\nexport const DEFAULT_CSS_SELECTOR_ALLOWLIST = [\n  'a',\n  'button',\n  'input',\n  'select',\n  'textarea',\n  'label',\n  'video',\n  'audio',\n  '[contenteditable=\"true\" i]',\n  '[data-amp-default-track]',\n  '.amp-default-track',\n];\n\n/**\n * Default prefix to allow the plugin to capture data attributes as an event property.\n */\nexport const DEFAULT_DATA_ATTRIBUTE_PREFIX = 'data-amp-track-';\n\n/**\n * Default list of elements on the page should be tracked when the page changes.\n */\nexport const DEFAULT_ACTION_CLICK_ALLOWLIST = ['div', 'span', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'];\n\nexport interface ElementInteractionsOptions {\n  /**\n   * List of CSS selectors to allow auto tracking on.\n   * When provided, allow elements matching any selector to be tracked.\n   * Default is ['a', 'button', 'input', 'select', 'textarea', 'label', '[data-amp-default-track]', '.amp-default-track'].\n   */\n  cssSelectorAllowlist?: string[];\n\n  /**\n   * List of page URLs to allow auto tracking on.\n   * When provided, only allow tracking on these URLs.\n   * Both full URLs and regex are supported.\n   */\n  pageUrlAllowlist?: (string | RegExp)[];\n\n  /**\n   * Function to determine whether an event should be tracked.\n   * When provided, this function overwrites all other allowlists and configurations.\n   * If the function returns true, the event will be tracked.\n   * If the function returns false, the event will not be tracked.\n   * @param actionType - The type of action that triggered the event.\n   * @param element - The [Element](https://developer.mozilla.org/en-US/docs/Web/API/Element) that triggered the event.\n   */\n  shouldTrackEventResolver?: (actionType: ActionType, element: DomElement) => boolean;\n\n  /**\n   * Prefix for data attributes to allow auto collecting.\n   * Default is 'data-amp-track-'.\n   */\n  dataAttributePrefix?: string;\n\n  /**\n   * Options for integrating visual tagging selector.\n   */\n  visualTaggingOptions?: {\n    enabled?: boolean;\n    messenger?: Messenger;\n  };\n\n  /**\n   * Debounce time in milliseconds for tracking events.\n   * This is used to detect rage clicks.\n   */\n  debounceTime?: number;\n\n  /**\n   * CSS selector allowlist for tracking clicks that result in a DOM change/navigation on elements not already allowed by the cssSelectorAllowlist\n   */\n  actionClickAllowlist?: string[];\n}\n\nexport interface Messenger {\n  logger?: ILogger;\n  setup: () => void;\n}\n\n// DomElement is [Element](https://developer.mozilla.org/en-US/docs/Web/API/Element) if the dom library is included in tsconfig.json\n// and never if it is not included\n// eslint-disable-next-line no-restricted-globals\ntype DomElement = typeof globalThis extends {\n  Element: new (...args: any) => infer T;\n}\n  ? T\n  : never;\n"]}

package/lib/esm/types/event/base-event.d.ts

@@ -0,0 +1,64 @@
+import { Plan } from './plan';
+import { IngestionMetadataEventProperty } from './ingestion-metadata';
+export interface BaseEvent extends EventOptions {
+    event_type: string;
+    event_properties?: {
+        [key: string]: any;
+    } | undefined;
+    user_properties?: {
+        [key: string]: any;
+    } | undefined;
+    group_properties?: {
+        [key: string]: any;
+    } | undefined;
+}
+export interface EventOptions {
+    user_id?: string;
+    device_id?: string;
+    time?: number;
+    location_lat?: number;
+    location_lng?: number;
+    app_version?: string;
+    version_name?: string;
+    library?: string;
+    platform?: string;
+    os_name?: string;
+    os_version?: string;
+    device_brand?: string;
+    device_manufacturer?: string;
+    device_model?: string;
+    carrier?: string;
+    country?: string;
+    region?: string;
+    city?: string;
+    dma?: string;
+    idfa?: string;
+    idfv?: string;
+    adid?: string;
+    android_id?: string;
+    language?: string;
+    ip?: string;
+    price?: number;
+    quantity?: number;
+    revenue?: number;
+    receipt?: string;
+    receiptSig?: string;
+    productId?: string;
+    revenueType?: string;
+    currency?: string;
+    event_id?: number;
+    session_id?: number;
+    insert_id?: string;
+    plan?: Plan;
+    ingestion_metadata?: IngestionMetadataEventProperty;
+    partner_id?: string;
+    user_agent?: string;
+    android_app_set_id?: string;
+    extra?: {
+        [key: string]: any;
+    };
+    groups?: {
+        [key: string]: any;
+    } | undefined;
+}
+//# sourceMappingURL=base-event.d.ts.map

package/lib/esm/types/event/base-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-event.d.ts","sourceRoot":"","sources":["../../../../src/types/event/base-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAC;AAEtE,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;IACtD,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;IACrD,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CACvD;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,kBAAkB,CAAC,EAAE,8BAA8B,CAAC;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC/B,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CAC7C"}

package/lib/esm/types/event/base-event.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=base-event.js.map

package/lib/esm/types/event/base-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-event.js","sourceRoot":"","sources":["../../../../src/types/event/base-event.ts"],"names":[],"mappings":"","sourcesContent":["import { Plan } from './plan';\nimport { IngestionMetadataEventProperty } from './ingestion-metadata';\n\nexport interface BaseEvent extends EventOptions {\n  event_type: string;\n  event_properties?: { [key: string]: any } | undefined;\n  user_properties?: { [key: string]: any } | undefined;\n  group_properties?: { [key: string]: any } | undefined;\n}\n\nexport interface EventOptions {\n  user_id?: string;\n  device_id?: string;\n  time?: number;\n  location_lat?: number;\n  location_lng?: number;\n  app_version?: string;\n  version_name?: string;\n  library?: string;\n  platform?: string;\n  os_name?: string;\n  os_version?: string;\n  device_brand?: string;\n  device_manufacturer?: string;\n  device_model?: string;\n  carrier?: string;\n  country?: string;\n  region?: string;\n  city?: string;\n  dma?: string;\n  idfa?: string;\n  idfv?: string;\n  adid?: string;\n  android_id?: string;\n  language?: string;\n  ip?: string;\n  price?: number;\n  quantity?: number;\n  revenue?: number;\n  receipt?: string;\n  receiptSig?: string;\n  productId?: string;\n  revenueType?: string;\n  currency?: string;\n  event_id?: number;\n  session_id?: number;\n  insert_id?: string;\n  plan?: Plan;\n  ingestion_metadata?: IngestionMetadataEventProperty;\n  partner_id?: string;\n  user_agent?: string;\n  android_app_set_id?: string;\n  extra?: { [key: string]: any };\n  groups?: { [key: string]: any } | undefined;\n}\n"]}

package/lib/esm/types/event/event.d.ts

@@ -0,0 +1,68 @@
+import { BaseEvent } from './base-event';
+import { RevenueEventProperties } from '../../revenue';
+export declare enum IdentifyOperation {
+    SET = "$set",
+    SET_ONCE = "$setOnce",
+    ADD = "$add",
+    APPEND = "$append",
+    PREPEND = "$prepend",
+    REMOVE = "$remove",
+    PREINSERT = "$preInsert",
+    POSTINSERT = "$postInsert",
+    UNSET = "$unset",
+    CLEAR_ALL = "$clearAll"
+}
+export type ValidPropertyType = number | string | boolean | Array<string | number> | {
+    [key: string]: ValidPropertyType;
+} | Array<{
+    [key: string]: ValidPropertyType;
+}>;
+interface BaseOperationConfig {
+    [key: string]: ValidPropertyType;
+}
+export interface IdentifyUserProperties {
+    [IdentifyOperation.ADD]?: {
+        [key: string]: number;
+    };
+    [IdentifyOperation.UNSET]?: BaseOperationConfig;
+    [IdentifyOperation.CLEAR_ALL]?: any;
+    [IdentifyOperation.SET]?: BaseOperationConfig;
+    [IdentifyOperation.SET_ONCE]?: BaseOperationConfig;
+    [IdentifyOperation.APPEND]?: BaseOperationConfig;
+    [IdentifyOperation.PREPEND]?: BaseOperationConfig;
+    [IdentifyOperation.POSTINSERT]?: BaseOperationConfig;
+    [IdentifyOperation.PREINSERT]?: BaseOperationConfig;
+    [IdentifyOperation.REMOVE]?: BaseOperationConfig;
+}
+export type UserProperties = IdentifyUserProperties | {
+    [key in Exclude<string, IdentifyOperation>]: any;
+};
+/**
+ * Strings that have special meaning when used as an event's type
+ * and have different specifications.
+ */
+export declare enum SpecialEventType {
+    IDENTIFY = "$identify",
+    GROUP_IDENTIFY = "$groupidentify",
+    REVENUE = "revenue_amount"
+}
+export interface TrackEvent extends BaseEvent {
+    event_type: Exclude<string, SpecialEventType>;
+}
+export interface IdentifyEvent extends BaseEvent {
+    event_type: SpecialEventType.IDENTIFY;
+    user_properties: UserProperties;
+}
+export interface GroupIdentifyEvent extends BaseEvent {
+    event_type: SpecialEventType.GROUP_IDENTIFY;
+    group_properties: UserProperties;
+}
+export interface RevenueEvent extends BaseEvent {
+    event_type: SpecialEventType.REVENUE;
+    event_properties: RevenueEventProperties | {
+        [key: string]: any;
+    };
+}
+export type Event = TrackEvent | IdentifyEvent | GroupIdentifyEvent | RevenueEvent;
+export {};
+//# sourceMappingURL=event.d.ts.map

package/lib/esm/types/event/event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.d.ts","sourceRoot":"","sources":["../../../../src/types/event/event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAEvD,oBAAY,iBAAiB;IAE3B,GAAG,SAAS;IACZ,QAAQ,aAAa;IAGrB,GAAG,SAAS;IACZ,MAAM,YAAY;IAClB,OAAO,aAAa;IACpB,MAAM,YAAY;IAGlB,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAG1B,KAAK,WAAW;IAChB,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,iBAAiB,GACzB,MAAM,GACN,MAAM,GACN,OAAO,GACP,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GACtB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,GACpC,KAAK,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC,CAAC;AAEhD,UAAU,mBAAmB;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IAErC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAGpD,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC;IAEhD,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC;IAGpC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,mBAAmB,CAAC;IAC9C,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,EAAE,mBAAmB,CAAC;IACnD,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC;IACjD,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,mBAAmB,CAAC;IAClD,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,EAAE,mBAAmB,CAAC;IACrD,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,EAAE,mBAAmB,CAAC;IACpD,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,EAAE,mBAAmB,CAAC;CAClD;AAED,MAAM,MAAM,cAAc,GACtB,sBAAsB,GACtB;KACG,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,GAAG;CACjD,CAAC;AAEN;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,QAAQ,cAAc;IACtB,cAAc,mBAAmB;IACjC,OAAO,mBAAmB;CAC3B;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,UAAU,EAAE,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC/C;AAED,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C,UAAU,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IACtC,eAAe,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,UAAU,EAAE,gBAAgB,CAAC,cAAc,CAAC;IAC5C,gBAAgB,EAAE,cAAc,CAAC;CAClC;AAED,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC;IACrC,gBAAgB,EACZ,sBAAsB,GACtB;QACE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACP;AAED,MAAM,MAAM,KAAK,GAAG,UAAU,GAAG,aAAa,GAAG,kBAAkB,GAAG,YAAY,CAAC"}

package/lib/esm/types/event/event.js

@@ -0,0 +1,28 @@
+export var IdentifyOperation;
+(function (IdentifyOperation) {
+    // Base Operations to set values
+    IdentifyOperation["SET"] = "$set";
+    IdentifyOperation["SET_ONCE"] = "$setOnce";
+    // Operations around modifying existing values
+    IdentifyOperation["ADD"] = "$add";
+    IdentifyOperation["APPEND"] = "$append";
+    IdentifyOperation["PREPEND"] = "$prepend";
+    IdentifyOperation["REMOVE"] = "$remove";
+    // Operations around appending values *if* they aren't present
+    IdentifyOperation["PREINSERT"] = "$preInsert";
+    IdentifyOperation["POSTINSERT"] = "$postInsert";
+    // Operations around removing properties/values
+    IdentifyOperation["UNSET"] = "$unset";
+    IdentifyOperation["CLEAR_ALL"] = "$clearAll";
+})(IdentifyOperation || (IdentifyOperation = {}));
+/**
+ * Strings that have special meaning when used as an event's type
+ * and have different specifications.
+ */
+export var SpecialEventType;
+(function (SpecialEventType) {
+    SpecialEventType["IDENTIFY"] = "$identify";
+    SpecialEventType["GROUP_IDENTIFY"] = "$groupidentify";
+    SpecialEventType["REVENUE"] = "revenue_amount";
+})(SpecialEventType || (SpecialEventType = {}));
+//# sourceMappingURL=event.js.map

package/lib/esm/types/event/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../../src/types/event/event.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,iBAkBX;AAlBD,WAAY,iBAAiB;IAC3B,gCAAgC;IAChC,iCAAY,CAAA;IACZ,0CAAqB,CAAA;IAErB,8CAA8C;IAC9C,iCAAY,CAAA;IACZ,uCAAkB,CAAA;IAClB,yCAAoB,CAAA;IACpB,uCAAkB,CAAA;IAElB,8DAA8D;IAC9D,6CAAwB,CAAA;IACxB,+CAA0B,CAAA;IAE1B,+CAA+C;IAC/C,qCAAgB,CAAA;IAChB,4CAAuB,CAAA;AACzB,CAAC,EAlBW,iBAAiB,KAAjB,iBAAiB,QAkB5B;AAuCD;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,0CAAsB,CAAA;IACtB,qDAAiC,CAAA;IACjC,8CAA0B,CAAA;AAC5B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B","sourcesContent":["import { BaseEvent } from './base-event';\nimport { RevenueEventProperties } from '../../revenue';\n\nexport enum IdentifyOperation {\n  // Base Operations to set values\n  SET = '$set',\n  SET_ONCE = '$setOnce',\n\n  // Operations around modifying existing values\n  ADD = '$add',\n  APPEND = '$append',\n  PREPEND = '$prepend',\n  REMOVE = '$remove',\n\n  // Operations around appending values *if* they aren't present\n  PREINSERT = '$preInsert',\n  POSTINSERT = '$postInsert',\n\n  // Operations around removing properties/values\n  UNSET = '$unset',\n  CLEAR_ALL = '$clearAll',\n}\n\nexport type ValidPropertyType =\n  | number\n  | string\n  | boolean\n  | Array<string | number>\n  | { [key: string]: ValidPropertyType }\n  | Array<{ [key: string]: ValidPropertyType }>;\n\ninterface BaseOperationConfig {\n  [key: string]: ValidPropertyType;\n}\n\nexport interface IdentifyUserProperties {\n  // Add operations can only take numbers\n  [IdentifyOperation.ADD]?: { [key: string]: number };\n\n  // This reads the keys of the passed object, but the values are not used\n  [IdentifyOperation.UNSET]?: BaseOperationConfig;\n  // This option does not read the key as it unsets all user properties\n  [IdentifyOperation.CLEAR_ALL]?: any;\n\n  // These operations can take numbers, strings, or arrays of both.\n  [IdentifyOperation.SET]?: BaseOperationConfig;\n  [IdentifyOperation.SET_ONCE]?: BaseOperationConfig;\n  [IdentifyOperation.APPEND]?: BaseOperationConfig;\n  [IdentifyOperation.PREPEND]?: BaseOperationConfig;\n  [IdentifyOperation.POSTINSERT]?: BaseOperationConfig;\n  [IdentifyOperation.PREINSERT]?: BaseOperationConfig;\n  [IdentifyOperation.REMOVE]?: BaseOperationConfig;\n}\n\nexport type UserProperties =\n  | IdentifyUserProperties\n  | {\n      [key in Exclude<string, IdentifyOperation>]: any;\n    };\n\n/**\n * Strings that have special meaning when used as an event's type\n * and have different specifications.\n */\nexport enum SpecialEventType {\n  IDENTIFY = '$identify',\n  GROUP_IDENTIFY = '$groupidentify',\n  REVENUE = 'revenue_amount',\n}\n\nexport interface TrackEvent extends BaseEvent {\n  event_type: Exclude<string, SpecialEventType>;\n}\n\nexport interface IdentifyEvent extends BaseEvent {\n  event_type: SpecialEventType.IDENTIFY;\n  user_properties: UserProperties;\n}\n\nexport interface GroupIdentifyEvent extends BaseEvent {\n  event_type: SpecialEventType.GROUP_IDENTIFY;\n  group_properties: UserProperties;\n}\n\nexport interface RevenueEvent extends BaseEvent {\n  event_type: SpecialEventType.REVENUE;\n  event_properties:\n    | RevenueEventProperties\n    | {\n        [key: string]: any;\n      };\n}\n\nexport type Event = TrackEvent | IdentifyEvent | GroupIdentifyEvent | RevenueEvent;\n"]}

package/lib/esm/types/event/ingestion-metadata.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Ingestion metadata
+ */
+export interface IngestionMetadata {
+    /** The source name of ingestion metadata e.g. "ampli" */
+    sourceName?: string;
+    /** The source version of ingestion metadata e.g. "2.0.0" */
+    sourceVersion?: string;
+}
+/**
+ * Ingestion metadata event property, snake-case
+ */
+export interface IngestionMetadataEventProperty {
+    /** The source name of ingestion metadata e.g. "ampli" */
+    source_name?: string;
+    /** The source version of ingestion metadata e.g. "2.0.0" */
+    source_version?: string;
+}
+//# sourceMappingURL=ingestion-metadata.d.ts.map

package/lib/esm/types/event/ingestion-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ingestion-metadata.d.ts","sourceRoot":"","sources":["../../../../src/types/event/ingestion-metadata.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4DAA4D;IAC5D,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/lib/esm/types/event/ingestion-metadata.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ingestion-metadata.js.map

package/lib/esm/types/event/ingestion-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ingestion-metadata.js","sourceRoot":"","sources":["../../../../src/types/event/ingestion-metadata.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Ingestion metadata\n */\nexport interface IngestionMetadata {\n  /** The source name of ingestion metadata e.g. \"ampli\" */\n  sourceName?: string;\n  /** The source version of ingestion metadata e.g. \"2.0.0\" */\n  sourceVersion?: string;\n}\n\n/**\n * Ingestion metadata event property, snake-case\n */\nexport interface IngestionMetadataEventProperty {\n  /** The source name of ingestion metadata e.g. \"ampli\" */\n  source_name?: string;\n  /** The source version of ingestion metadata e.g. \"2.0.0\" */\n  source_version?: string;\n}\n"]}

package/lib/esm/types/event/plan.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Tracking plan
+ */
+export interface Plan {
+    /** The tracking plan branch name e.g. "main" */
+    branch?: string;
+    /** The tracking plan source e.g. "web" */
+    source?: string;
+    /** The tracking plan version e.g. "1", "15" */
+    version?: string;
+    /** The tracking plan version Id e.g. "9ec23ba0-275f-468f-80d1-66b88bff9529" */
+    versionId?: string;
+}
+//# sourceMappingURL=plan.d.ts.map

package/lib/esm/types/event/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../../../src/types/event/plan.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/lib/esm/types/event/plan.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=plan.js.map

package/lib/esm/types/event/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../../../src/types/event/plan.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Tracking plan\n */\nexport interface Plan {\n  /** The tracking plan branch name e.g. \"main\" */\n  branch?: string;\n  /** The tracking plan source e.g. \"web\" */\n  source?: string;\n  /** The tracking plan version e.g. \"1\", \"15\" */\n  version?: string;\n  /** The tracking plan version Id e.g. \"9ec23ba0-275f-468f-80d1-66b88bff9529\" */\n  versionId?: string;\n}\n"]}

package/lib/esm/types/event-callback.d.ts

@@ -0,0 +1,3 @@
+import { Result } from './result';
+export type EventCallback = (result: Result) => void;
+//# sourceMappingURL=event-callback.d.ts.map

package/lib/esm/types/event-callback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-callback.d.ts","sourceRoot":"","sources":["../../../src/types/event-callback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC"}

package/lib/esm/types/event-callback.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=event-callback.js.map

package/lib/esm/types/event-callback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-callback.js","sourceRoot":"","sources":["../../../src/types/event-callback.ts"],"names":[],"mappings":"","sourcesContent":["import { Result } from './result';\n\nexport type EventCallback = (result: Result) => void;\n"]}