@types/amplitude-js - npm Package Compare versions

Comparing version 8.9.6 to 8.16.0

amplitude-js/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for Amplitude SDK 8.9
+// Type definitions for Amplitude SDK 8.16
 // Project: https://github.com/amplitude/Amplitude-Javascript
@@ -15,2 +15,3 @@ // Definitions by: Dan Manastireanu <https://github.com/danmana>
 
+// https://amplitude.github.io/Amplitude-JavaScript/Options
 export interface Config {
@@ -39,2 +40,3 @@ apiEndpoint?: string | undefined;
     onError?: (() => void) | undefined;
+    onExit?: (() => void) | undefined;
     platform?: string | undefined;
@@ -47,2 +49,3 @@ sameSiteCookie?: 'Lax' | 'Strict' | 'None' | undefined;
     sessionTimeout?: number | undefined;
+    sessionId?: string | null;
     storage?: '' | 'cookies' | 'localStorage' | 'sessionStorage' | 'none';
@@ -72,2 +75,14 @@ trackingOptions?: {
     serverZoneBasedApi?: boolean | undefined;
+    useDynamicConfig?: boolean | undefined;
+    logAttributionCapturedEvent?: boolean | undefined;
+    plan?: {
+        branch?: string;
+        source?: string;
+        version?: string;
+    } | undefined;
+    headers?: Record<string, string>;
+    library?: {
+        name?: string;
+        version?: string;
+    } | undefined;
 }
@@ -108,5 +123,8 @@
     init(apiKey: string, userId?: string, config?: Config, callback?: (client: AmplitudeClient) => void): void;
+    onInit(callback: (client: AmplitudeClient) => void): void;
 
+    setLibrary(name?: string, version?: string): void;
     setVersionName(versionName: string): void;
 
+    onNewSessionStart(callback: (client: AmplitudeClient) => void): void;
     isNewSession(): boolean;
@@ -116,13 +134,21 @@ setSessionId(sessionId: number): void;
     resetSessionId(): void;
+    setMinTimeBetweenSessionsMillis(timeInMillis: number): void;
 
     setDomain(domain: string): void;
-    setUserId(userId: string | null): void;
+    setUserId(userId: string | null, startNewSession?: boolean): void;
+    getUserId(): string;
 
+    enableTracking(): void;
+
     setDeviceId(id: string): void;
+    getDeviceId(): string;
     regenerateDeviceId(): void;
 
-    identify(identify: Identify, callback?: Callback): void;
-    groupIdentify(groupType: string, groupName: string | string[], identify: Identify, callback?: Callback): void;
+    identify(identify: Identify, callback?: Callback, errorCallback?: Callback, outOfSession?: boolean): void;
+    groupIdentify(groupType: string, groupName: string | string[], identify: Identify, callback?: Callback, errorCallback?: Callback, outOfSession?: boolean): void;
 
     setUserProperties(properties: any): void;
+    /**
+     * @deprecated Use `setUserProperties` instead
+     */
     setGlobalUserProperties(properties: any): void;
@@ -133,2 +159,4 @@ clearUserProperties(): void;
 
+    setUseDynamicConfig(useDynamicConfig: boolean): void;
+
     setOptOut(enable: boolean): void;
@@ -139,9 +167,16 @@
     setTransport(transport: Transport): void;
+    setServerUrl(serverUrl: string): void;
+    setServerZone(serverZone: ServerZone, serverZoneBasedApi?: boolean): void;
 
-    logEvent(event: string, data?: any, callback?: Callback): LogReturn;
-    logEventWithGroups(event: string, data?: any, groups?: any, callback?: Callback): LogReturn;
+    setEventUploadThreshold(eventUploadThreshold: number): void;
+    logEvent(event: string, data?: any, callback?: Callback, errorCallback?: Callback, outOfSession?: boolean): LogReturn;
+    logEventWithGroups(event: string, data?: any, groups?: any, callback?: Callback, errorCallback?: Callback, outOfSession?: boolean): LogReturn;
     logRevenueV2(revenue_obj: Revenue): LogReturn;
-    logRevenue(pric: number, quantity: number, product: string): LogReturn;
-    logEventWithTimestamp(event: string, data?: any, timestamp?: number, callback?: Callback): LogReturn;
 
+    /**
+     * @deprecated Use `logRevenueV2` instead
+     */
+    logRevenue(price: number, quantity: number, product: string): LogReturn;
+    logEventWithTimestamp(event: string, data?: any, timestamp?: number, callback?: Callback, errorCallback?: Callback, outOfSession?: boolean): LogReturn;
+
     Identify: typeof Identify;
@@ -148,0 +183,0 @@ Revenue: typeof Revenue;

amplitude-js/package.json

 {
     "name": "@types/amplitude-js",
-    "version": "8.9.6",
+    "version": "8.16.0",
     "description": "TypeScript definitions for Amplitude SDK",
@@ -28,4 +28,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/amplitude-js",
     "dependencies": {},
-    "typesPublisherContentHash": "62581c4fec4716f9e1efed8238721b4b338a7cf4cc36695476fba8ffd3488391",
+    "typesPublisherContentHash": "a6da94a2dfeb64b47060b9816433ad4bc4904a8c1f7a48affd184141414b529a",
     "typeScriptVersion": "3.8"
 }

amplitude-js/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Wed, 02 Feb 2022 08:01:25 GMT
+ * Last updated: Tue, 22 Feb 2022 21:31:46 GMT
  * Dependencies: none
@@ -14,0 +14,0 @@ * Global values: `amplitude`

No alert changes

Improved metrics

Total package byte prevSize

13139

increased by12.43%

Lines of code

239

increased by15.46%

No dependency changes