@amplitude/analytics-types - npm Package Compare versions

Comparing version 2.6.0-featureremoteconfig.0 to 2.6.0-featureremoteconfig.1

lib/cjs/config/browser.d.ts

@@ -6,3 +6,3 @@ import { UserSession } from '../user-session';
 import { PageTrackingOptions } from '../page-view-tracking';
-import { AutocaptureOptions } from '../autocapture';
+import { UserInteractionsOptions } from '../userInteractions';
 export interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {
@@ -17,2 +17,3 @@ }
     /**
+     * @deprecated This property is deprecated and will be removed in future versions. Please migrate to using `autocapture` instead.
      * The default event tracking configuration.
@@ -24,5 +25,4 @@ * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#tracking-default-events}.
     /**
-     * The configurations for autocapture plugin.
+     * The configurations for auto-captured events.
      * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/autocapture/}.
-     * @defaultValue `true`
      */
@@ -80,2 +80,7 @@ autocapture?: boolean | AutocaptureOptions;
     pageCounter?: number;
+    /**
+     * Whether to fetch remote configuration.
+     * @defaultValue `false`
+     */
+    fetchRemoteConfig?: boolean;
 }
@@ -88,2 +93,5 @@ interface InternalBrowserConfig {
 }
+/**
+ * @deprecated This interface is deprecated and will be removed in future versions. Please migrate to using `AutocaptureOptions` instead.
+ */
 export interface DefaultTrackingOptions {
@@ -116,2 +124,34 @@ /**
 }
+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`
+     */
+    userInteractions?: boolean | UserInteractionsOptions;
+}
 export interface TrackingOptions {
@@ -181,3 +221,8 @@ /**
 }
+export type BrowserRemoteConfig = {
+    browserSDK: {
+        autocapture?: AutocaptureOptions | boolean;
+    };
+};
 export {};
 //# sourceMappingURL=browser.d.ts.map

lib/cjs/config/index.d.ts

 export { Config, Options, RequestMetadata, HistogramOptions, HistogramKey } from './core';
-export { BrowserConfig, DefaultTrackingOptions, TrackingOptions, AttributionOptions, BrowserOptions } from './browser';
+export { BrowserConfig, DefaultTrackingOptions, TrackingOptions, AttributionOptions, BrowserOptions, AutocaptureOptions, BrowserRemoteConfig, } from './browser';
 export { NodeConfig, NodeOptions } from './node';
 export { ReactNativeAttributionOptions, ReactNativeConfig, ReactNativeTrackingOptions, ReactNativeOptions, } from './react-native';
 //# sourceMappingURL=index.d.ts.map

lib/cjs/index.d.ts

@@ -5,3 +5,3 @@ export { AmplitudeReturn } from './amplitude-promise';
 export { BrowserClient, ReactNativeClient, NodeClient } from './client';
-export { AttributionOptions, BrowserConfig, BrowserOptions, Config, DefaultTrackingOptions, Options, NodeConfig, NodeOptions, ReactNativeConfig, ReactNativeOptions, ReactNativeTrackingOptions, TrackingOptions, RequestMetadata, HistogramOptions, HistogramKey, } from './config';
+export { AttributionOptions, AutocaptureOptions, BrowserConfig, BrowserOptions, Config, DefaultTrackingOptions, Options, NodeConfig, NodeOptions, ReactNativeConfig, ReactNativeOptions, ReactNativeTrackingOptions, TrackingOptions, RequestMetadata, HistogramOptions, HistogramKey, BrowserRemoteConfig, } from './config';
 export { CoreClient } from './client/core-client';
@@ -28,3 +28,3 @@ export { DestinationContext } from './destination-context';
 export { OfflineDisabled } from './offline';
-export { Messenger, AutocaptureOptions, ActionType, DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, } from './autocapture';
+export { Messenger, UserInteractionsOptions, ActionType, DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, } from './userInteractions';
 //# sourceMappingURL=index.d.ts.map

lib/cjs/index.js

@@ -15,5 +15,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 Object.defineProperty(exports, "OfflineDisabled", { enumerable: true, get: function () { return offline_1.OfflineDisabled; } });
-var autocapture_1 = require("./autocapture");
-Object.defineProperty(exports, "DEFAULT_CSS_SELECTOR_ALLOWLIST", { enumerable: true, get: function () { return autocapture_1.DEFAULT_CSS_SELECTOR_ALLOWLIST; } });
-Object.defineProperty(exports, "DEFAULT_DATA_ATTRIBUTE_PREFIX", { enumerable: true, get: function () { return autocapture_1.DEFAULT_DATA_ATTRIBUTE_PREFIX; } });
+var userInteractions_1 = require("./userInteractions");
+Object.defineProperty(exports, "DEFAULT_CSS_SELECTOR_ALLOWLIST", { enumerable: true, get: function () { return userInteractions_1.DEFAULT_CSS_SELECTOR_ALLOWLIST; } });
+Object.defineProperty(exports, "DEFAULT_DATA_ATTRIBUTE_PREFIX", { enumerable: true, get: function () { return userInteractions_1.DEFAULT_DATA_ATTRIBUTE_PREFIX; } });
 //# sourceMappingURL=index.js.map

lib/esm/config/browser.d.ts

@@ -6,3 +6,3 @@ import { UserSession } from '../user-session';
 import { PageTrackingOptions } from '../page-view-tracking';
-import { AutocaptureOptions } from '../autocapture';
+import { UserInteractionsOptions } from '../userInteractions';
 export interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {
@@ -17,2 +17,3 @@ }
     /**
+     * @deprecated This property is deprecated and will be removed in future versions. Please migrate to using `autocapture` instead.
      * The default event tracking configuration.
@@ -24,5 +25,4 @@ * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#tracking-default-events}.
     /**
-     * The configurations for autocapture plugin.
+     * The configurations for auto-captured events.
      * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/autocapture/}.
-     * @defaultValue `true`
      */
@@ -80,2 +80,7 @@ autocapture?: boolean | AutocaptureOptions;
     pageCounter?: number;
+    /**
+     * Whether to fetch remote configuration.
+     * @defaultValue `false`
+     */
+    fetchRemoteConfig?: boolean;
 }
@@ -88,2 +93,5 @@ interface InternalBrowserConfig {
 }
+/**
+ * @deprecated This interface is deprecated and will be removed in future versions. Please migrate to using `AutocaptureOptions` instead.
+ */
 export interface DefaultTrackingOptions {
@@ -116,2 +124,34 @@ /**
 }
+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`
+     */
+    userInteractions?: boolean | UserInteractionsOptions;
+}
 export interface TrackingOptions {
@@ -181,3 +221,8 @@ /**
 }
+export type BrowserRemoteConfig = {
+    browserSDK: {
+        autocapture?: AutocaptureOptions | boolean;
+    };
+};
 export {};
 //# sourceMappingURL=browser.d.ts.map

lib/esm/config/index.d.ts

 export { Config, Options, RequestMetadata, HistogramOptions, HistogramKey } from './core';
-export { BrowserConfig, DefaultTrackingOptions, TrackingOptions, AttributionOptions, BrowserOptions } from './browser';
+export { BrowserConfig, DefaultTrackingOptions, TrackingOptions, AttributionOptions, BrowserOptions, AutocaptureOptions, BrowserRemoteConfig, } from './browser';
 export { NodeConfig, NodeOptions } from './node';
 export { ReactNativeAttributionOptions, ReactNativeConfig, ReactNativeTrackingOptions, ReactNativeOptions, } from './react-native';
 //# sourceMappingURL=index.d.ts.map

lib/esm/index.d.ts

@@ -5,3 +5,3 @@ export { AmplitudeReturn } from './amplitude-promise';
 export { BrowserClient, ReactNativeClient, NodeClient } from './client';
-export { AttributionOptions, BrowserConfig, BrowserOptions, Config, DefaultTrackingOptions, Options, NodeConfig, NodeOptions, ReactNativeConfig, ReactNativeOptions, ReactNativeTrackingOptions, TrackingOptions, RequestMetadata, HistogramOptions, HistogramKey, } from './config';
+export { AttributionOptions, AutocaptureOptions, BrowserConfig, BrowserOptions, Config, DefaultTrackingOptions, Options, NodeConfig, NodeOptions, ReactNativeConfig, ReactNativeOptions, ReactNativeTrackingOptions, TrackingOptions, RequestMetadata, HistogramOptions, HistogramKey, BrowserRemoteConfig, } from './config';
 export { CoreClient } from './client/core-client';
@@ -28,3 +28,3 @@ export { DestinationContext } from './destination-context';
 export { OfflineDisabled } from './offline';
-export { Messenger, AutocaptureOptions, ActionType, DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, } from './autocapture';
+export { Messenger, UserInteractionsOptions, ActionType, DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, } from './userInteractions';
 //# sourceMappingURL=index.d.ts.map

lib/esm/index.js

@@ -6,3 +6,3 @@ export { SpecialEventType, IdentifyOperation, RevenueProperty, } from './event';
 export { OfflineDisabled } from './offline';
-export { DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, } from './autocapture';
+export { DEFAULT_CSS_SELECTOR_ALLOWLIST, DEFAULT_DATA_ATTRIBUTE_PREFIX, } from './userInteractions';
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@amplitude/analytics-types",
-  "version": "2.6.0-featureremoteconfig.0",
+  "version": "2.6.0-featureremoteconfig.1",
   "description": "",
@@ -38,3 +38,3 @@ "author": "Amplitude Inc",
   ],
-  "gitHead": "bce512c9ed7e4c675335e394a08bc4c1aeca9292"
+  "gitHead": "a45289129105a87fc1de61c90fc3dba4f0c031bb"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

265429

increased by2.76%

Lines of code

2913

increased by3.19%

No dependency changes