@amplitude/analytics-types 0.10.0 → 0.10.1
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.
- package/lib/{amplitude-promise.d.ts → cjs/amplitude-promise.d.ts} +0 -0
- package/lib/cjs/amplitude-promise.d.ts.map +1 -0
- package/lib/{amplitude-promise.js → cjs/amplitude-promise.js} +0 -0
- package/lib/cjs/amplitude-promise.js.map +1 -0
- package/lib/{base-event.d.ts → cjs/base-event.d.ts} +0 -0
- package/lib/cjs/base-event.d.ts.map +1 -0
- package/lib/{base-event.js → cjs/base-event.js} +0 -0
- package/lib/cjs/base-event.js.map +1 -0
- package/lib/{campaign.d.ts → cjs/campaign.d.ts} +0 -0
- package/lib/cjs/campaign.d.ts.map +1 -0
- package/lib/{campaign.js → cjs/campaign.js} +0 -0
- package/lib/cjs/campaign.js.map +1 -0
- package/lib/{client → cjs/client}/base-client.d.ts +0 -0
- package/lib/cjs/client/base-client.d.ts.map +1 -0
- package/lib/{client → cjs/client}/base-client.js +0 -0
- package/lib/cjs/client/base-client.js.map +1 -0
- package/lib/{client → cjs/client}/index.d.ts +0 -0
- package/lib/cjs/client/index.d.ts.map +1 -0
- package/lib/{client → cjs/client}/index.js +0 -0
- package/lib/cjs/client/index.js.map +1 -0
- package/lib/{client → cjs/client}/node-client.d.ts +0 -0
- package/lib/cjs/client/node-client.d.ts.map +1 -0
- package/lib/{client → cjs/client}/node-client.js +0 -0
- package/lib/cjs/client/node-client.js.map +1 -0
- package/lib/{client → cjs/client}/web-client.d.ts +0 -0
- package/lib/cjs/client/web-client.d.ts.map +1 -0
- package/lib/{client → cjs/client}/web-client.js +0 -0
- package/lib/cjs/client/web-client.js.map +1 -0
- package/lib/{config.d.ts → cjs/config.d.ts} +0 -0
- package/lib/cjs/config.d.ts.map +1 -0
- package/lib/{config.js → cjs/config.js} +0 -0
- package/lib/cjs/config.js.map +1 -0
- package/lib/{core-client.d.ts → cjs/core-client.d.ts} +0 -0
- package/lib/cjs/core-client.d.ts.map +1 -0
- package/lib/{core-client.js → cjs/core-client.js} +0 -0
- package/lib/cjs/core-client.js.map +1 -0
- package/lib/{destination-context.d.ts → cjs/destination-context.d.ts} +0 -0
- package/lib/cjs/destination-context.d.ts.map +1 -0
- package/lib/{destination-context.js → cjs/destination-context.js} +0 -0
- package/lib/cjs/destination-context.js.map +1 -0
- package/lib/{event-bridge.d.ts → cjs/event-bridge.d.ts} +0 -0
- package/lib/cjs/event-bridge.d.ts.map +1 -0
- package/lib/{event-bridge.js → cjs/event-bridge.js} +0 -0
- package/lib/cjs/event-bridge.js.map +1 -0
- package/lib/{event-callback.d.ts → cjs/event-callback.d.ts} +0 -0
- package/lib/cjs/event-callback.d.ts.map +1 -0
- package/lib/{event-callback.js → cjs/event-callback.js} +0 -0
- package/lib/cjs/event-callback.js.map +1 -0
- package/lib/{event.d.ts → cjs/event.d.ts} +0 -0
- package/lib/cjs/event.d.ts.map +1 -0
- package/lib/{event.js → cjs/event.js} +0 -0
- package/lib/cjs/event.js.map +1 -0
- package/lib/{index.d.ts → cjs/index.d.ts} +0 -0
- package/lib/cjs/index.d.ts.map +1 -0
- package/lib/{index.js → cjs/index.js} +0 -0
- package/lib/cjs/index.js.map +1 -0
- package/lib/{ingestion-metadata.d.ts → cjs/ingestion-metadata.d.ts} +0 -0
- package/lib/cjs/ingestion-metadata.d.ts.map +1 -0
- package/lib/{ingestion-metadata.js → cjs/ingestion-metadata.js} +0 -0
- package/lib/cjs/ingestion-metadata.js.map +1 -0
- package/lib/{logger.d.ts → cjs/logger.d.ts} +0 -0
- package/lib/cjs/logger.d.ts.map +1 -0
- package/lib/{logger.js → cjs/logger.js} +0 -0
- package/lib/cjs/logger.js.map +1 -0
- package/lib/{payload.d.ts → cjs/payload.d.ts} +0 -0
- package/lib/cjs/payload.d.ts.map +1 -0
- package/lib/{payload.js → cjs/payload.js} +0 -0
- package/lib/cjs/payload.js.map +1 -0
- package/lib/{plan.d.ts → cjs/plan.d.ts} +0 -0
- package/lib/cjs/plan.d.ts.map +1 -0
- package/lib/{plan.js → cjs/plan.js} +0 -0
- package/lib/cjs/plan.js.map +1 -0
- package/lib/{plugin.d.ts → cjs/plugin.d.ts} +0 -0
- package/lib/cjs/plugin.d.ts.map +1 -0
- package/lib/{plugin.js → cjs/plugin.js} +0 -0
- package/lib/cjs/plugin.js.map +1 -0
- package/lib/{proxy.d.ts → cjs/proxy.d.ts} +0 -0
- package/lib/cjs/proxy.d.ts.map +1 -0
- package/lib/{proxy.js → cjs/proxy.js} +0 -0
- package/lib/cjs/proxy.js.map +1 -0
- package/lib/{response.d.ts → cjs/response.d.ts} +0 -0
- package/lib/cjs/response.d.ts.map +1 -0
- package/lib/{response.js → cjs/response.js} +0 -0
- package/lib/cjs/response.js.map +1 -0
- package/lib/{result.d.ts → cjs/result.d.ts} +0 -0
- package/lib/cjs/result.d.ts.map +1 -0
- package/lib/{result.js → cjs/result.js} +0 -0
- package/lib/cjs/result.js.map +1 -0
- package/lib/{session-manager.d.ts → cjs/session-manager.d.ts} +0 -0
- package/lib/cjs/session-manager.d.ts.map +1 -0
- package/lib/{session-manager.js → cjs/session-manager.js} +0 -0
- package/lib/cjs/session-manager.js.map +1 -0
- package/lib/{status.d.ts → cjs/status.d.ts} +0 -0
- package/lib/cjs/status.d.ts.map +1 -0
- package/lib/{status.js → cjs/status.js} +0 -0
- package/lib/cjs/status.js.map +1 -0
- package/lib/{storage.d.ts → cjs/storage.d.ts} +0 -0
- package/lib/cjs/storage.d.ts.map +1 -0
- package/lib/{storage.js → cjs/storage.js} +0 -0
- package/lib/cjs/storage.js.map +1 -0
- package/lib/{transport.d.ts → cjs/transport.d.ts} +0 -0
- package/lib/cjs/transport.d.ts.map +1 -0
- package/lib/{transport.js → cjs/transport.js} +0 -0
- package/lib/cjs/transport.js.map +1 -0
- package/lib/{utm.d.ts → cjs/utm.d.ts} +0 -0
- package/lib/cjs/utm.d.ts.map +1 -0
- package/lib/{utm.js → cjs/utm.js} +0 -0
- package/lib/cjs/utm.js.map +1 -0
- package/lib/esm/amplitude-promise.d.ts +4 -0
- package/lib/esm/amplitude-promise.d.ts.map +1 -0
- package/lib/esm/amplitude-promise.js +2 -0
- package/lib/esm/amplitude-promise.js.map +1 -0
- package/lib/esm/base-event.d.ts +59 -0
- package/lib/esm/base-event.d.ts.map +1 -0
- package/lib/esm/base-event.js +2 -0
- package/lib/esm/base-event.js.map +1 -0
- package/lib/esm/campaign.d.ts +33 -0
- package/lib/esm/campaign.d.ts.map +1 -0
- package/lib/esm/campaign.js +2 -0
- package/lib/esm/campaign.js.map +1 -0
- package/lib/esm/client/base-client.d.ts +139 -0
- package/lib/esm/client/base-client.d.ts.map +1 -0
- package/lib/esm/client/base-client.js +2 -0
- package/lib/esm/client/base-client.js.map +1 -0
- package/lib/esm/client/index.d.ts +3 -0
- package/lib/esm/client/index.d.ts.map +1 -0
- package/lib/esm/client/index.js +2 -0
- package/lib/esm/client/index.js.map +1 -0
- package/lib/esm/client/node-client.d.ts +15 -0
- package/lib/esm/client/node-client.d.ts.map +1 -0
- package/lib/esm/client/node-client.js +2 -0
- package/lib/esm/client/node-client.js.map +1 -0
- package/lib/esm/client/web-client.d.ts +111 -0
- package/lib/esm/client/web-client.d.ts.map +1 -0
- package/lib/esm/client/web-client.js +2 -0
- package/lib/esm/client/web-client.js.map +1 -0
- package/lib/esm/config.d.ts +83 -0
- package/lib/esm/config.d.ts.map +1 -0
- package/lib/esm/config.js +6 -0
- package/lib/esm/config.js.map +1 -0
- package/lib/esm/core-client.d.ts +8 -0
- package/lib/esm/core-client.d.ts.map +1 -0
- package/lib/esm/core-client.js +2 -0
- package/lib/esm/core-client.js.map +1 -0
- package/lib/esm/destination-context.d.ts +9 -0
- package/lib/esm/destination-context.d.ts.map +1 -0
- package/lib/esm/destination-context.js +2 -0
- package/lib/esm/destination-context.js.map +1 -0
- package/lib/esm/event-bridge.d.ts +16 -0
- package/lib/esm/event-bridge.d.ts.map +1 -0
- package/lib/esm/event-bridge.js +2 -0
- package/lib/esm/event-bridge.js.map +1 -0
- package/lib/esm/event-callback.d.ts +3 -0
- package/lib/esm/event-callback.d.ts.map +1 -0
- package/lib/esm/event-callback.js +2 -0
- package/lib/esm/event-callback.js.map +1 -0
- package/lib/esm/event.d.ts +105 -0
- package/lib/esm/event.d.ts.map +1 -0
- package/lib/esm/event.js +36 -0
- package/lib/esm/event.js.map +1 -0
- package/lib/esm/index.d.ts +24 -0
- package/lib/esm/index.d.ts.map +1 -0
- package/lib/esm/index.js +7 -0
- package/lib/esm/index.js.map +1 -0
- package/lib/esm/ingestion-metadata.d.ts +19 -0
- package/lib/esm/ingestion-metadata.d.ts.map +1 -0
- package/lib/esm/ingestion-metadata.js +2 -0
- package/lib/esm/ingestion-metadata.js.map +1 -0
- package/lib/esm/logger.d.ts +14 -0
- package/lib/esm/logger.d.ts.map +1 -0
- package/lib/esm/logger.js +8 -0
- package/lib/esm/logger.js.map +1 -0
- package/lib/esm/payload.d.ts +10 -0
- package/lib/esm/payload.d.ts.map +1 -0
- package/lib/esm/payload.js +2 -0
- package/lib/esm/payload.js.map +1 -0
- package/lib/esm/plan.d.ts +14 -0
- package/lib/esm/plan.d.ts.map +1 -0
- package/lib/esm/plan.js +2 -0
- package/lib/esm/plan.js.map +1 -0
- package/lib/esm/plugin.d.ts +29 -0
- package/lib/esm/plugin.d.ts.map +1 -0
- package/lib/esm/plugin.js +7 -0
- package/lib/esm/plugin.js.map +1 -0
- package/lib/esm/proxy.d.ts +13 -0
- package/lib/esm/proxy.d.ts.map +1 -0
- package/lib/esm/proxy.js +2 -0
- package/lib/esm/proxy.js.map +1 -0
- package/lib/esm/response.d.ts +81 -0
- package/lib/esm/response.d.ts.map +1 -0
- package/lib/esm/response.js +2 -0
- package/lib/esm/response.js.map +1 -0
- package/lib/esm/result.d.ts +7 -0
- package/lib/esm/result.d.ts.map +1 -0
- package/lib/esm/result.js +2 -0
- package/lib/esm/result.js.map +1 -0
- package/lib/esm/session-manager.d.ts +25 -0
- package/lib/esm/session-manager.d.ts.map +1 -0
- package/lib/esm/session-manager.js +2 -0
- package/lib/esm/session-manager.js.map +1 -0
- package/lib/esm/status.d.ts +22 -0
- package/lib/esm/status.d.ts.map +1 -0
- package/lib/esm/status.js +23 -0
- package/lib/esm/status.js.map +1 -0
- package/lib/esm/storage.d.ts +15 -0
- package/lib/esm/storage.d.ts.map +1 -0
- package/lib/esm/storage.js +2 -0
- package/lib/esm/storage.js.map +1 -0
- package/lib/esm/transport.d.ts +11 -0
- package/lib/esm/transport.d.ts.map +1 -0
- package/lib/esm/transport.js +7 -0
- package/lib/esm/transport.js.map +1 -0
- package/lib/esm/utm.d.ts +8 -0
- package/lib/esm/utm.d.ts.map +1 -0
- package/lib/esm/utm.js +2 -0
- package/lib/esm/utm.js.map +1 -0
- package/package.json +8 -6
- package/lib/amplitude-promise.d.ts.map +0 -1
- package/lib/amplitude-promise.js.map +0 -1
- package/lib/base-event.d.ts.map +0 -1
- package/lib/base-event.js.map +0 -1
- package/lib/campaign.d.ts.map +0 -1
- package/lib/campaign.js.map +0 -1
- package/lib/client/base-client.d.ts.map +0 -1
- package/lib/client/base-client.js.map +0 -1
- package/lib/client/index.d.ts.map +0 -1
- package/lib/client/index.js.map +0 -1
- package/lib/client/node-client.d.ts.map +0 -1
- package/lib/client/node-client.js.map +0 -1
- package/lib/client/web-client.d.ts.map +0 -1
- package/lib/client/web-client.js.map +0 -1
- package/lib/config.d.ts.map +0 -1
- package/lib/config.js.map +0 -1
- package/lib/core-client.d.ts.map +0 -1
- package/lib/core-client.js.map +0 -1
- package/lib/destination-context.d.ts.map +0 -1
- package/lib/destination-context.js.map +0 -1
- package/lib/event-bridge.d.ts.map +0 -1
- package/lib/event-bridge.js.map +0 -1
- package/lib/event-callback.d.ts.map +0 -1
- package/lib/event-callback.js.map +0 -1
- package/lib/event.d.ts.map +0 -1
- package/lib/event.js.map +0 -1
- package/lib/index.d.ts.map +0 -1
- package/lib/index.js.map +0 -1
- package/lib/ingestion-metadata.d.ts.map +0 -1
- package/lib/ingestion-metadata.js.map +0 -1
- package/lib/logger.d.ts.map +0 -1
- package/lib/logger.js.map +0 -1
- package/lib/payload.d.ts.map +0 -1
- package/lib/payload.js.map +0 -1
- package/lib/plan.d.ts.map +0 -1
- package/lib/plan.js.map +0 -1
- package/lib/plugin.d.ts.map +0 -1
- package/lib/plugin.js.map +0 -1
- package/lib/proxy.d.ts.map +0 -1
- package/lib/proxy.js.map +0 -1
- package/lib/response.d.ts.map +0 -1
- package/lib/response.js.map +0 -1
- package/lib/result.d.ts.map +0 -1
- package/lib/result.js.map +0 -1
- package/lib/session-manager.d.ts.map +0 -1
- package/lib/session-manager.js.map +0 -1
- package/lib/status.d.ts.map +0 -1
- package/lib/status.js.map +0 -1
- package/lib/storage.d.ts.map +0 -1
- package/lib/storage.js.map +0 -1
- package/lib/transport.d.ts.map +0 -1
- package/lib/transport.js.map +0 -1
- package/lib/utm.d.ts.map +0 -1
- package/lib/utm.js.map +0 -1
|
@@ -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,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,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,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE,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 @@
|
|
|
1
|
+
{"version":3,"file":"campaign.js","sourceRoot":"","sources":["../../src/campaign.ts"],"names":[],"mappings":"","sourcesContent":["import { BaseEvent } from './base-event';\nimport { AttributionOptions } 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(): Promise<Campaign>;\n}\n\nexport interface CampaignTrackerOptions extends AttributionOptions {\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"]}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import { AmplitudeReturn } from '../amplitude-promise';
|
|
2
|
+
import { BaseEvent, EventOptions } from '../base-event';
|
|
3
|
+
import { Identify, Revenue } from '../event';
|
|
4
|
+
import { Plugin } from '../plugin';
|
|
5
|
+
import { Result } from '../result';
|
|
6
|
+
export interface BaseClient {
|
|
7
|
+
/**
|
|
8
|
+
* Adds a new plugin.
|
|
9
|
+
*
|
|
10
|
+
* ```typescript
|
|
11
|
+
* const plugin = {
|
|
12
|
+
* name: 'myPlugin',
|
|
13
|
+
* type: PluginType.ENRICHMENT,
|
|
14
|
+
* setup(config: Config) {
|
|
15
|
+
* return;
|
|
16
|
+
* },
|
|
17
|
+
* execute(context: Event) {
|
|
18
|
+
* return context;
|
|
19
|
+
* },
|
|
20
|
+
* };
|
|
21
|
+
* amplitude.add(plugin);
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
add(plugin: Plugin): AmplitudeReturn<void>;
|
|
25
|
+
/**
|
|
26
|
+
* Removes a plugin.
|
|
27
|
+
*
|
|
28
|
+
* ```typescript
|
|
29
|
+
* amplitude.remove('myPlugin');
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
remove(pluginName: string): AmplitudeReturn<void>;
|
|
33
|
+
/**
|
|
34
|
+
* Tracks user-defined event, with specified type, optional event properties and optional overwrites.
|
|
35
|
+
*
|
|
36
|
+
* ```typescript
|
|
37
|
+
* // event tracking with event type only
|
|
38
|
+
* track('Page Load');
|
|
39
|
+
*
|
|
40
|
+
* // event tracking with event type and additional event properties
|
|
41
|
+
* track('Page Load', { loadTime: 1000 });
|
|
42
|
+
*
|
|
43
|
+
* // event tracking with event type, additional event properties, and overwritten event options
|
|
44
|
+
* track('Page Load', { loadTime: 1000 }, { sessionId: -1 });
|
|
45
|
+
*
|
|
46
|
+
* // alternatively, this tracking method is awaitable
|
|
47
|
+
* const result = await track('Page Load').promise;
|
|
48
|
+
* console.log(result.event); // {...}
|
|
49
|
+
* console.log(result.code); // 200
|
|
50
|
+
* console.log(result.message); // "Event tracked successfully"
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
track(eventInput: BaseEvent | string, eventProperties?: Record<string, any>, eventOptions?: EventOptions): AmplitudeReturn<Result>;
|
|
54
|
+
/**
|
|
55
|
+
* Alias for track()
|
|
56
|
+
*/
|
|
57
|
+
logEvent(eventInput: BaseEvent | string, eventProperties?: Record<string, any>, eventOptions?: EventOptions): AmplitudeReturn<Result>;
|
|
58
|
+
/**
|
|
59
|
+
* Sends an identify event containing user property operations
|
|
60
|
+
*
|
|
61
|
+
* ```typescript
|
|
62
|
+
* const id = new Identify();
|
|
63
|
+
* id.set('colors', ['rose', 'gold']);
|
|
64
|
+
* identify(id);
|
|
65
|
+
*
|
|
66
|
+
* // alternatively, this tracking method is awaitable
|
|
67
|
+
* const result = await identify(id).promise;
|
|
68
|
+
* console.log(result.event); // {...}
|
|
69
|
+
* console.log(result.code); // 200
|
|
70
|
+
* console.log(result.message); // "Event tracked successfully"
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
identify(identify: Identify, eventOptions?: EventOptions): AmplitudeReturn<Result>;
|
|
74
|
+
/**
|
|
75
|
+
* Sends a group identify event containing group property operations.
|
|
76
|
+
*
|
|
77
|
+
* ```typescript
|
|
78
|
+
* const id = new Identify();
|
|
79
|
+
* id.set('skills', ['js', 'ts']);
|
|
80
|
+
* const groupType = 'org';
|
|
81
|
+
* const groupName = 'engineering';
|
|
82
|
+
* groupIdentify(groupType, groupName, id);
|
|
83
|
+
*
|
|
84
|
+
* // alternatively, this tracking method is awaitable
|
|
85
|
+
* const result = await groupIdentify(groupType, groupName, id).promise;
|
|
86
|
+
* console.log(result.event); // {...}
|
|
87
|
+
* console.log(result.code); // 200
|
|
88
|
+
* console.log(result.message); // "Event tracked successfully"
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
groupIdentify(groupType: string, groupName: string | string[], identify: Identify, eventOptions?: EventOptions): AmplitudeReturn<Result>;
|
|
92
|
+
/**
|
|
93
|
+
* Assigns a user to group
|
|
94
|
+
*
|
|
95
|
+
* ```typescript
|
|
96
|
+
* const groupType = 'orgId';
|
|
97
|
+
* const groupName = '15';
|
|
98
|
+
* setGroup(groupType, groupName, { user_id: '12345' })
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
setGroup(groupType: string, groupName: string | string[], eventOptions?: EventOptions): AmplitudeReturn<Result>;
|
|
102
|
+
/**
|
|
103
|
+
* Sends a revenue event containing revenue property operations.
|
|
104
|
+
*
|
|
105
|
+
* ```typescript
|
|
106
|
+
* const rev = new Revenue();
|
|
107
|
+
* rev.setRevenue(100);
|
|
108
|
+
* revenue(rev);
|
|
109
|
+
*
|
|
110
|
+
* // alternatively, this tracking method is awaitable
|
|
111
|
+
* const result = await revenue(rev).promise;
|
|
112
|
+
* console.log(result.event); // {...}
|
|
113
|
+
* console.log(result.code); // 200
|
|
114
|
+
* console.log(result.message); // "Event tracked successfully"
|
|
115
|
+
* ```
|
|
116
|
+
*/
|
|
117
|
+
revenue(revenue: Revenue, eventOptions?: EventOptions): AmplitudeReturn<Result>;
|
|
118
|
+
/**
|
|
119
|
+
* Sets a new optOut config value. This toggles event tracking on/off.
|
|
120
|
+
*
|
|
121
|
+
*```typescript
|
|
122
|
+
* // Stops tracking
|
|
123
|
+
* setOptOut(true);
|
|
124
|
+
*
|
|
125
|
+
* // Starts/resumes tracking
|
|
126
|
+
* setOptOut(false);
|
|
127
|
+
* ```
|
|
128
|
+
*/
|
|
129
|
+
setOptOut(optOut: boolean): void;
|
|
130
|
+
/**
|
|
131
|
+
* Flush all unsent events.
|
|
132
|
+
*
|
|
133
|
+
*```typescript
|
|
134
|
+
* flush();
|
|
135
|
+
* ```
|
|
136
|
+
*/
|
|
137
|
+
flush(): AmplitudeReturn<void>;
|
|
138
|
+
}
|
|
139
|
+
//# sourceMappingURL=base-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"base-client.d.ts","sourceRoot":"","sources":["../../../src/client/base-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,MAAM,WAAW,UAAU;IACzB;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAElD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CACH,UAAU,EAAE,SAAS,GAAG,MAAM,EAC9B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrC,YAAY,CAAC,EAAE,YAAY,GAC1B,eAAe,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,QAAQ,CACN,UAAU,EAAE,SAAS,GAAG,MAAM,EAC9B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrC,YAAY,CAAC,EAAE,YAAY,GAC1B,eAAe,CAAC,MAAM,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAEnF;;;;;;;;;;;;;;;;OAgBG;IACH,aAAa,CACX,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAC5B,QAAQ,EAAE,QAAQ,EAClB,YAAY,CAAC,EAAE,YAAY,GAC1B,eAAe,CAAC,MAAM,CAAC,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAEhH;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAEhF;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IAEjC;;;;;;OAMG;IACH,KAAK,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;CAChC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"base-client.js","sourceRoot":"","sources":["../../../src/client/base-client.ts"],"names":[],"mappings":"","sourcesContent":["import { AmplitudeReturn } from '../amplitude-promise';\nimport { BaseEvent, EventOptions } from '../base-event';\nimport { Identify, Revenue } from '../event';\nimport { Plugin } from '../plugin';\nimport { Result } from '../result';\n\nexport interface BaseClient {\n /**\n * Adds a new plugin.\n *\n * ```typescript\n * const plugin = {\n * name: 'myPlugin',\n * type: PluginType.ENRICHMENT,\n * setup(config: Config) {\n * return;\n * },\n * execute(context: Event) {\n * return context;\n * },\n * };\n * amplitude.add(plugin);\n * ```\n */\n add(plugin: Plugin): AmplitudeReturn<void>;\n\n /**\n * Removes a plugin.\n *\n * ```typescript\n * amplitude.remove('myPlugin');\n * ```\n */\n remove(pluginName: string): AmplitudeReturn<void>;\n\n /**\n * Tracks user-defined event, with specified type, optional event properties and optional overwrites.\n *\n * ```typescript\n * // event tracking with event type only\n * track('Page Load');\n *\n * // event tracking with event type and additional event properties\n * track('Page Load', { loadTime: 1000 });\n *\n * // event tracking with event type, additional event properties, and overwritten event options\n * track('Page Load', { loadTime: 1000 }, { sessionId: -1 });\n *\n * // alternatively, this tracking method is awaitable\n * const result = await track('Page Load').promise;\n * console.log(result.event); // {...}\n * console.log(result.code); // 200\n * console.log(result.message); // \"Event tracked successfully\"\n * ```\n */\n track(\n eventInput: BaseEvent | string,\n eventProperties?: Record<string, any>,\n eventOptions?: EventOptions,\n ): AmplitudeReturn<Result>;\n\n /**\n * Alias for track()\n */\n logEvent(\n eventInput: BaseEvent | string,\n eventProperties?: Record<string, any>,\n eventOptions?: EventOptions,\n ): AmplitudeReturn<Result>;\n\n /**\n * Sends an identify event containing user property operations\n *\n * ```typescript\n * const id = new Identify();\n * id.set('colors', ['rose', 'gold']);\n * identify(id);\n *\n * // alternatively, this tracking method is awaitable\n * const result = await identify(id).promise;\n * console.log(result.event); // {...}\n * console.log(result.code); // 200\n * console.log(result.message); // \"Event tracked successfully\"\n * ```\n */\n identify(identify: Identify, eventOptions?: EventOptions): AmplitudeReturn<Result>;\n\n /**\n * Sends a group identify event containing group property operations.\n *\n * ```typescript\n * const id = new Identify();\n * id.set('skills', ['js', 'ts']);\n * const groupType = 'org';\n * const groupName = 'engineering';\n * groupIdentify(groupType, groupName, id);\n *\n * // alternatively, this tracking method is awaitable\n * const result = await groupIdentify(groupType, groupName, id).promise;\n * console.log(result.event); // {...}\n * console.log(result.code); // 200\n * console.log(result.message); // \"Event tracked successfully\"\n * ```\n */\n groupIdentify(\n groupType: string,\n groupName: string | string[],\n identify: Identify,\n eventOptions?: EventOptions,\n ): AmplitudeReturn<Result>;\n\n /**\n * Assigns a user to group\n *\n * ```typescript\n * const groupType = 'orgId';\n * const groupName = '15';\n * setGroup(groupType, groupName, { user_id: '12345' })\n * ```\n */\n setGroup(groupType: string, groupName: string | string[], eventOptions?: EventOptions): AmplitudeReturn<Result>;\n\n /**\n * Sends a revenue event containing revenue property operations.\n *\n * ```typescript\n * const rev = new Revenue();\n * rev.setRevenue(100);\n * revenue(rev);\n *\n * // alternatively, this tracking method is awaitable\n * const result = await revenue(rev).promise;\n * console.log(result.event); // {...}\n * console.log(result.code); // 200\n * console.log(result.message); // \"Event tracked successfully\"\n * ```\n */\n revenue(revenue: Revenue, eventOptions?: EventOptions): AmplitudeReturn<Result>;\n\n /**\n * Sets a new optOut config value. This toggles event tracking on/off.\n *\n *```typescript\n * // Stops tracking\n * setOptOut(true);\n *\n * // Starts/resumes tracking\n * setOptOut(false);\n * ```\n */\n setOptOut(optOut: boolean): void;\n\n /**\n * Flush all unsent events.\n *\n *```typescript\n * flush();\n * ```\n */\n flush(): AmplitudeReturn<void>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"","sourcesContent":["export { BrowserClient, ReactNativeClient } from './web-client';\nexport { NodeClient } from './node-client';\n"]}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { AmplitudeReturn } from '../amplitude-promise';
|
|
2
|
+
import { NodeOptions } from '../config';
|
|
3
|
+
import { BaseClient } from './base-client';
|
|
4
|
+
export interface NodeClient extends BaseClient {
|
|
5
|
+
/**
|
|
6
|
+
* Initializes the Amplitude SDK with your apiKey, optional configurations.
|
|
7
|
+
* This method must be called before any other operations.
|
|
8
|
+
*
|
|
9
|
+
* ```typescript
|
|
10
|
+
* await init(API_KEY, options).promise;
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
init(apiKey: string, options?: NodeOptions): AmplitudeReturn<void>;
|
|
14
|
+
}
|
|
15
|
+
//# sourceMappingURL=node-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"node-client.d.ts","sourceRoot":"","sources":["../../../src/client/node-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;CACpE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"node-client.js","sourceRoot":"","sources":["../../../src/client/node-client.ts"],"names":[],"mappings":"","sourcesContent":["import { AmplitudeReturn } from '../amplitude-promise';\nimport { NodeOptions } from '../config';\nimport { BaseClient } from './base-client';\n\nexport interface NodeClient extends BaseClient {\n /**\n * Initializes the Amplitude SDK with your apiKey, optional configurations.\n * This method must be called before any other operations.\n *\n * ```typescript\n * await init(API_KEY, options).promise;\n * ```\n */\n init(apiKey: string, options?: NodeOptions): AmplitudeReturn<void>;\n}\n"]}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { AmplitudeReturn } from '../amplitude-promise';
|
|
2
|
+
import { BrowserOptions, ReactNativeOptions } from '../config';
|
|
3
|
+
import { TransportType } from '../transport';
|
|
4
|
+
import { BaseClient } from './base-client';
|
|
5
|
+
interface Client extends BaseClient {
|
|
6
|
+
/**
|
|
7
|
+
* Returns current user ID.
|
|
8
|
+
*
|
|
9
|
+
* ```typescript
|
|
10
|
+
* const userId = getUserId();
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
getUserId(): string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* Sets a new user ID.
|
|
16
|
+
*
|
|
17
|
+
* ```typescript
|
|
18
|
+
* setUserId('userId');
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
setUserId(userId: string | undefined): void;
|
|
22
|
+
/**
|
|
23
|
+
* Returns current device ID.
|
|
24
|
+
*
|
|
25
|
+
* ```typescript
|
|
26
|
+
* const deviceId = getDeviceId();
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
getDeviceId(): string | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* Sets a new device ID.
|
|
32
|
+
* When setting a custom device ID, make sure the value is sufficiently unique.
|
|
33
|
+
* A uuid is recommended.
|
|
34
|
+
*
|
|
35
|
+
* ```typescript
|
|
36
|
+
* setDeviceId('deviceId');
|
|
37
|
+
* ```
|
|
38
|
+
*/
|
|
39
|
+
setDeviceId(deviceId: string): void;
|
|
40
|
+
/**
|
|
41
|
+
* Returns current session ID.
|
|
42
|
+
*
|
|
43
|
+
* ```typescript
|
|
44
|
+
* const sessionId = getSessionId();
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
getSessionId(): number | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* Sets a new session ID.
|
|
50
|
+
* When settign a custom session ID, make sure the value is in milliseconds since epoch (Unix Timestamp).
|
|
51
|
+
*
|
|
52
|
+
* ```typescript
|
|
53
|
+
* setSessionId(Date.now());
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
setSessionId(sessionId: number): void;
|
|
57
|
+
/**
|
|
58
|
+
* Anonymizes users after they log out, by:
|
|
59
|
+
*
|
|
60
|
+
* * setting userId to undefined
|
|
61
|
+
* * setting deviceId to a new uuid value
|
|
62
|
+
*
|
|
63
|
+
* With an undefined userId and a completely new deviceId, the current user would appear as a brand new user in dashboard.
|
|
64
|
+
*
|
|
65
|
+
* ```typescript
|
|
66
|
+
* import { reset } from '@amplitude/analytics-browser';
|
|
67
|
+
*
|
|
68
|
+
* reset();
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
reset(): void;
|
|
72
|
+
}
|
|
73
|
+
export interface BrowserClient extends Client {
|
|
74
|
+
/**
|
|
75
|
+
* Initializes the Amplitude SDK with your apiKey, optional configurations.
|
|
76
|
+
* This method must be called before any other operations.
|
|
77
|
+
*
|
|
78
|
+
* ```typescript
|
|
79
|
+
* await init(API_KEY, options).promise;
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
init(apiKey: string, userId?: string, options?: BrowserOptions): AmplitudeReturn<void>;
|
|
83
|
+
/**
|
|
84
|
+
* Sets the network transport type for events.
|
|
85
|
+
*
|
|
86
|
+
* ```typescript
|
|
87
|
+
* // Use Fetch API
|
|
88
|
+
* setTransport('fetch');
|
|
89
|
+
*
|
|
90
|
+
* // Use XMLHttpRequest API
|
|
91
|
+
* setTransport('xhr');
|
|
92
|
+
*
|
|
93
|
+
* // Use navigator.sendBeacon API
|
|
94
|
+
* setTransport('beacon');
|
|
95
|
+
* ```
|
|
96
|
+
*/
|
|
97
|
+
setTransport(transport: TransportType): void;
|
|
98
|
+
}
|
|
99
|
+
export interface ReactNativeClient extends Client {
|
|
100
|
+
/**
|
|
101
|
+
* Initializes the Amplitude SDK with your apiKey, optional configurations.
|
|
102
|
+
* This method must be called before any other operations.
|
|
103
|
+
*
|
|
104
|
+
* ```typescript
|
|
105
|
+
* await init(API_KEY, options).promise;
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
init(apiKey: string, userId?: string, options?: ReactNativeOptions): AmplitudeReturn<void>;
|
|
109
|
+
}
|
|
110
|
+
export {};
|
|
111
|
+
//# sourceMappingURL=web-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"web-client.d.ts","sourceRoot":"","sources":["../../../src/client/web-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,UAAU,MAAO,SAAQ,UAAU;IACjC;;;;;;OAMG;IACH,SAAS,IAAI,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAE5C;;;;;;OAMG;IACH,WAAW,IAAI,MAAM,GAAG,SAAS,CAAC;IAElC;;;;;;;;OAQG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;;;;;OAMG;IACH,YAAY,IAAI,MAAM,GAAG,SAAS,CAAC;IAEnC;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;;;;;;;;;;;OAaG;IACH,KAAK,IAAI,IAAI,CAAC;CACf;AAED,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAEvF;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,SAAS,EAAE,aAAa,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,iBAAkB,SAAQ,MAAM;IAC/C;;;;;;;OAOG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;CAC5F"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"web-client.js","sourceRoot":"","sources":["../../../src/client/web-client.ts"],"names":[],"mappings":"","sourcesContent":["import { AmplitudeReturn } from '../amplitude-promise';\nimport { BrowserOptions, ReactNativeOptions } from '../config';\nimport { TransportType } from '../transport';\nimport { BaseClient } from './base-client';\n\ninterface Client extends BaseClient {\n /**\n * Returns current user ID.\n *\n * ```typescript\n * const userId = getUserId();\n * ```\n */\n getUserId(): string | undefined;\n\n /**\n * Sets a new user ID.\n *\n * ```typescript\n * setUserId('userId');\n * ```\n */\n setUserId(userId: string | undefined): void;\n\n /**\n * Returns current device ID.\n *\n * ```typescript\n * const deviceId = getDeviceId();\n * ```\n */\n getDeviceId(): string | undefined;\n\n /**\n * Sets a new device ID.\n * When setting a custom device ID, make sure the value is sufficiently unique.\n * A uuid is recommended.\n *\n * ```typescript\n * setDeviceId('deviceId');\n * ```\n */\n setDeviceId(deviceId: string): void;\n\n /**\n * Returns current session ID.\n *\n * ```typescript\n * const sessionId = getSessionId();\n * ```\n */\n getSessionId(): number | undefined;\n\n /**\n * Sets a new session ID.\n * When settign a custom session ID, make sure the value is in milliseconds since epoch (Unix Timestamp).\n *\n * ```typescript\n * setSessionId(Date.now());\n * ```\n */\n setSessionId(sessionId: number): void;\n\n /**\n * Anonymizes users after they log out, by:\n *\n * * setting userId to undefined\n * * setting deviceId to a new uuid value\n *\n * With an undefined userId and a completely new deviceId, the current user would appear as a brand new user in dashboard.\n *\n * ```typescript\n * import { reset } from '@amplitude/analytics-browser';\n *\n * reset();\n * ```\n */\n reset(): void;\n}\n\nexport interface BrowserClient extends Client {\n /**\n * Initializes the Amplitude SDK with your apiKey, optional configurations.\n * This method must be called before any other operations.\n *\n * ```typescript\n * await init(API_KEY, options).promise;\n * ```\n */\n init(apiKey: string, userId?: string, options?: BrowserOptions): AmplitudeReturn<void>;\n\n /**\n * Sets the network transport type for events.\n *\n * ```typescript\n * // Use Fetch API\n * setTransport('fetch');\n *\n * // Use XMLHttpRequest API\n * setTransport('xhr');\n *\n * // Use navigator.sendBeacon API\n * setTransport('beacon');\n * ```\n */\n setTransport(transport: TransportType): void;\n}\n\nexport interface ReactNativeClient extends Client {\n /**\n * Initializes the Amplitude SDK with your apiKey, optional configurations.\n * This method must be called before any other operations.\n *\n * ```typescript\n * await init(API_KEY, options).promise;\n * ```\n */\n init(apiKey: string, userId?: string, options?: ReactNativeOptions): AmplitudeReturn<void>;\n}\n"]}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { LogLevel, Logger } from './logger';
|
|
2
|
+
import { Storage } from './storage';
|
|
3
|
+
import { Event } from './event';
|
|
4
|
+
import { Transport, TransportType } from './transport';
|
|
5
|
+
import { Plan } from './plan';
|
|
6
|
+
import { IngestionMetadata } from './ingestion-metadata';
|
|
7
|
+
import { SessionManager, UserSession } from './session-manager';
|
|
8
|
+
export declare enum ServerZone {
|
|
9
|
+
US = "US",
|
|
10
|
+
EU = "EU"
|
|
11
|
+
}
|
|
12
|
+
export interface Config {
|
|
13
|
+
apiKey: string;
|
|
14
|
+
flushIntervalMillis: number;
|
|
15
|
+
flushMaxRetries: number;
|
|
16
|
+
flushQueueSize: number;
|
|
17
|
+
logLevel: LogLevel;
|
|
18
|
+
loggerProvider: Logger;
|
|
19
|
+
minIdLength?: number;
|
|
20
|
+
optOut: boolean;
|
|
21
|
+
plan?: Plan;
|
|
22
|
+
ingestionMetadata?: IngestionMetadata;
|
|
23
|
+
serverUrl: string | undefined;
|
|
24
|
+
serverZone?: ServerZone;
|
|
25
|
+
storageProvider?: Storage<Event[]>;
|
|
26
|
+
transportProvider: Transport;
|
|
27
|
+
useBatch: boolean;
|
|
28
|
+
}
|
|
29
|
+
export interface BrowserConfig extends Config {
|
|
30
|
+
appVersion?: string;
|
|
31
|
+
attribution?: AttributionOptions;
|
|
32
|
+
deviceId?: string;
|
|
33
|
+
cookieExpiration: number;
|
|
34
|
+
cookieSameSite: string;
|
|
35
|
+
cookieSecure: boolean;
|
|
36
|
+
cookieStorage: Storage<UserSession>;
|
|
37
|
+
disableCookies: boolean;
|
|
38
|
+
domain: string;
|
|
39
|
+
lastEventTime?: number;
|
|
40
|
+
partnerId?: string;
|
|
41
|
+
sessionId?: number;
|
|
42
|
+
sessionManager: SessionManager;
|
|
43
|
+
sessionTimeout: number;
|
|
44
|
+
trackingOptions: TrackingOptions;
|
|
45
|
+
userId?: string;
|
|
46
|
+
}
|
|
47
|
+
export declare type ReactNativeConfig = Omit<BrowserConfig, 'trackingOptions'> & {
|
|
48
|
+
trackingOptions: ReactNativeTrackingOptions;
|
|
49
|
+
};
|
|
50
|
+
export declare type NodeConfig = Config;
|
|
51
|
+
export declare type InitOptions<T extends Config> = Partial<Config> & Omit<T, keyof Config> & {
|
|
52
|
+
apiKey: string;
|
|
53
|
+
transportProvider: Transport;
|
|
54
|
+
};
|
|
55
|
+
export interface TrackingOptions {
|
|
56
|
+
deviceManufacturer?: boolean;
|
|
57
|
+
deviceModel?: boolean;
|
|
58
|
+
ipAddress?: boolean;
|
|
59
|
+
language?: boolean;
|
|
60
|
+
osName?: boolean;
|
|
61
|
+
osVersion?: boolean;
|
|
62
|
+
platform?: boolean;
|
|
63
|
+
[key: string]: boolean | undefined;
|
|
64
|
+
}
|
|
65
|
+
export interface ReactNativeTrackingOptions extends TrackingOptions {
|
|
66
|
+
adid?: boolean;
|
|
67
|
+
carrier?: boolean;
|
|
68
|
+
}
|
|
69
|
+
export interface AttributionOptions {
|
|
70
|
+
disabled?: boolean;
|
|
71
|
+
excludeReferrers?: string[];
|
|
72
|
+
initialEmptyValue?: string;
|
|
73
|
+
trackNewCampaigns?: boolean;
|
|
74
|
+
trackPageViews?: boolean;
|
|
75
|
+
}
|
|
76
|
+
export declare type BrowserOptions = Omit<Partial<BrowserConfig & {
|
|
77
|
+
transport: TransportType;
|
|
78
|
+
}>, 'apiKey'>;
|
|
79
|
+
export declare type ReactNativeOptions = Omit<Partial<ReactNativeConfig & {
|
|
80
|
+
transport: TransportType;
|
|
81
|
+
}>, 'apiKey'>;
|
|
82
|
+
export declare type NodeOptions = Omit<Partial<NodeConfig>, 'apiKey'>;
|
|
83
|
+
//# sourceMappingURL=config.d.ts.map
|
|
@@ -0,0 +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,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,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhE,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,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC,iBAAiB,EAAE,SAAS,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,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,cAAc,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,iBAAiB,GAAG,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,GAAG;IACvE,eAAe,EAAE,0BAA0B,CAAC;CAC7C,CAAC;AAEF,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;CAC9B,CAAC;AAER,MAAM,WAAW,eAAe;IAC9B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,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,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,0BAA2B,SAAQ,eAAe;IACjE,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,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,CACT,CAAC;AAEF,oBAAY,kBAAkB,GAAG,IAAI,CACnC,OAAO,CACL,iBAAiB,GAAG;IAClB,SAAS,EAAE,aAAa,CAAC;CAC1B,CACF,EACD,QAAQ,CACT,CAAC;AAEF,oBAAY,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AASA,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,uBAAS,CAAA;IACT,uBAAS,CAAA;AACX,CAAC,EAHW,UAAU,KAAV,UAAU,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 { IngestionMetadata } from './ingestion-metadata';\nimport { SessionManager, 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 ingestionMetadata?: IngestionMetadata;\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 attribution?: AttributionOptions;\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 sessionManager: SessionManager;\n sessionTimeout: number;\n trackingOptions: TrackingOptions;\n userId?: string;\n}\n\nexport type ReactNativeConfig = Omit<BrowserConfig, 'trackingOptions'> & {\n trackingOptions: ReactNativeTrackingOptions;\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 };\n\nexport interface TrackingOptions {\n deviceManufacturer?: boolean;\n deviceModel?: boolean;\n ipAddress?: boolean;\n language?: boolean;\n osName?: boolean;\n osVersion?: boolean;\n platform?: boolean;\n [key: string]: boolean | undefined;\n}\n\nexport interface ReactNativeTrackingOptions extends TrackingOptions {\n adid?: boolean;\n carrier?: boolean;\n}\n\nexport interface AttributionOptions {\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'\n>;\n\nexport type ReactNativeOptions = Omit<\n Partial<\n ReactNativeConfig & {\n transport: TransportType;\n }\n >,\n 'apiKey'\n>;\n\nexport type NodeOptions = Omit<Partial<NodeConfig>, 'apiKey'>;\n"]}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { BaseEvent, EventOptions } from './base-event';
|
|
2
|
+
import { Config } from './config';
|
|
3
|
+
import { Result } from './result';
|
|
4
|
+
export interface CoreClient<T extends Config> {
|
|
5
|
+
config: T;
|
|
6
|
+
track(eventInput: BaseEvent | string, eventProperties?: Record<string, any>, eventOptions?: EventOptions): Promise<Result>;
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=core-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core-client.d.ts","sourceRoot":"","sources":["../../src/core-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,MAAM;IAC1C,MAAM,EAAE,CAAC,CAAC;IACV,KAAK,CACH,UAAU,EAAE,SAAS,GAAG,MAAM,EAC9B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrC,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core-client.js","sourceRoot":"","sources":["../../src/core-client.ts"],"names":[],"mappings":"","sourcesContent":["import { BaseEvent, EventOptions } from './base-event';\nimport { Config } from './config';\nimport { Result } from './result';\n\nexport interface CoreClient<T extends Config> {\n config: T;\n track(\n eventInput: BaseEvent | string,\n eventProperties?: Record<string, any>,\n eventOptions?: EventOptions,\n ): Promise<Result>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"destination-context.d.ts","sourceRoot":"","sources":["../../src/destination-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,KAAK,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,aAAa,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;CACjB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"destination-context.js","sourceRoot":"","sources":["../../src/destination-context.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from './event';\nimport { EventCallback } from './event-callback';\n\nexport interface DestinationContext {\n event: Event;\n attempts: number;\n callback: EventCallback;\n timeout: number;\n}\n"]}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { Event } from './event';
|
|
2
|
+
export interface EventBridge {
|
|
3
|
+
sendEvent(channel: string, event: Event): void;
|
|
4
|
+
setReceiver(channel: string, receiver: EventBridgeReceiver): void;
|
|
5
|
+
}
|
|
6
|
+
export interface EventBridgeChannel {
|
|
7
|
+
sendEvent(event: Event): void;
|
|
8
|
+
setReceiver(receiver: EventBridgeReceiver): void;
|
|
9
|
+
}
|
|
10
|
+
export interface EventBridgeContainer {
|
|
11
|
+
getInstance(instanceName: string): EventBridge;
|
|
12
|
+
}
|
|
13
|
+
export interface EventBridgeReceiver {
|
|
14
|
+
receive(channel: string, event: Event): void;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=event-bridge.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-bridge.d.ts","sourceRoot":"","sources":["../../src/event-bridge.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAC/C,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,GAAG,IAAI,CAAC;CACnE;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAC9B,WAAW,CAAC,QAAQ,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,WAAW,CAAC;CAChD;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;CAC9C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-bridge.js","sourceRoot":"","sources":["../../src/event-bridge.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from './event';\n\nexport interface EventBridge {\n sendEvent(channel: string, event: Event): void;\n setReceiver(channel: string, receiver: EventBridgeReceiver): void;\n}\n\nexport interface EventBridgeChannel {\n sendEvent(event: Event): void;\n setReceiver(receiver: EventBridgeReceiver): void;\n}\n\nexport interface EventBridgeContainer {\n getInstance(instanceName: string): EventBridge;\n}\n\nexport interface EventBridgeReceiver {\n receive(channel: string, event: Event): void;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-callback.d.ts","sourceRoot":"","sources":["../../src/event-callback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,oBAAY,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-callback.js","sourceRoot":"","sources":["../../src/event-callback.ts"],"names":[],"mappings":"","sourcesContent":["import { Result } from './result';\n\nexport type EventCallback = (result: Result) => void;\n"]}
|