@amplitude/analytics-types 2.5.0 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/lib/cjs/config/browser.d.ts +113 -1
  2. package/lib/cjs/config/browser.d.ts.map +1 -1
  3. package/lib/cjs/config/browser.js.map +1 -1
  4. package/lib/cjs/config/core.d.ts +56 -0
  5. package/lib/cjs/config/core.d.ts.map +1 -1
  6. package/lib/cjs/config/core.js.map +1 -1
  7. package/lib/cjs/user-session.d.ts +1 -0
  8. package/lib/cjs/user-session.d.ts.map +1 -1
  9. package/lib/cjs/user-session.js.map +1 -1
  10. package/lib/esm/config/browser.d.ts +113 -1
  11. package/lib/esm/config/browser.d.ts.map +1 -1
  12. package/lib/esm/config/browser.js.map +1 -1
  13. package/lib/esm/config/core.d.ts +56 -0
  14. package/lib/esm/config/core.d.ts.map +1 -1
  15. package/lib/esm/config/core.js.map +1 -1
  16. package/lib/esm/user-session.d.ts +1 -0
  17. package/lib/esm/user-session.d.ts.map +1 -1
  18. package/lib/esm/user-session.js.map +1 -1
  19. package/package.json +2 -2
package/lib/cjs/config/browser.d.ts CHANGED
@@ -6,17 +6,66 @@ import { PageTrackingOptions } from '../page-view-tracking';
6
6
  export interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {
7
7
  }
8
8
  export interface ExternalBrowserConfig extends Config {
9
+ /**
10
+ * An app version for events tracked. This can be the version of your application.
11
+ * @defaultValue `undefined`
12
+ */
9
13
  appVersion?: string;
14
+ /**
15
+ * The default event tracking configuration.
16
+ * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#tracking-default-events}.
17
+ * @defaultValue `true`
18
+ */
10
19
  defaultTracking?: boolean | DefaultTrackingOptions;
20
+ /**
21
+ * The identifier for the device running your application.
22
+ * @defaultValue `UUID()`
23
+ */
11
24
  deviceId?: string;
25
+ /**
26
+ * Configuration for cookie.
27
+ */
12
28
  cookieOptions?: CookieOptions;
29
+ /**
30
+ * The storage for user identify.
31
+ * @defaultValue `"cookie"`
32
+ */
13
33
  identityStorage?: IdentityStorageType;
34
+ /**
35
+ * The partner identifier.
36
+ * Amplitude requires the customer who built an event ingestion integration to add the partner identifier to partner_id.
37
+ * @defaultValue `undefined`
38
+ */
14
39
  partnerId?: string;
40
+ /**
41
+ * The custom Session ID for the current session.
42
+ * @defaultValue `timestamp`
43
+ */
15
44
  sessionId?: number;
45
+ /**
46
+ * The period of inactivity from the last tracked event before a session expires in milliseconds.
47
+ * @defaultValue `1,800,000` (30 minutes)
48
+ */
16
49
  sessionTimeout: number;
50
+ /**
51
+ * The configurations for tracking additional properties.
52
+ * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#optional-tracking}.
53
+ */
17
54
  trackingOptions: TrackingOptions;
55
+ /**
56
+ * Network transport mechanism used to send events.
57
+ * @defaultValue `"fetch"`
58
+ */
18
59
  transport?: 'fetch' | 'xhr' | 'beacon';
60
+ /**
61
+ * The identifier for the user being tracked.
62
+ * @defaultValue `undefined`
63
+ */
19
64
  userId?: string;
65
+ /**
66
+ * User's Nth instance of performing a default Page Viewed event within a session.
67
+ * Used for landing page analysis.
68
+ */
20
69
  pageCounter?: number;
21
70
  }
22
71
  interface InternalBrowserConfig {
@@ -24,30 +73,93 @@ interface InternalBrowserConfig {
24
73
  lastEventTime?: number;
25
74
  lastEventId?: number;
26
75
  transportProvider: Transport;
27
- pageCounter?: number;
28
76
  }
29
77
  export interface DefaultTrackingOptions {
78
+ /**
79
+ * Enables/disables marketing attribution tracking or config with detailed attribution options.
80
+ * @defaultValue `true`
81
+ */
30
82
  attribution?: boolean | AttributionOptions;
83
+ /**
84
+ * Enables/disables form downloads tracking.
85
+ * @defaultValue `true`
86
+ */
31
87
  fileDownloads?: boolean;
88
+ /**
89
+ * Enables/disables form interaction tracking.
90
+ * @defaultValue `true`
91
+ */
32
92
  formInteractions?: boolean;
93
+ /**
94
+ * Enables/disables default page view tracking.
95
+ * @defaultValue `true`
96
+ */
33
97
  pageViews?: boolean | PageTrackingOptions;
98
+ /**
99
+ * Enables/disables session tracking.
100
+ * @defaultValue `true`
101
+ */
34
102
  sessions?: boolean;
35
103
  }
36
104
  export interface TrackingOptions {
105
+ /**
106
+ * Enables/disables ip address tracking.
107
+ * @defaultValue `true`
108
+ */
37
109
  ipAddress?: boolean;
110
+ /**
111
+ * Enables/disables language tracking.
112
+ * @defaultValue `true`
113
+ */
38
114
  language?: boolean;
115
+ /**
116
+ * Enables/disables plantform tracking.
117
+ * @defaultValue `true`
118
+ */
39
119
  platform?: boolean;
40
120
  }
41
121
  export interface AttributionOptions {
122
+ /**
123
+ * The rules to determine which referrers are excluded from being tracked as traffic source.
124
+ * @defaultValue `[/your-domain\.com$/]`
125
+ */
42
126
  excludeReferrers?: (string | RegExp)[];
127
+ /**
128
+ * The value to represent undefined/no initial campaign parameter for first-touch attribution.
129
+ * @defaultValue `"EMPTY"`
130
+ */
43
131
  initialEmptyValue?: string;
132
+ /**
133
+ * The flag of if Amplitude to start a new session if any campaign parameter changes.
134
+ * @defaultValue `false`
135
+ */
44
136
  resetSessionOnNewCampaign?: boolean;
45
137
  }
46
138
  export interface CookieOptions {
139
+ /**
140
+ * The domain property of cookies created.
141
+ * @defaultValue `Your top level domain`
142
+ */
47
143
  domain?: string;
144
+ /**
145
+ * The expiration of cookies created in days.
146
+ * @defaultValue `365`
147
+ */
48
148
  expiration?: number;
149
+ /**
150
+ * How cookies are sent with cross-site requests.
151
+ * @defaultValue `"Lax"`
152
+ */
49
153
  sameSite?: 'Strict' | 'Lax' | 'None';
154
+ /**
155
+ * The flag of if send cookies over secure protocols.
156
+ * @defaultValue `false`
157
+ */
50
158
  secure?: boolean;
159
+ /**
160
+ * The flag of if upgrade the cookies created by maintenance Browser SDK.
161
+ * @defaultValue `true`
162
+ */
51
163
  upgrade?: boolean;
52
164
  }
53
165
  type HiddenOptions = 'apiKey' | 'transportProvider';
package/lib/cjs/config/browser.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,MAAM,WAAW,aAAc,SAAQ,qBAAqB,EAAE,qBAAqB;CAAG;AAEtF,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,eAAe,CAAC,EAAE,mBAAmB,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;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;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,KAAK,aAAa,GAAG,QAAQ,GAAG,mBAAmB,CAAC;AAGpD,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,aAAa,CAAC;CAAG"}
1
+ {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,MAAM,WAAW,aAAc,SAAQ,qBAAqB,EAAE,qBAAqB;CAAG;AAEtF,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACnD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACnD;;;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;CACtB;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,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,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,CAAC;AAGpD,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,aAAa,CAAC;CAAG"}
package/lib/cjs/config/browser.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"","sourcesContent":["import { UserSession } from '../user-session';\nimport { IdentityStorageType, Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Config } from './core';\nimport { PageTrackingOptions } from '../page-view-tracking';\n\nexport interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {}\n\nexport interface ExternalBrowserConfig extends Config {\n appVersion?: string;\n defaultTracking?: boolean | DefaultTrackingOptions;\n deviceId?: string;\n cookieOptions?: CookieOptions;\n identityStorage?: IdentityStorageType;\n partnerId?: string;\n sessionId?: number;\n sessionTimeout: number;\n trackingOptions: TrackingOptions;\n transport?: 'fetch' | 'xhr' | 'beacon';\n userId?: string;\n pageCounter?: number;\n}\n\ninterface InternalBrowserConfig {\n cookieStorage: Storage<UserSession>;\n lastEventTime?: number;\n lastEventId?: number;\n transportProvider: Transport;\n pageCounter?: number;\n}\n\nexport interface DefaultTrackingOptions {\n attribution?: boolean | AttributionOptions;\n fileDownloads?: boolean;\n formInteractions?: boolean;\n pageViews?: boolean | PageTrackingOptions;\n sessions?: boolean;\n}\n\nexport interface TrackingOptions {\n ipAddress?: boolean;\n language?: boolean;\n platform?: boolean;\n}\n\nexport interface AttributionOptions {\n excludeReferrers?: (string | RegExp)[];\n initialEmptyValue?: string;\n resetSessionOnNewCampaign?: boolean;\n}\n\nexport interface CookieOptions {\n domain?: string;\n expiration?: number;\n sameSite?: 'Strict' | 'Lax' | 'None';\n secure?: boolean;\n upgrade?: boolean;\n}\n\ntype HiddenOptions = 'apiKey' | 'transportProvider';\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {}\n"]}
1
+ {"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"","sourcesContent":["import { UserSession } from '../user-session';\nimport { IdentityStorageType, Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Config } from './core';\nimport { PageTrackingOptions } from '../page-view-tracking';\n\nexport interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {}\n\nexport interface ExternalBrowserConfig extends Config {\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 * 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 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\ninterface InternalBrowserConfig {\n cookieStorage: Storage<UserSession>;\n lastEventTime?: number;\n lastEventId?: number;\n transportProvider: Transport;\n}\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 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';\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {}\n"]}
package/lib/cjs/config/core.d.ts CHANGED
@@ -7,22 +7,78 @@ import { Transport } from '../transport';
7
7
  import { Logger, LogLevel } from '../logger';
8
8
  import { OfflineDisabled } from '../offline';
9
9
  export interface Config {
10
+ /**
11
+ * Your Amplitude Project API key.
12
+ */
10
13
  apiKey: string;
14
+ /**
15
+ * The interval of uploading events to Amplitude in milliseconds.
16
+ */
11
17
  flushIntervalMillis: number;
18
+ /**
19
+ * The maximum number of retries for failed upload attempts. This is only applicable to retryable errors.
20
+ */
12
21
  flushMaxRetries: number;
22
+ /**
23
+ * The maximum number of events that are batched in a single upload attempt.
24
+ */
13
25
  flushQueueSize: number;
26
+ /**
27
+ * The instance name. For tracking events to multiple Amplitude projects in your application.
28
+ */
14
29
  instanceName?: string;
30
+ /**
31
+ * Level of logs to be printed in the developer console.
32
+ * Valid values are `LogLevel.None`, `LogLevel.Error`, `LogLevel.Warn`, `LogLevel.Verbose`, `LogLevel.Debug`
33
+ */
15
34
  logLevel: LogLevel;
35
+ /**
36
+ * A custom Logger class to emit log messages to desired destination.
37
+ */
16
38
  loggerProvider: Logger;
39
+ /**
40
+ * The minimum length for the value of userId and deviceId properties.
41
+ */
17
42
  minIdLength?: number;
43
+ /**
44
+ * Whether the SDK is connected to network.
45
+ */
18
46
  offline?: boolean | typeof OfflineDisabled;
47
+ /**
48
+ * The flag to opt this device out of Amplitude tracking.
49
+ * If this flag is set, no additional information will be stored for the user.
50
+ */
19
51
  optOut: boolean;
52
+ /**
53
+ * Tracking plan properties.
54
+ * Amplitude internal use.
55
+ */
20
56
  plan?: Plan;
57
+ /**
58
+ * Ingestion metadata.
59
+ * Amplitude internal use.
60
+ */
21
61
  ingestionMetadata?: IngestionMetadata;
62
+ /**
63
+ * The URL where events are upload to.
64
+ */
22
65
  serverUrl?: string;
66
+ /**
67
+ * The Amplitude server zone.
68
+ * Set this to EU for Amplitude projects created in EU data center.
69
+ */
23
70
  serverZone?: ServerZoneType;
71
+ /**
72
+ * The storage provider to persist unsent events.
73
+ */
24
74
  storageProvider?: Storage<Event[]>;
75
+ /**
76
+ * A customer Transport Class for sending data to a server.
77
+ */
25
78
  transportProvider: Transport;
79
+ /**
80
+ * The flag of whether to upload events to Batch API instead of the default HTTP V2 API.
81
+ */
26
82
  useBatch: boolean;
27
83
  }
28
84
  export interface Options extends Partial<Config> {
package/lib/cjs/config/core.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,eAAe,CAAC;IAC3C,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC,iBAAiB,EAAE,SAAS,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,SAAS,CAAC;CAC9B"}
1
+ {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,eAAe,CAAC;IAC3C;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;OAGG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,iBAAiB,EAAE,SAAS,CAAC;IAC7B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,SAAS,CAAC;CAC9B"}
package/lib/cjs/config/core.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from '../event';\nimport { IngestionMetadata } from '../ingestion-metadata';\nimport { Plan } from '../plan';\nimport { ServerZoneType } from '../server-zone';\nimport { Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Logger, LogLevel } from '../logger';\nimport { OfflineDisabled } from '../offline';\n\nexport interface Config {\n apiKey: string;\n flushIntervalMillis: number;\n flushMaxRetries: number;\n flushQueueSize: number;\n instanceName?: string;\n logLevel: LogLevel;\n loggerProvider: Logger;\n minIdLength?: number;\n offline?: boolean | typeof OfflineDisabled;\n optOut: boolean;\n plan?: Plan;\n ingestionMetadata?: IngestionMetadata;\n serverUrl?: string;\n serverZone?: ServerZoneType;\n storageProvider?: Storage<Event[]>;\n transportProvider: Transport;\n useBatch: boolean;\n}\n\nexport interface Options extends Partial<Config> {\n apiKey: string;\n transportProvider: Transport;\n}\n"]}
1
+ {"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from '../event';\nimport { IngestionMetadata } from '../ingestion-metadata';\nimport { Plan } from '../plan';\nimport { ServerZoneType } from '../server-zone';\nimport { Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Logger, LogLevel } from '../logger';\nimport { OfflineDisabled } from '../offline';\n\nexport interface Config {\n /**\n * Your Amplitude Project API key.\n */\n apiKey: string;\n /**\n * The interval of uploading events to Amplitude in milliseconds.\n */\n flushIntervalMillis: number;\n /**\n * The maximum number of retries for failed upload attempts. This is only applicable to retryable errors.\n */\n flushMaxRetries: number;\n /**\n * The maximum number of events that are batched in a single upload attempt.\n */\n flushQueueSize: number;\n /**\n * The instance name. For tracking events to multiple Amplitude projects in your application.\n */\n instanceName?: string;\n /**\n * Level of logs to be printed in the developer console.\n * Valid values are `LogLevel.None`, `LogLevel.Error`, `LogLevel.Warn`, `LogLevel.Verbose`, `LogLevel.Debug`\n */\n logLevel: LogLevel;\n /**\n * A custom Logger class to emit log messages to desired destination.\n */\n loggerProvider: Logger;\n /**\n * The minimum length for the value of userId and deviceId properties.\n */\n minIdLength?: number;\n /**\n * Whether the SDK is connected to network.\n */\n offline?: boolean | typeof OfflineDisabled;\n /**\n * The flag to opt this device out of Amplitude tracking.\n * If this flag is set, no additional information will be stored for the user.\n */\n optOut: boolean;\n /**\n * Tracking plan properties.\n * Amplitude internal use.\n */\n plan?: Plan;\n /**\n * Ingestion metadata.\n * Amplitude internal use.\n */\n ingestionMetadata?: IngestionMetadata;\n /**\n * The URL where events are upload to.\n */\n serverUrl?: string;\n /**\n * The Amplitude server zone.\n * Set this to EU for Amplitude projects created in EU data center.\n */\n serverZone?: ServerZoneType;\n /**\n * The storage provider to persist unsent events.\n */\n storageProvider?: Storage<Event[]>;\n /**\n * A customer Transport Class for sending data to a server.\n */\n transportProvider: Transport;\n /**\n * The flag of whether to upload events to Batch API instead of the default HTTP V2 API.\n */\n useBatch: boolean;\n}\n\nexport interface Options extends Partial<Config> {\n apiKey: string;\n transportProvider: Transport;\n}\n"]}
package/lib/cjs/user-session.d.ts CHANGED
@@ -6,5 +6,6 @@ export interface UserSession {
6
6
  optOut: boolean;
7
7
  lastEventId?: number;
8
8
  pageCounter?: number;
9
+ debugLogsEnabled?: boolean;
9
10
  }
10
11
  //# sourceMappingURL=user-session.d.ts.map
package/lib/cjs/user-session.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"user-session.d.ts","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
1
+ {"version":3,"file":"user-session.d.ts","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}
package/lib/cjs/user-session.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"user-session.js","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"","sourcesContent":["export interface UserSession {\n userId?: string;\n deviceId?: string;\n sessionId?: number;\n lastEventTime?: number;\n optOut: boolean;\n lastEventId?: number;\n pageCounter?: number;\n}\n"]}
1
+ {"version":3,"file":"user-session.js","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"","sourcesContent":["export interface UserSession {\n userId?: string;\n deviceId?: string;\n sessionId?: number;\n lastEventTime?: number;\n optOut: boolean;\n lastEventId?: number;\n pageCounter?: number;\n debugLogsEnabled?: boolean;\n}\n"]}
package/lib/esm/config/browser.d.ts CHANGED
@@ -6,17 +6,66 @@ import { PageTrackingOptions } from '../page-view-tracking';
6
6
  export interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {
7
7
  }
8
8
  export interface ExternalBrowserConfig extends Config {
9
+ /**
10
+ * An app version for events tracked. This can be the version of your application.
11
+ * @defaultValue `undefined`
12
+ */
9
13
  appVersion?: string;
14
+ /**
15
+ * The default event tracking configuration.
16
+ * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#tracking-default-events}.
17
+ * @defaultValue `true`
18
+ */
10
19
  defaultTracking?: boolean | DefaultTrackingOptions;
20
+ /**
21
+ * The identifier for the device running your application.
22
+ * @defaultValue `UUID()`
23
+ */
11
24
  deviceId?: string;
25
+ /**
26
+ * Configuration for cookie.
27
+ */
12
28
  cookieOptions?: CookieOptions;
29
+ /**
30
+ * The storage for user identify.
31
+ * @defaultValue `"cookie"`
32
+ */
13
33
  identityStorage?: IdentityStorageType;
34
+ /**
35
+ * The partner identifier.
36
+ * Amplitude requires the customer who built an event ingestion integration to add the partner identifier to partner_id.
37
+ * @defaultValue `undefined`
38
+ */
14
39
  partnerId?: string;
40
+ /**
41
+ * The custom Session ID for the current session.
42
+ * @defaultValue `timestamp`
43
+ */
15
44
  sessionId?: number;
45
+ /**
46
+ * The period of inactivity from the last tracked event before a session expires in milliseconds.
47
+ * @defaultValue `1,800,000` (30 minutes)
48
+ */
16
49
  sessionTimeout: number;
50
+ /**
51
+ * The configurations for tracking additional properties.
52
+ * See {@link https://www.docs.developers.amplitude.com/data/sdks/browser-2/#optional-tracking}.
53
+ */
17
54
  trackingOptions: TrackingOptions;
55
+ /**
56
+ * Network transport mechanism used to send events.
57
+ * @defaultValue `"fetch"`
58
+ */
18
59
  transport?: 'fetch' | 'xhr' | 'beacon';
60
+ /**
61
+ * The identifier for the user being tracked.
62
+ * @defaultValue `undefined`
63
+ */
19
64
  userId?: string;
65
+ /**
66
+ * User's Nth instance of performing a default Page Viewed event within a session.
67
+ * Used for landing page analysis.
68
+ */
20
69
  pageCounter?: number;
21
70
  }
22
71
  interface InternalBrowserConfig {
@@ -24,30 +73,93 @@ interface InternalBrowserConfig {
24
73
  lastEventTime?: number;
25
74
  lastEventId?: number;
26
75
  transportProvider: Transport;
27
- pageCounter?: number;
28
76
  }
29
77
  export interface DefaultTrackingOptions {
78
+ /**
79
+ * Enables/disables marketing attribution tracking or config with detailed attribution options.
80
+ * @defaultValue `true`
81
+ */
30
82
  attribution?: boolean | AttributionOptions;
83
+ /**
84
+ * Enables/disables form downloads tracking.
85
+ * @defaultValue `true`
86
+ */
31
87
  fileDownloads?: boolean;
88
+ /**
89
+ * Enables/disables form interaction tracking.
90
+ * @defaultValue `true`
91
+ */
32
92
  formInteractions?: boolean;
93
+ /**
94
+ * Enables/disables default page view tracking.
95
+ * @defaultValue `true`
96
+ */
33
97
  pageViews?: boolean | PageTrackingOptions;
98
+ /**
99
+ * Enables/disables session tracking.
100
+ * @defaultValue `true`
101
+ */
34
102
  sessions?: boolean;
35
103
  }
36
104
  export interface TrackingOptions {
105
+ /**
106
+ * Enables/disables ip address tracking.
107
+ * @defaultValue `true`
108
+ */
37
109
  ipAddress?: boolean;
110
+ /**
111
+ * Enables/disables language tracking.
112
+ * @defaultValue `true`
113
+ */
38
114
  language?: boolean;
115
+ /**
116
+ * Enables/disables plantform tracking.
117
+ * @defaultValue `true`
118
+ */
39
119
  platform?: boolean;
40
120
  }
41
121
  export interface AttributionOptions {
122
+ /**
123
+ * The rules to determine which referrers are excluded from being tracked as traffic source.
124
+ * @defaultValue `[/your-domain\.com$/]`
125
+ */
42
126
  excludeReferrers?: (string | RegExp)[];
127
+ /**
128
+ * The value to represent undefined/no initial campaign parameter for first-touch attribution.
129
+ * @defaultValue `"EMPTY"`
130
+ */
43
131
  initialEmptyValue?: string;
132
+ /**
133
+ * The flag of if Amplitude to start a new session if any campaign parameter changes.
134
+ * @defaultValue `false`
135
+ */
44
136
  resetSessionOnNewCampaign?: boolean;
45
137
  }
46
138
  export interface CookieOptions {
139
+ /**
140
+ * The domain property of cookies created.
141
+ * @defaultValue `Your top level domain`
142
+ */
47
143
  domain?: string;
144
+ /**
145
+ * The expiration of cookies created in days.
146
+ * @defaultValue `365`
147
+ */
48
148
  expiration?: number;
149
+ /**
150
+ * How cookies are sent with cross-site requests.
151
+ * @defaultValue `"Lax"`
152
+ */
49
153
  sameSite?: 'Strict' | 'Lax' | 'None';
154
+ /**
155
+ * The flag of if send cookies over secure protocols.
156
+ * @defaultValue `false`
157
+ */
50
158
  secure?: boolean;
159
+ /**
160
+ * The flag of if upgrade the cookies created by maintenance Browser SDK.
161
+ * @defaultValue `true`
162
+ */
51
163
  upgrade?: boolean;
52
164
  }
53
165
  type HiddenOptions = 'apiKey' | 'transportProvider';
package/lib/esm/config/browser.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,MAAM,WAAW,aAAc,SAAQ,qBAAqB,EAAE,qBAAqB;CAAG;AAEtF,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,eAAe,CAAC,EAAE,mBAAmB,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;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;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACvC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,KAAK,aAAa,GAAG,QAAQ,GAAG,mBAAmB,CAAC;AAGpD,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,aAAa,CAAC;CAAG"}
1
+ {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,MAAM,WAAW,aAAc,SAAQ,qBAAqB,EAAE,qBAAqB;CAAG;AAEtF,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACnD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IACnD;;;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;CACtB;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,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,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,CAAC;AAGpD,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,aAAa,CAAC;CAAG"}
package/lib/esm/config/browser.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"","sourcesContent":["import { UserSession } from '../user-session';\nimport { IdentityStorageType, Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Config } from './core';\nimport { PageTrackingOptions } from '../page-view-tracking';\n\nexport interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {}\n\nexport interface ExternalBrowserConfig extends Config {\n appVersion?: string;\n defaultTracking?: boolean | DefaultTrackingOptions;\n deviceId?: string;\n cookieOptions?: CookieOptions;\n identityStorage?: IdentityStorageType;\n partnerId?: string;\n sessionId?: number;\n sessionTimeout: number;\n trackingOptions: TrackingOptions;\n transport?: 'fetch' | 'xhr' | 'beacon';\n userId?: string;\n pageCounter?: number;\n}\n\ninterface InternalBrowserConfig {\n cookieStorage: Storage<UserSession>;\n lastEventTime?: number;\n lastEventId?: number;\n transportProvider: Transport;\n pageCounter?: number;\n}\n\nexport interface DefaultTrackingOptions {\n attribution?: boolean | AttributionOptions;\n fileDownloads?: boolean;\n formInteractions?: boolean;\n pageViews?: boolean | PageTrackingOptions;\n sessions?: boolean;\n}\n\nexport interface TrackingOptions {\n ipAddress?: boolean;\n language?: boolean;\n platform?: boolean;\n}\n\nexport interface AttributionOptions {\n excludeReferrers?: (string | RegExp)[];\n initialEmptyValue?: string;\n resetSessionOnNewCampaign?: boolean;\n}\n\nexport interface CookieOptions {\n domain?: string;\n expiration?: number;\n sameSite?: 'Strict' | 'Lax' | 'None';\n secure?: boolean;\n upgrade?: boolean;\n}\n\ntype HiddenOptions = 'apiKey' | 'transportProvider';\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {}\n"]}
1
+ {"version":3,"file":"browser.js","sourceRoot":"","sources":["../../../src/config/browser.ts"],"names":[],"mappings":"","sourcesContent":["import { UserSession } from '../user-session';\nimport { IdentityStorageType, Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Config } from './core';\nimport { PageTrackingOptions } from '../page-view-tracking';\n\nexport interface BrowserConfig extends ExternalBrowserConfig, InternalBrowserConfig {}\n\nexport interface ExternalBrowserConfig extends Config {\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 * 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 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\ninterface InternalBrowserConfig {\n cookieStorage: Storage<UserSession>;\n lastEventTime?: number;\n lastEventId?: number;\n transportProvider: Transport;\n}\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 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';\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface BrowserOptions extends Omit<Partial<ExternalBrowserConfig>, HiddenOptions> {}\n"]}
package/lib/esm/config/core.d.ts CHANGED
@@ -7,22 +7,78 @@ import { Transport } from '../transport';
7
7
  import { Logger, LogLevel } from '../logger';
8
8
  import { OfflineDisabled } from '../offline';
9
9
  export interface Config {
10
+ /**
11
+ * Your Amplitude Project API key.
12
+ */
10
13
  apiKey: string;
14
+ /**
15
+ * The interval of uploading events to Amplitude in milliseconds.
16
+ */
11
17
  flushIntervalMillis: number;
18
+ /**
19
+ * The maximum number of retries for failed upload attempts. This is only applicable to retryable errors.
20
+ */
12
21
  flushMaxRetries: number;
22
+ /**
23
+ * The maximum number of events that are batched in a single upload attempt.
24
+ */
13
25
  flushQueueSize: number;
26
+ /**
27
+ * The instance name. For tracking events to multiple Amplitude projects in your application.
28
+ */
14
29
  instanceName?: string;
30
+ /**
31
+ * Level of logs to be printed in the developer console.
32
+ * Valid values are `LogLevel.None`, `LogLevel.Error`, `LogLevel.Warn`, `LogLevel.Verbose`, `LogLevel.Debug`
33
+ */
15
34
  logLevel: LogLevel;
35
+ /**
36
+ * A custom Logger class to emit log messages to desired destination.
37
+ */
16
38
  loggerProvider: Logger;
39
+ /**
40
+ * The minimum length for the value of userId and deviceId properties.
41
+ */
17
42
  minIdLength?: number;
43
+ /**
44
+ * Whether the SDK is connected to network.
45
+ */
18
46
  offline?: boolean | typeof OfflineDisabled;
47
+ /**
48
+ * The flag to opt this device out of Amplitude tracking.
49
+ * If this flag is set, no additional information will be stored for the user.
50
+ */
19
51
  optOut: boolean;
52
+ /**
53
+ * Tracking plan properties.
54
+ * Amplitude internal use.
55
+ */
20
56
  plan?: Plan;
57
+ /**
58
+ * Ingestion metadata.
59
+ * Amplitude internal use.
60
+ */
21
61
  ingestionMetadata?: IngestionMetadata;
62
+ /**
63
+ * The URL where events are upload to.
64
+ */
22
65
  serverUrl?: string;
66
+ /**
67
+ * The Amplitude server zone.
68
+ * Set this to EU for Amplitude projects created in EU data center.
69
+ */
23
70
  serverZone?: ServerZoneType;
71
+ /**
72
+ * The storage provider to persist unsent events.
73
+ */
24
74
  storageProvider?: Storage<Event[]>;
75
+ /**
76
+ * A customer Transport Class for sending data to a server.
77
+ */
25
78
  transportProvider: Transport;
79
+ /**
80
+ * The flag of whether to upload events to Batch API instead of the default HTTP V2 API.
81
+ */
26
82
  useBatch: boolean;
27
83
  }
28
84
  export interface Options extends Partial<Config> {
package/lib/esm/config/core.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,eAAe,CAAC;IAC3C,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC,iBAAiB,EAAE,SAAS,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,SAAS,CAAC;CAC9B"}
1
+ {"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AACjC,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,eAAe,CAAC;IAC3C;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;OAGG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,iBAAiB,EAAE,SAAS,CAAC;IAC7B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,SAAS,CAAC;CAC9B"}
package/lib/esm/config/core.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from '../event';\nimport { IngestionMetadata } from '../ingestion-metadata';\nimport { Plan } from '../plan';\nimport { ServerZoneType } from '../server-zone';\nimport { Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Logger, LogLevel } from '../logger';\nimport { OfflineDisabled } from '../offline';\n\nexport interface Config {\n apiKey: string;\n flushIntervalMillis: number;\n flushMaxRetries: number;\n flushQueueSize: number;\n instanceName?: string;\n logLevel: LogLevel;\n loggerProvider: Logger;\n minIdLength?: number;\n offline?: boolean | typeof OfflineDisabled;\n optOut: boolean;\n plan?: Plan;\n ingestionMetadata?: IngestionMetadata;\n serverUrl?: string;\n serverZone?: ServerZoneType;\n storageProvider?: Storage<Event[]>;\n transportProvider: Transport;\n useBatch: boolean;\n}\n\nexport interface Options extends Partial<Config> {\n apiKey: string;\n transportProvider: Transport;\n}\n"]}
1
+ {"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/config/core.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from '../event';\nimport { IngestionMetadata } from '../ingestion-metadata';\nimport { Plan } from '../plan';\nimport { ServerZoneType } from '../server-zone';\nimport { Storage } from '../storage';\nimport { Transport } from '../transport';\nimport { Logger, LogLevel } from '../logger';\nimport { OfflineDisabled } from '../offline';\n\nexport interface Config {\n /**\n * Your Amplitude Project API key.\n */\n apiKey: string;\n /**\n * The interval of uploading events to Amplitude in milliseconds.\n */\n flushIntervalMillis: number;\n /**\n * The maximum number of retries for failed upload attempts. This is only applicable to retryable errors.\n */\n flushMaxRetries: number;\n /**\n * The maximum number of events that are batched in a single upload attempt.\n */\n flushQueueSize: number;\n /**\n * The instance name. For tracking events to multiple Amplitude projects in your application.\n */\n instanceName?: string;\n /**\n * Level of logs to be printed in the developer console.\n * Valid values are `LogLevel.None`, `LogLevel.Error`, `LogLevel.Warn`, `LogLevel.Verbose`, `LogLevel.Debug`\n */\n logLevel: LogLevel;\n /**\n * A custom Logger class to emit log messages to desired destination.\n */\n loggerProvider: Logger;\n /**\n * The minimum length for the value of userId and deviceId properties.\n */\n minIdLength?: number;\n /**\n * Whether the SDK is connected to network.\n */\n offline?: boolean | typeof OfflineDisabled;\n /**\n * The flag to opt this device out of Amplitude tracking.\n * If this flag is set, no additional information will be stored for the user.\n */\n optOut: boolean;\n /**\n * Tracking plan properties.\n * Amplitude internal use.\n */\n plan?: Plan;\n /**\n * Ingestion metadata.\n * Amplitude internal use.\n */\n ingestionMetadata?: IngestionMetadata;\n /**\n * The URL where events are upload to.\n */\n serverUrl?: string;\n /**\n * The Amplitude server zone.\n * Set this to EU for Amplitude projects created in EU data center.\n */\n serverZone?: ServerZoneType;\n /**\n * The storage provider to persist unsent events.\n */\n storageProvider?: Storage<Event[]>;\n /**\n * A customer Transport Class for sending data to a server.\n */\n transportProvider: Transport;\n /**\n * The flag of whether to upload events to Batch API instead of the default HTTP V2 API.\n */\n useBatch: boolean;\n}\n\nexport interface Options extends Partial<Config> {\n apiKey: string;\n transportProvider: Transport;\n}\n"]}
package/lib/esm/user-session.d.ts CHANGED
@@ -6,5 +6,6 @@ export interface UserSession {
6
6
  optOut: boolean;
7
7
  lastEventId?: number;
8
8
  pageCounter?: number;
9
+ debugLogsEnabled?: boolean;
9
10
  }
10
11
  //# sourceMappingURL=user-session.d.ts.map
package/lib/esm/user-session.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"user-session.d.ts","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
1
+ {"version":3,"file":"user-session.d.ts","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B"}
package/lib/esm/user-session.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"user-session.js","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"","sourcesContent":["export interface UserSession {\n userId?: string;\n deviceId?: string;\n sessionId?: number;\n lastEventTime?: number;\n optOut: boolean;\n lastEventId?: number;\n pageCounter?: number;\n}\n"]}
1
+ {"version":3,"file":"user-session.js","sourceRoot":"","sources":["../../src/user-session.ts"],"names":[],"mappings":"","sourcesContent":["export interface UserSession {\n userId?: string;\n deviceId?: string;\n sessionId?: number;\n lastEventTime?: number;\n optOut: boolean;\n lastEventId?: number;\n pageCounter?: number;\n debugLogsEnabled?: boolean;\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amplitude/analytics-types",
3
- "version": "2.5.0",
3
+ "version": "2.6.0",
4
4
  "description": "",
5
5
  "author": "Amplitude Inc",
6
6
  "homepage": "https://github.com/amplitude/Amplitude-TypeScript",
@@ -35,5 +35,5 @@
35
35
  "files": [
36
36
  "lib"
37
37
  ],
38
- "gitHead": "33fa1bd2b8e307a8a8d0a86610f8d893bf8aa5aa"
38
+ "gitHead": "79b78f3a3c810012825defd513488bdf3390ac0c"
39
39
  }