@amplitude/analytics-types 0.3.0 → 0.4.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.
@@ -0,0 +1,33 @@
1
+ import { BaseEvent } from './base-event';
2
+ import { AttributionBrowserOptions } from './config';
3
+ import { Storage } from './storage';
4
+ export interface UTMParameters extends Record<string, string | undefined> {
5
+ utm_source: string | undefined;
6
+ utm_medium: string | undefined;
7
+ utm_campaign: string | undefined;
8
+ utm_term: string | undefined;
9
+ utm_content: string | undefined;
10
+ }
11
+ export interface ReferrerParameters extends Record<string, string | undefined> {
12
+ referrer: string | undefined;
13
+ referring_domain: string | undefined;
14
+ }
15
+ export interface ClickIdParameters extends Record<string, string | undefined> {
16
+ gclid: string | undefined;
17
+ fbclid: string | undefined;
18
+ }
19
+ export interface Campaign extends UTMParameters, ReferrerParameters, ClickIdParameters {
20
+ }
21
+ export interface CampaignParser {
22
+ parse(): Campaign;
23
+ }
24
+ export interface CampaignTrackerOptions extends AttributionBrowserOptions {
25
+ storage: Storage<Campaign>;
26
+ track: CampaignTrackFunction;
27
+ onNewCampaign: (campaign: Campaign) => unknown;
28
+ }
29
+ export interface CampaignTracker extends CampaignTrackerOptions {
30
+ send(force: boolean): Promise<void>;
31
+ }
32
+ export declare type CampaignTrackFunction = (event: BaseEvent) => Promise<unknown>;
33
+ //# sourceMappingURL=campaign.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"campaign.d.ts","sourceRoot":"","sources":["../src/campaign.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACvE,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,kBAAmB,SAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5E,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,iBAAkB,SAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3E,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,QAAS,SAAQ,aAAa,EAAE,kBAAkB,EAAE,iBAAiB;CAAG;AAEzF,MAAM,WAAW,cAAc;IAC7B,KAAK,IAAI,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3B,KAAK,EAAE,qBAAqB,CAAC;IAC7B,aAAa,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC;CAChD;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;IAC7D,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC;AAED,oBAAY,qBAAqB,GAAG,CAAC,KAAK,EAAE,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ Object.defineProperty(exports, "__esModule", { value: true });
2
+ //# sourceMappingURL=campaign.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"campaign.js","sourceRoot":"","sources":["../src/campaign.ts"],"names":[],"mappings":"","sourcesContent":["import { BaseEvent } from './base-event';\nimport { AttributionBrowserOptions } from './config';\nimport { Storage } from './storage';\n\nexport interface UTMParameters extends Record<string, string | undefined> {\n utm_source: string | undefined;\n utm_medium: string | undefined;\n utm_campaign: string | undefined;\n utm_term: string | undefined;\n utm_content: string | undefined;\n}\n\nexport interface ReferrerParameters extends Record<string, string | undefined> {\n referrer: string | undefined;\n referring_domain: string | undefined;\n}\n\nexport interface ClickIdParameters extends Record<string, string | undefined> {\n gclid: string | undefined;\n fbclid: string | undefined;\n}\n\nexport interface Campaign extends UTMParameters, ReferrerParameters, ClickIdParameters {}\n\nexport interface CampaignParser {\n parse(): Campaign;\n}\n\nexport interface CampaignTrackerOptions extends AttributionBrowserOptions {\n storage: Storage<Campaign>;\n track: CampaignTrackFunction;\n onNewCampaign: (campaign: Campaign) => unknown;\n}\n\nexport interface CampaignTracker extends CampaignTrackerOptions {\n send(force: boolean): Promise<void>;\n}\n\nexport type CampaignTrackFunction = (event: BaseEvent) => Promise<unknown>;\n"]}
package/lib/config.d.ts CHANGED
@@ -1,9 +1,10 @@
1
1
  import { LogLevel, Logger } from './logger';
2
- import { Storage, UserSession } from './storage';
2
+ import { Storage } from './storage';
3
3
  import { Event } from './event';
4
4
  import { Transport, TransportType } from './transport';
5
5
  import { Plan } from './plan';
6
6
  import { Plugin } from './plugin';
7
+ import { UserSession } from './session-manager';
7
8
  export declare enum ServerZone {
8
9
  US = "US",
9
10
  EU = "EU"
@@ -35,10 +36,7 @@ export interface BrowserConfig extends Config {
35
36
  cookieStorage: Storage<UserSession>;
36
37
  disableCookies: boolean;
37
38
  domain: string;
38
- includeGclid: boolean;
39
- includeFbclid: boolean;
40
- includeReferrer: boolean;
41
- includeUtm: boolean;
39
+ lastEventTime?: number;
42
40
  partnerId?: string;
43
41
  sessionId?: number;
44
42
  sessionTimeout: number;
@@ -51,7 +49,7 @@ export declare type InitOptions<T extends Config> = Partial<Config> & Omit<T, ke
51
49
  transportProvider: Transport;
52
50
  storageProvider: Storage<Event[]>;
53
51
  };
54
- export declare type TrackingOptions = {
52
+ export interface TrackingOptions {
55
53
  city?: boolean;
56
54
  country?: boolean;
57
55
  carrier?: boolean;
@@ -65,9 +63,19 @@ export declare type TrackingOptions = {
65
63
  platform?: boolean;
66
64
  region?: boolean;
67
65
  versionName?: boolean;
68
- };
66
+ }
67
+ export interface AdditionalBrowserOptions {
68
+ attribution?: AttributionBrowserOptions;
69
+ }
70
+ export interface AttributionBrowserOptions {
71
+ disabled?: boolean;
72
+ excludeReferrers?: string[];
73
+ initialEmptyValue?: string;
74
+ trackNewCampaigns?: boolean;
75
+ trackPageViews?: boolean;
76
+ }
69
77
  export declare type BrowserOptions = Omit<Partial<BrowserConfig & {
70
78
  transport: TransportType;
71
- }>, 'apiKey' | 'userId' | 'plugins'>;
72
- export declare type NodeOptions = Omit<Partial<NodeConfig>, 'apiKey' | 'userId' | 'plugins'>;
79
+ }>, 'apiKey' | 'plugins'>;
80
+ export declare type NodeOptions = Omit<Partial<NodeConfig>, 'apiKey' | 'userId' | 'plugins' | 'lastEventTime'>;
73
81
  //# sourceMappingURL=config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAEjD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,oBAAY,UAAU;IACpB,EAAE,OAAO;IACT,EAAE,OAAO;CACV;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IAClC,iBAAiB,EAAE,SAAS,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACpC,cAAc,EAAE,OAAO,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,oBAAY,WAAW,CAAC,CAAC,SAAS,MAAM,IACpC,OAAO,CAAC,MAAM,CAAC,GACb,IAAI,CAAC,CAAC,EAAE,MAAM,MAAM,CAAC,GAAG;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,SAAS,CAAC;IAC7B,eAAe,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;CACnC,CAAC;AAER,oBAAY,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,oBAAY,cAAc,GAAG,IAAI,CAC/B,OAAO,CACL,aAAa,GAAG;IACd,SAAS,EAAE,aAAa,CAAC;CAC1B,CACF,EACD,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAChC,CAAC;AAEF,oBAAY,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC,CAAC"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,oBAAY,UAAU;IACpB,EAAE,OAAO;IACT,EAAE,OAAO;CACV;AAED,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IAClC,iBAAiB,EAAE,SAAS,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACpC,cAAc,EAAE,OAAO,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,oBAAY,WAAW,CAAC,CAAC,SAAS,MAAM,IACpC,OAAO,CAAC,MAAM,CAAC,GACb,IAAI,CAAC,CAAC,EAAE,MAAM,MAAM,CAAC,GAAG;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,SAAS,CAAC;IAC7B,eAAe,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;CACnC,CAAC;AAER,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,EAAE,yBAAyB,CAAC;CACzC;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,oBAAY,cAAc,GAAG,IAAI,CAC/B,OAAO,CACL,aAAa,GAAG;IACd,SAAS,EAAE,aAAa,CAAC;CAC1B,CACF,EACD,QAAQ,GAAG,SAAS,CACrB,CAAC;AAEF,oBAAY,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,eAAe,CAAC,CAAC"}
package/lib/config.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAQA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,uBAAS,CAAA;IACT,uBAAS,CAAA;AACX,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB","sourcesContent":["import { LogLevel, Logger } from './logger';\nimport { Storage, UserSession } from './storage';\n\nimport { Event } from './event';\nimport { Transport, TransportType } from './transport';\nimport { Plan } from './plan';\nimport { Plugin } from './plugin';\n\nexport enum ServerZone {\n US = 'US',\n EU = 'EU',\n}\n\nexport interface Config {\n apiKey: string;\n flushIntervalMillis: number;\n flushMaxRetries: number;\n flushQueueSize: number;\n logLevel: LogLevel;\n loggerProvider: Logger;\n minIdLength?: number;\n optOut: boolean;\n plan?: Plan;\n plugins: Plugin[];\n saveEvents: boolean;\n serverUrl: string | undefined;\n serverZone?: ServerZone;\n storageProvider: Storage<Event[]>;\n transportProvider: Transport;\n useBatch: boolean;\n}\n\nexport interface BrowserConfig extends Config {\n appVersion?: string;\n deviceId?: string;\n cookieExpiration: number;\n cookieSameSite: string;\n cookieSecure: boolean;\n cookieStorage: Storage<UserSession>;\n disableCookies: boolean;\n domain: string;\n includeGclid: boolean;\n includeFbclid: boolean;\n includeReferrer: boolean;\n includeUtm: boolean;\n partnerId?: string;\n sessionId?: number;\n sessionTimeout: number;\n trackingOptions: TrackingOptions;\n userId?: string;\n}\n\nexport type NodeConfig = Config;\n\nexport type InitOptions<T extends Config> =\n | Partial<Config> &\n Omit<T, keyof Config> & {\n apiKey: string;\n transportProvider: Transport;\n storageProvider: Storage<Event[]>;\n };\n\nexport type TrackingOptions = {\n city?: boolean;\n country?: boolean;\n carrier?: boolean;\n deviceManufacturer?: boolean;\n deviceModel?: boolean;\n dma?: boolean;\n ipAddress?: boolean;\n language?: boolean;\n osName?: boolean;\n osVersion?: boolean;\n platform?: boolean;\n region?: boolean;\n versionName?: boolean;\n};\n\nexport type BrowserOptions = Omit<\n Partial<\n BrowserConfig & {\n transport: TransportType;\n }\n >,\n 'apiKey' | 'userId' | 'plugins'\n>;\n\nexport type NodeOptions = Omit<Partial<NodeConfig>, 'apiKey' | 'userId' | 'plugins'>;\n"]}
1
+ {"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AASA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,uBAAS,CAAA;IACT,uBAAS,CAAA;AACX,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB","sourcesContent":["import { LogLevel, Logger } from './logger';\nimport { Storage } from './storage';\n\nimport { Event } from './event';\nimport { Transport, TransportType } from './transport';\nimport { Plan } from './plan';\nimport { Plugin } from './plugin';\nimport { UserSession } from './session-manager';\n\nexport enum ServerZone {\n US = 'US',\n EU = 'EU',\n}\n\nexport interface Config {\n apiKey: string;\n flushIntervalMillis: number;\n flushMaxRetries: number;\n flushQueueSize: number;\n logLevel: LogLevel;\n loggerProvider: Logger;\n minIdLength?: number;\n optOut: boolean;\n plan?: Plan;\n plugins: Plugin[];\n saveEvents: boolean;\n serverUrl: string | undefined;\n serverZone?: ServerZone;\n storageProvider: Storage<Event[]>;\n transportProvider: Transport;\n useBatch: boolean;\n}\n\nexport interface BrowserConfig extends Config {\n appVersion?: string;\n deviceId?: string;\n cookieExpiration: number;\n cookieSameSite: string;\n cookieSecure: boolean;\n cookieStorage: Storage<UserSession>;\n disableCookies: boolean;\n domain: string;\n lastEventTime?: number;\n partnerId?: string;\n sessionId?: number;\n sessionTimeout: number;\n trackingOptions: TrackingOptions;\n userId?: string;\n}\n\nexport type NodeConfig = Config;\n\nexport type InitOptions<T extends Config> =\n | Partial<Config> &\n Omit<T, keyof Config> & {\n apiKey: string;\n transportProvider: Transport;\n storageProvider: Storage<Event[]>;\n };\n\nexport interface TrackingOptions {\n city?: boolean;\n country?: boolean;\n carrier?: boolean;\n deviceManufacturer?: boolean;\n deviceModel?: boolean;\n dma?: boolean;\n ipAddress?: boolean;\n language?: boolean;\n osName?: boolean;\n osVersion?: boolean;\n platform?: boolean;\n region?: boolean;\n versionName?: boolean;\n}\n\nexport interface AdditionalBrowserOptions {\n attribution?: AttributionBrowserOptions;\n}\n\nexport interface AttributionBrowserOptions {\n disabled?: boolean;\n excludeReferrers?: string[];\n initialEmptyValue?: string;\n trackNewCampaigns?: boolean;\n trackPageViews?: boolean;\n}\n\nexport type BrowserOptions = Omit<\n Partial<\n BrowserConfig & {\n transport: TransportType;\n }\n >,\n 'apiKey' | 'plugins'\n>;\n\nexport type NodeOptions = Omit<Partial<NodeConfig>, 'apiKey' | 'userId' | 'plugins' | 'lastEventTime'>;\n"]}
package/lib/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  export { AmplitudeReturn } from './amplitude-promise';
2
2
  export { BaseEvent, EventOptions } from './base-event';
3
- export { BrowserConfig, BrowserOptions, Config, InitOptions, NodeConfig, NodeOptions, TrackingOptions, ServerZone, } from './config';
3
+ export { Campaign, CampaignParser, CampaignTracker, CampaignTrackerOptions, CampaignTrackFunction, ClickIdParameters, ReferrerParameters, UTMParameters, } from './campaign';
4
+ export { AdditionalBrowserOptions, AttributionBrowserOptions, BrowserConfig, BrowserOptions, Config, InitOptions, NodeConfig, NodeOptions, TrackingOptions, ServerZone, } from './config';
4
5
  export { CoreClient } from './core-client';
5
6
  export { DestinationContext } from './destination-context';
6
7
  export { Event, TrackEvent, IdentifyEvent, GroupIdentifyEvent, SpecialEventType, IdentifyOperation, IdentifyUserProperties, ValidPropertyType, Identify, Revenue, RevenueEvent, RevenueProperty, RevenueEventProperties, } from './event';
@@ -13,8 +14,9 @@ export { Plugin, BeforePlugin, EnrichmentPlugin, DestinationPlugin, AmplitudeDes
13
14
  export { Result } from './result';
14
15
  export { Response, SuccessResponse, InvalidResponse, PayloadTooLargeResponse, RateLimitResponse } from './response';
15
16
  export { QueueProxy, InstanceProxy } from './proxy';
17
+ export { SessionManager, SessionManagerOptions, UserSession } from './session-manager';
16
18
  export { Status } from './status';
17
- export { CookieStorageOptions, Storage, UserSession } from './storage';
19
+ export { CookieStorageOptions, Storage } from './storage';
18
20
  export { Transport, TransportType } from './transport';
19
21
  export { UTMData } from './utm';
20
22
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EACL,aAAa,EACb,cAAc,EACd,MAAM,EACN,WAAW,EACX,UAAU,EACV,WAAW,EACX,eAAe,EACf,UAAU,GACX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,KAAK,EACL,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,eAAe,EACf,sBAAsB,GACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC5G,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,0BAA0B,EAC1B,UAAU,GACX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,eAAe,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpH,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EACL,QAAQ,EACR,cAAc,EACd,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,GACd,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,wBAAwB,EACxB,yBAAyB,EACzB,aAAa,EACb,cAAc,EACd,MAAM,EACN,WAAW,EACX,UAAU,EACV,WAAW,EACX,eAAe,EACf,UAAU,GACX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EACL,KAAK,EACL,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,eAAe,EACf,sBAAsB,GACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAC5G,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EACL,MAAM,EACN,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,0BAA0B,EAC1B,UAAU,GACX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,eAAe,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpH,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC"}
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAEA,mCASkB;AADhB,oGAAA,UAAU,OAAA;AAIZ,iCAciB;AATf,yGAAA,gBAAgB,OAAA;AAChB,0GAAA,iBAAiB,OAAA;AAMjB,wGAAA,eAAe,OAAA;AAKjB,mCAA4C;AAA3B,kGAAA,QAAQ,OAAA;AAGzB,mCAOkB;AADhB,oGAAA,UAAU,OAAA;AAKZ,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAEf,yCAAuD;AAAnC,0GAAA,aAAa,OAAA","sourcesContent":["export { AmplitudeReturn } from './amplitude-promise';\nexport { BaseEvent, EventOptions } from './base-event';\nexport {\n BrowserConfig,\n BrowserOptions,\n Config,\n InitOptions,\n NodeConfig,\n NodeOptions,\n TrackingOptions,\n ServerZone,\n} from './config';\nexport { CoreClient } from './core-client';\nexport { DestinationContext } from './destination-context';\nexport {\n Event,\n TrackEvent,\n IdentifyEvent,\n GroupIdentifyEvent,\n SpecialEventType,\n IdentifyOperation,\n IdentifyUserProperties,\n ValidPropertyType,\n Identify,\n Revenue,\n RevenueEvent,\n RevenueProperty,\n RevenueEventProperties,\n} from './event';\nexport { EventCallback } from './event-callback';\nexport { EventBridge, EventBridgeChannel, EventBridgeContainer, EventBridgeReceiver } from './event-bridge';\nexport { Logger, LogLevel } from './logger';\nexport { Payload } from './payload';\nexport { Plan } from './plan';\nexport {\n Plugin,\n BeforePlugin,\n EnrichmentPlugin,\n DestinationPlugin,\n AmplitudeDestinationPlugin,\n PluginType,\n} from './plugin';\nexport { Result } from './result';\nexport { Response, SuccessResponse, InvalidResponse, PayloadTooLargeResponse, RateLimitResponse } from './response';\nexport { QueueProxy, InstanceProxy } from './proxy';\nexport { Status } from './status';\nexport { CookieStorageOptions, Storage, UserSession } from './storage';\nexport { Transport, TransportType } from './transport';\nexport { UTMData } from './utm';\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAYA,mCAWkB;AADhB,oGAAA,UAAU,OAAA;AAIZ,iCAciB;AATf,yGAAA,gBAAgB,OAAA;AAChB,0GAAA,iBAAiB,OAAA;AAMjB,wGAAA,eAAe,OAAA;AAKjB,mCAA4C;AAA3B,kGAAA,QAAQ,OAAA;AAGzB,mCAOkB;AADhB,oGAAA,UAAU,OAAA;AAMZ,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAEf,yCAAuD;AAAnC,0GAAA,aAAa,OAAA","sourcesContent":["export { AmplitudeReturn } from './amplitude-promise';\nexport { BaseEvent, EventOptions } from './base-event';\nexport {\n Campaign,\n CampaignParser,\n CampaignTracker,\n CampaignTrackerOptions,\n CampaignTrackFunction,\n ClickIdParameters,\n ReferrerParameters,\n UTMParameters,\n} from './campaign';\nexport {\n AdditionalBrowserOptions,\n AttributionBrowserOptions,\n BrowserConfig,\n BrowserOptions,\n Config,\n InitOptions,\n NodeConfig,\n NodeOptions,\n TrackingOptions,\n ServerZone,\n} from './config';\nexport { CoreClient } from './core-client';\nexport { DestinationContext } from './destination-context';\nexport {\n Event,\n TrackEvent,\n IdentifyEvent,\n GroupIdentifyEvent,\n SpecialEventType,\n IdentifyOperation,\n IdentifyUserProperties,\n ValidPropertyType,\n Identify,\n Revenue,\n RevenueEvent,\n RevenueProperty,\n RevenueEventProperties,\n} from './event';\nexport { EventCallback } from './event-callback';\nexport { EventBridge, EventBridgeChannel, EventBridgeContainer, EventBridgeReceiver } from './event-bridge';\nexport { Logger, LogLevel } from './logger';\nexport { Payload } from './payload';\nexport { Plan } from './plan';\nexport {\n Plugin,\n BeforePlugin,\n EnrichmentPlugin,\n DestinationPlugin,\n AmplitudeDestinationPlugin,\n PluginType,\n} from './plugin';\nexport { Result } from './result';\nexport { Response, SuccessResponse, InvalidResponse, PayloadTooLargeResponse, RateLimitResponse } from './response';\nexport { QueueProxy, InstanceProxy } from './proxy';\nexport { SessionManager, SessionManagerOptions, UserSession } from './session-manager';\nexport { Status } from './status';\nexport { CookieStorageOptions, Storage } from './storage';\nexport { Transport, TransportType } from './transport';\nexport { UTMData } from './utm';\n"]}
@@ -0,0 +1,25 @@
1
+ export interface UserSession {
2
+ userId?: string;
3
+ deviceId?: string;
4
+ sessionId?: number;
5
+ lastEventTime?: number;
6
+ optOut: boolean;
7
+ }
8
+ export interface SessionManagerOptions {
9
+ apiKey: string;
10
+ sessionTimeout: number;
11
+ }
12
+ export interface SessionManager {
13
+ setSession(session: UserSession): void;
14
+ getSessionId(): number | undefined;
15
+ setSessionId(sessionId?: number): void;
16
+ getDeviceId(): string | undefined;
17
+ setDeviceId(deviceId?: string): void;
18
+ getUserId(): string | undefined;
19
+ setUserId(userId?: string): void;
20
+ getLastEventTime(): number | undefined;
21
+ setLastEventTime(lastEventTime?: number): void;
22
+ getOptOut(): boolean;
23
+ setOptOut(optOut: boolean): void;
24
+ }
25
+ //# sourceMappingURL=session-manager.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"session-manager.d.ts","sourceRoot":"","sources":["../src/session-manager.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;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IACvC,YAAY,IAAI,MAAM,GAAG,SAAS,CAAC;IACnC,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,WAAW,IAAI,MAAM,GAAG,SAAS,CAAC;IAClC,WAAW,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,SAAS,IAAI,MAAM,GAAG,SAAS,CAAC;IAChC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAAC;IACvC,gBAAgB,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/C,SAAS,IAAI,OAAO,CAAC;IACrB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CAClC"}
@@ -0,0 +1,2 @@
1
+ Object.defineProperty(exports, "__esModule", { value: true });
2
+ //# sourceMappingURL=session-manager.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"session-manager.js","sourceRoot":"","sources":["../src/session-manager.ts"],"names":[],"mappings":"","sourcesContent":["export interface UserSession {\n userId?: string;\n deviceId?: string;\n sessionId?: number;\n lastEventTime?: number;\n optOut: boolean;\n}\n\nexport interface SessionManagerOptions {\n apiKey: string;\n sessionTimeout: number;\n}\n\nexport interface SessionManager {\n setSession(session: UserSession): void;\n getSessionId(): number | undefined;\n setSessionId(sessionId?: number): void;\n getDeviceId(): string | undefined;\n setDeviceId(deviceId?: string): void;\n getUserId(): string | undefined;\n setUserId(userId?: string): void;\n getLastEventTime(): number | undefined;\n setLastEventTime(lastEventTime?: number): void;\n getOptOut(): boolean;\n setOptOut(optOut: boolean): void;\n}\n"]}
package/lib/storage.d.ts CHANGED
@@ -1,10 +1,3 @@
1
- export interface UserSession {
2
- userId?: string;
3
- deviceId?: string;
4
- sessionId?: number;
5
- lastEventTime?: number;
6
- optOut: boolean;
7
- }
8
1
  export interface Storage<T> {
9
2
  isEnabled(): boolean;
10
3
  get(key: string): T | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.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;CACjB;AAED,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB,SAAS,IAAI,OAAO,CAAC;IACrB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAChC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACxC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IACjC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,IAAI,IAAI,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}
1
+ {"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB,SAAS,IAAI,OAAO,CAAC;IACrB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAChC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACxC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IACjC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,KAAK,IAAI,IAAI,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}
@@ -1 +1 @@
1
- {"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"","sourcesContent":["export interface UserSession {\n userId?: string;\n deviceId?: string;\n sessionId?: number;\n lastEventTime?: number;\n optOut: boolean;\n}\n\nexport interface Storage<T> {\n isEnabled(): boolean;\n get(key: string): T | undefined;\n getRaw(key: string): string | undefined;\n set(key: string, value: T): void;\n remove(key: string): void;\n reset(): void;\n}\n\nexport interface CookieStorageOptions {\n domain?: string;\n expirationDays?: number;\n sameSite?: string;\n secure?: boolean;\n}\n"]}
1
+ {"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"","sourcesContent":["export interface Storage<T> {\n isEnabled(): boolean;\n get(key: string): T | undefined;\n getRaw(key: string): string | undefined;\n set(key: string, value: T): void;\n remove(key: string): void;\n reset(): void;\n}\n\nexport interface CookieStorageOptions {\n domain?: string;\n expirationDays?: number;\n sameSite?: string;\n secure?: boolean;\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@amplitude/analytics-types",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "",
5
5
  "author": "Amplitude Inc",
6
6
  "homepage": "https://github.com/amplitude/Amplitude-TypeScript",
@@ -30,5 +30,5 @@
30
30
  "files": [
31
31
  "lib"
32
32
  ],
33
- "gitHead": "b76a2494587c6a27e2007047c1602269ed2b3403"
33
+ "gitHead": "139379f59cb6ba6031a01355d1125d6b78c12b9c"
34
34
  }