@walkeros/web-destination-amplitude 4.8.1 → 4.8.2

package/dist/index.d.mts

@@ -7,6 +7,7 @@ import { InitOptions } from '@amplitude/engagement-browser';
 
 type BrowserOptions = Omit<Types$1.BrowserOptions, 'identify'>;
 type AmplitudeBrowserOptions = Types$1.BrowserOptions;
+type AmplitudePlugin = Types$1.Plugin;
 /**
  * Destination-level settings.
  *
@@ -51,55 +52,53 @@ interface Mapping {
     reset?: Mapping$1.Value | boolean;
 }
 /**
- * Amplitude SDK surface — the subset of @amplitude/unified the
- * destination actually uses. Mirrors the real module's named exports so
- * tests can mock each method individually via env.amplitude.
+ * Amplitude SDK surface: the subset of @amplitude/unified the
+ * destination actually uses. Mirrors the real client's methods so tests can
+ * mock each one via env.amplitude. Generic over the Identify and Revenue
+ * instances, so the real SDK gets back the instances it created.
  */
-interface AmplitudeSDK {
-    initAll: (apiKey: string, options?: Record<string, unknown>) => Promise<void>;
-    track: (eventType: string, eventProperties?: Record<string, unknown>) => void;
-    identify: (identify: IdentifyInstance) => void;
-    revenue: (revenue: RevenueInstance) => void;
-    reset: () => void;
-    setOptOut: (optOut: boolean) => void;
-    setUserId: (userId: string | undefined) => void;
-    setDeviceId: (deviceId: string) => void;
-    setSessionId: (sessionId: number) => void;
-    setGroup: (groupType: string, groupName: string | string[]) => void;
-    groupIdentify: (groupType: string, groupName: string, identify: IdentifyInstance) => void;
-    flush: () => {
-        promise: Promise<void>;
-    };
-    add: (plugin: unknown) => {
-        promise: Promise<void>;
-    };
-    Identify: new () => IdentifyInstance;
-    Revenue: new () => RevenueInstance;
+interface AmplitudeSDK<I extends IdentifyInstance = IdentifyInstance, R extends RevenueInstance = RevenueInstance> {
+    /** Analytics. */
+    init: (apiKey: string, options?: AmplitudeBrowserOptions) => unknown;
+    /** One plugin: Session Replay, Experiment or Guides & Surveys. */
+    add: (plugin: AmplitudePlugin) => unknown;
+    track: (eventType: string, eventProperties?: Record<string, unknown>) => unknown;
+    identify: (identify: I) => unknown;
+    revenue: (revenue: R) => unknown;
+    reset: () => unknown;
+    setOptOut: (optOut: boolean) => unknown;
+    setUserId: (userId: string | undefined) => unknown;
+    setDeviceId: (deviceId: string) => unknown;
+    setSessionId: (sessionId: number) => unknown;
+    setGroup: (groupType: string, groupName: string | string[]) => unknown;
+    groupIdentify: (groupType: string, groupName: string, identify: I) => unknown;
+    Identify: new () => I;
+    Revenue: new () => R;
 }
-/** Chainable Identify — mirrors @amplitude/unified Identify class. */
+/** Chainable Identify, as the @amplitude/unified Identify class. */
 interface IdentifyInstance {
-    set: (property: string, value: unknown) => IdentifyInstance;
-    setOnce: (property: string, value: unknown) => IdentifyInstance;
-    add: (property: string, value: number) => IdentifyInstance;
-    append: (property: string, value: unknown) => IdentifyInstance;
-    prepend: (property: string, value: unknown) => IdentifyInstance;
-    preInsert: (property: string, value: unknown) => IdentifyInstance;
-    postInsert: (property: string, value: unknown) => IdentifyInstance;
-    remove: (property: string, value: unknown) => IdentifyInstance;
-    unset: (property: string) => IdentifyInstance;
-    clearAll: () => IdentifyInstance;
+    set(property: string, value: unknown): IdentifyInstance;
+    setOnce(property: string, value: unknown): IdentifyInstance;
+    add(property: string, value: number): IdentifyInstance;
+    append(property: string, value: unknown): IdentifyInstance;
+    prepend(property: string, value: unknown): IdentifyInstance;
+    preInsert(property: string, value: unknown): IdentifyInstance;
+    postInsert(property: string, value: unknown): IdentifyInstance;
+    remove(property: string, value: unknown): IdentifyInstance;
+    unset(property: string): IdentifyInstance;
+    clearAll(): IdentifyInstance;
 }
-/** Chainable Revenue — mirrors @amplitude/unified Revenue class. */
+/** Chainable Revenue, as the @amplitude/unified Revenue class. */
 interface RevenueInstance {
-    setProductId: (id: string) => RevenueInstance;
-    setPrice: (price: number) => RevenueInstance;
-    setQuantity: (quantity: number) => RevenueInstance;
-    setRevenueType: (type: string) => RevenueInstance;
-    setCurrency: (currency: string) => RevenueInstance;
-    setRevenue: (revenue: number) => RevenueInstance;
-    setReceipt: (receipt: string) => RevenueInstance;
-    setReceiptSig: (signature: string) => RevenueInstance;
-    setEventProperties: (properties: Record<string, unknown>) => RevenueInstance;
+    setProductId(id: string): RevenueInstance;
+    setPrice(price: number): RevenueInstance;
+    setQuantity(quantity: number): RevenueInstance;
+    setRevenueType(type: string): RevenueInstance;
+    setCurrency(currency: string): RevenueInstance;
+    setRevenue(revenue: number): RevenueInstance;
+    setReceipt(receipt: string): RevenueInstance;
+    setReceiptSig(signature: string): RevenueInstance;
+    setEventProperties(properties: Record<string, unknown>): RevenueInstance;
 }
 /**
  * Env — optional SDK override. Production leaves this undefined and the
@@ -120,7 +119,8 @@ type Rules = Mapping$1.Rules<Rule>;
 
 type index_AmplitudeBrowserOptions = AmplitudeBrowserOptions;
 type index_AmplitudeDestination = AmplitudeDestination;
-type index_AmplitudeSDK = AmplitudeSDK;
+type index_AmplitudePlugin = AmplitudePlugin;
+type index_AmplitudeSDK<I extends IdentifyInstance = IdentifyInstance, R extends RevenueInstance = RevenueInstance> = AmplitudeSDK<I, R>;
 type index_Config = Config;
 type index_Destination = Destination;
 type index_Env = Env;
@@ -134,7 +134,7 @@ type index_RuntimeState = RuntimeState;
 type index_Settings = Settings;
 type index_Types = Types;
 declare namespace index {
-  export type { index_AmplitudeBrowserOptions as AmplitudeBrowserOptions, index_AmplitudeDestination as AmplitudeDestination, index_AmplitudeSDK as AmplitudeSDK, index_Config as Config, index_Destination as Destination, index_Env as Env, index_IdentifyInstance as IdentifyInstance, index_InitSettings as InitSettings, index_Mapping as Mapping, index_RevenueInstance as RevenueInstance, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
+  export type { index_AmplitudeBrowserOptions as AmplitudeBrowserOptions, index_AmplitudeDestination as AmplitudeDestination, index_AmplitudePlugin as AmplitudePlugin, index_AmplitudeSDK as AmplitudeSDK, index_Config as Config, index_Destination as Destination, index_Env as Env, index_IdentifyInstance as IdentifyInstance, index_InitSettings as InitSettings, index_Mapping as Mapping, index_RevenueInstance as RevenueInstance, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
 }
 
 declare const destinationAmplitude: Destination;

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { InitOptions } from '@amplitude/engagement-browser';
 
 type BrowserOptions = Omit<Types$1.BrowserOptions, 'identify'>;
 type AmplitudeBrowserOptions = Types$1.BrowserOptions;
+type AmplitudePlugin = Types$1.Plugin;
 /**
  * Destination-level settings.
  *
@@ -51,55 +52,53 @@ interface Mapping {
     reset?: Mapping$1.Value | boolean;
 }
 /**
- * Amplitude SDK surface — the subset of @amplitude/unified the
- * destination actually uses. Mirrors the real module's named exports so
- * tests can mock each method individually via env.amplitude.
+ * Amplitude SDK surface: the subset of @amplitude/unified the
+ * destination actually uses. Mirrors the real client's methods so tests can
+ * mock each one via env.amplitude. Generic over the Identify and Revenue
+ * instances, so the real SDK gets back the instances it created.
  */
-interface AmplitudeSDK {
-    initAll: (apiKey: string, options?: Record<string, unknown>) => Promise<void>;
-    track: (eventType: string, eventProperties?: Record<string, unknown>) => void;
-    identify: (identify: IdentifyInstance) => void;
-    revenue: (revenue: RevenueInstance) => void;
-    reset: () => void;
-    setOptOut: (optOut: boolean) => void;
-    setUserId: (userId: string | undefined) => void;
-    setDeviceId: (deviceId: string) => void;
-    setSessionId: (sessionId: number) => void;
-    setGroup: (groupType: string, groupName: string | string[]) => void;
-    groupIdentify: (groupType: string, groupName: string, identify: IdentifyInstance) => void;
-    flush: () => {
-        promise: Promise<void>;
-    };
-    add: (plugin: unknown) => {
-        promise: Promise<void>;
-    };
-    Identify: new () => IdentifyInstance;
-    Revenue: new () => RevenueInstance;
+interface AmplitudeSDK<I extends IdentifyInstance = IdentifyInstance, R extends RevenueInstance = RevenueInstance> {
+    /** Analytics. */
+    init: (apiKey: string, options?: AmplitudeBrowserOptions) => unknown;
+    /** One plugin: Session Replay, Experiment or Guides & Surveys. */
+    add: (plugin: AmplitudePlugin) => unknown;
+    track: (eventType: string, eventProperties?: Record<string, unknown>) => unknown;
+    identify: (identify: I) => unknown;
+    revenue: (revenue: R) => unknown;
+    reset: () => unknown;
+    setOptOut: (optOut: boolean) => unknown;
+    setUserId: (userId: string | undefined) => unknown;
+    setDeviceId: (deviceId: string) => unknown;
+    setSessionId: (sessionId: number) => unknown;
+    setGroup: (groupType: string, groupName: string | string[]) => unknown;
+    groupIdentify: (groupType: string, groupName: string, identify: I) => unknown;
+    Identify: new () => I;
+    Revenue: new () => R;
 }
-/** Chainable Identify — mirrors @amplitude/unified Identify class. */
+/** Chainable Identify, as the @amplitude/unified Identify class. */
 interface IdentifyInstance {
-    set: (property: string, value: unknown) => IdentifyInstance;
-    setOnce: (property: string, value: unknown) => IdentifyInstance;
-    add: (property: string, value: number) => IdentifyInstance;
-    append: (property: string, value: unknown) => IdentifyInstance;
-    prepend: (property: string, value: unknown) => IdentifyInstance;
-    preInsert: (property: string, value: unknown) => IdentifyInstance;
-    postInsert: (property: string, value: unknown) => IdentifyInstance;
-    remove: (property: string, value: unknown) => IdentifyInstance;
-    unset: (property: string) => IdentifyInstance;
-    clearAll: () => IdentifyInstance;
+    set(property: string, value: unknown): IdentifyInstance;
+    setOnce(property: string, value: unknown): IdentifyInstance;
+    add(property: string, value: number): IdentifyInstance;
+    append(property: string, value: unknown): IdentifyInstance;
+    prepend(property: string, value: unknown): IdentifyInstance;
+    preInsert(property: string, value: unknown): IdentifyInstance;
+    postInsert(property: string, value: unknown): IdentifyInstance;
+    remove(property: string, value: unknown): IdentifyInstance;
+    unset(property: string): IdentifyInstance;
+    clearAll(): IdentifyInstance;
 }
-/** Chainable Revenue — mirrors @amplitude/unified Revenue class. */
+/** Chainable Revenue, as the @amplitude/unified Revenue class. */
 interface RevenueInstance {
-    setProductId: (id: string) => RevenueInstance;
-    setPrice: (price: number) => RevenueInstance;
-    setQuantity: (quantity: number) => RevenueInstance;
-    setRevenueType: (type: string) => RevenueInstance;
-    setCurrency: (currency: string) => RevenueInstance;
-    setRevenue: (revenue: number) => RevenueInstance;
-    setReceipt: (receipt: string) => RevenueInstance;
-    setReceiptSig: (signature: string) => RevenueInstance;
-    setEventProperties: (properties: Record<string, unknown>) => RevenueInstance;
+    setProductId(id: string): RevenueInstance;
+    setPrice(price: number): RevenueInstance;
+    setQuantity(quantity: number): RevenueInstance;
+    setRevenueType(type: string): RevenueInstance;
+    setCurrency(currency: string): RevenueInstance;
+    setRevenue(revenue: number): RevenueInstance;
+    setReceipt(receipt: string): RevenueInstance;
+    setReceiptSig(signature: string): RevenueInstance;
+    setEventProperties(properties: Record<string, unknown>): RevenueInstance;
 }
 /**
  * Env — optional SDK override. Production leaves this undefined and the
@@ -120,7 +119,8 @@ type Rules = Mapping$1.Rules<Rule>;
 
 type index_AmplitudeBrowserOptions = AmplitudeBrowserOptions;
 type index_AmplitudeDestination = AmplitudeDestination;
-type index_AmplitudeSDK = AmplitudeSDK;
+type index_AmplitudePlugin = AmplitudePlugin;
+type index_AmplitudeSDK<I extends IdentifyInstance = IdentifyInstance, R extends RevenueInstance = RevenueInstance> = AmplitudeSDK<I, R>;
 type index_Config = Config;
 type index_Destination = Destination;
 type index_Env = Env;
@@ -134,7 +134,7 @@ type index_RuntimeState = RuntimeState;
 type index_Settings = Settings;
 type index_Types = Types;
 declare namespace index {
-  export type { index_AmplitudeBrowserOptions as AmplitudeBrowserOptions, index_AmplitudeDestination as AmplitudeDestination, index_AmplitudeSDK as AmplitudeSDK, index_Config as Config, index_Destination as Destination, index_Env as Env, index_IdentifyInstance as IdentifyInstance, index_InitSettings as InitSettings, index_Mapping as Mapping, index_RevenueInstance as RevenueInstance, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
+  export type { index_AmplitudeBrowserOptions as AmplitudeBrowserOptions, index_AmplitudeDestination as AmplitudeDestination, index_AmplitudePlugin as AmplitudePlugin, index_AmplitudeSDK as AmplitudeSDK, index_Config as Config, index_Destination as Destination, index_Env as Env, index_IdentifyInstance as IdentifyInstance, index_InitSettings as InitSettings, index_Mapping as Mapping, index_RevenueInstance as RevenueInstance, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
 }
 
 declare const destinationAmplitude: Destination;