@amplitude/analytics-types - npm Package Compare versions

Comparing version 2.5.1 to 2.6.0-featureremoteconfig.0

lib/cjs/config/browser.d.ts

@@ -6,2 +6,3 @@ import { UserSession } from '../user-session';
 import { PageTrackingOptions } from '../page-view-tracking';
+import { AutocaptureOptions } from '../autocapture';
 export interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {
@@ -22,2 +23,8 @@ }
     /**
+     * The configurations for autocapture plugin.
+     * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/autocapture/}.
+     * @defaultValue `true`
+     */
+    autocapture?: boolean | AutocaptureOptions;
+    /**
      * The identifier for the device running your application.
@@ -167,3 +174,3 @@ * @defaultValue `UUID()`
 }
-type HiddenOptions = 'apiKey' | 'transportProvider';
+type HiddenOptions = 'apiKey' | 'transportProvider' | 'requestMetadata';
 export interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {
@@ -170,0 +177,0 @@ }

lib/cjs/config/core.d.ts

@@ -83,3 +83,21 @@ import { Event } from '../event';
     useBatch: boolean;
+    /**
+     * Metrics of the SDK.
+     */
+    requestMetadata?: RequestMetadata;
 }
+export interface RequestMetadata {
+    sdk: {
+        metrics: {
+            histogram: {
+                remote_config_fetch_time?: number;
+            };
+        };
+    };
+    recordHistogram<T extends HistogramKey>(key: T, value: HistogramOptions[T]): void;
+}
+export interface HistogramOptions {
+    remote_config_fetch_time?: number;
+}
+export type HistogramKey = keyof HistogramOptions;
 export interface Options extends Partial<Config> {
@@ -86,0 +104,0 @@ apiKey: string;

lib/cjs/config/index.d.ts

@@ -1,2 +0,2 @@
-export { Config, Options } from './core';
+export { Config, Options, RequestMetadata, HistogramOptions, HistogramKey } from './core';
 export { BrowserConfig, DefaultTrackingOptions, TrackingOptions, AttributionOptions, BrowserOptions } from './browser';
@@ -3,0 +3,0 @@ export { NodeConfig, NodeOptions } from './node';

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, } from './config';
+export { AttributionOptions, BrowserConfig, BrowserOptions, Config, DefaultTrackingOptions, Options, NodeConfig, NodeOptions, ReactNativeConfig, ReactNativeOptions, ReactNativeTrackingOptions, TrackingOptions, RequestMetadata, HistogramOptions, HistogramKey, } from './config';
 export { CoreClient } from './client/core-client';
@@ -28,2 +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';
 //# sourceMappingURL=index.d.ts.map

lib/cjs/index.js

 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OfflineDisabled = exports.Status = exports.ServerZone = exports.LogLevel = exports.RevenueProperty = exports.IdentifyOperation = exports.SpecialEventType = void 0;
+exports.DEFAULT_DATA_ATTRIBUTE_PREFIX = exports.DEFAULT_CSS_SELECTOR_ALLOWLIST = exports.OfflineDisabled = exports.Status = exports.ServerZone = exports.LogLevel = exports.RevenueProperty = exports.IdentifyOperation = exports.SpecialEventType = void 0;
 var event_1 = require("./event");
@@ -15,2 +15,5 @@ Object.defineProperty(exports, "SpecialEventType", { enumerable: true, get: function () { return event_1.SpecialEventType; } });
 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; } });
 //# sourceMappingURL=index.js.map

lib/cjs/payload.d.ts

 import { Event } from './event';
+import { RequestMetadata } from './config';
 export interface PayloadOptions {
@@ -10,3 +11,4 @@ min_id_length?: number;
     client_upload_time?: string;
+    request_metadata?: RequestMetadata;
 }
 //# sourceMappingURL=payload.d.ts.map

lib/cjs/user-session.d.ts

@@ -9,3 +9,4 @@ export interface UserSession {
     pageCounter?: number;
+    debugLogsEnabled?: boolean;
 }
 //# sourceMappingURL=user-session.d.ts.map

lib/esm/config/browser.d.ts

@@ -6,2 +6,3 @@ import { UserSession } from '../user-session';
 import { PageTrackingOptions } from '../page-view-tracking';
+import { AutocaptureOptions } from '../autocapture';
 export interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {
@@ -22,2 +23,8 @@ }
     /**
+     * The configurations for autocapture plugin.
+     * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/autocapture/}.
+     * @defaultValue `true`
+     */
+    autocapture?: boolean | AutocaptureOptions;
+    /**
      * The identifier for the device running your application.
@@ -167,3 +174,3 @@ * @defaultValue `UUID()`
 }
-type HiddenOptions = 'apiKey' | 'transportProvider';
+type HiddenOptions = 'apiKey' | 'transportProvider' | 'requestMetadata';
 export interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {
@@ -170,0 +177,0 @@ }

lib/esm/config/core.d.ts

@@ -83,3 +83,21 @@ import { Event } from '../event';
     useBatch: boolean;
+    /**
+     * Metrics of the SDK.
+     */
+    requestMetadata?: RequestMetadata;
 }
+export interface RequestMetadata {
+    sdk: {
+        metrics: {
+            histogram: {
+                remote_config_fetch_time?: number;
+            };
+        };
+    };
+    recordHistogram<T extends HistogramKey>(key: T, value: HistogramOptions[T]): void;
+}
+export interface HistogramOptions {
+    remote_config_fetch_time?: number;
+}
+export type HistogramKey = keyof HistogramOptions;
 export interface Options extends Partial<Config> {
@@ -86,0 +104,0 @@ apiKey: string;

lib/esm/config/index.d.ts

@@ -1,2 +0,2 @@
-export { Config, Options } from './core';
+export { Config, Options, RequestMetadata, HistogramOptions, HistogramKey } from './core';
 export { BrowserConfig, DefaultTrackingOptions, TrackingOptions, AttributionOptions, BrowserOptions } from './browser';
@@ -3,0 +3,0 @@ export { NodeConfig, NodeOptions } from './node';

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, } from './config';
+export { AttributionOptions, BrowserConfig, BrowserOptions, Config, DefaultTrackingOptions, Options, NodeConfig, NodeOptions, ReactNativeConfig, ReactNativeOptions, ReactNativeTrackingOptions, TrackingOptions, RequestMetadata, HistogramOptions, HistogramKey, } from './config';
 export { CoreClient } from './client/core-client';
@@ -28,2 +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';
 //# sourceMappingURL=index.d.ts.map

lib/esm/index.js

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

lib/esm/payload.d.ts

 import { Event } from './event';
+import { RequestMetadata } from './config';
 export interface PayloadOptions {
@@ -10,3 +11,4 @@ min_id_length?: number;
     client_upload_time?: string;
+    request_metadata?: RequestMetadata;
 }
 //# sourceMappingURL=payload.d.ts.map

lib/esm/user-session.d.ts

@@ -9,3 +9,4 @@ export interface UserSession {
     pageCounter?: number;
+    debugLogsEnabled?: boolean;
 }
 //# sourceMappingURL=user-session.d.ts.map

package.json

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

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

258290

increased by8.22%

Number of package files

275

increased by3%

Lines of code

2823

increased by8.95%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes