@amplitude/analytics-core 2.9.0 → 2.10.0

package/lib/esm/types/plugin.d.ts

@@ -6,11 +6,33 @@ type PluginTypeBefore = 'before';
 type PluginTypeEnrichment = 'enrichment';
 type PluginTypeDestination = 'destination';
 export type PluginType = PluginTypeBefore | PluginTypeEnrichment | PluginTypeDestination;
+export interface AnalyticsIdentity {
+    deviceId?: string;
+    userId?: string;
+    userProperties?: {
+        [key: string]: any;
+    };
+}
 interface PluginBase<T = CoreClient, U = IConfig> {
     name?: string;
     type?: PluginType;
     setup?(config: U, client: T): Promise<void>;
     teardown?(): Promise<void>;
+    /**
+     * Called when the identity is changed. This is a **best-effort** API and may not be triggered in all scenarios.
+     *
+     * Currently supported only in the Browser SDK. Not supported in React Native or Node SDKs.
+     *
+     * @param identity The changed identity. If a field is missing, it means it has not changed.
+     * For example, `{ userId: undefined }` means the userId was explicitly changed to `undefined`,
+     * while deviceId and userProperties remain unchanged.
+     *
+     * Note: `onIdentityChanged()` will be triggered when a user logs in via `setUserId()`.
+     * It will not be triggered on subsequent page loads (e.g., when a user reopens the site in a new tab).
+     */
+    onIdentityChanged?(identity: AnalyticsIdentity): Promise<void>;
+    onSessionIdChanged?(sessionId: number): Promise<void>;
+    onOptOutChanged?(optOut: boolean): Promise<void>;
 }
 export interface BeforePlugin<T = CoreClient, U = IConfig> extends PluginBase<T, U> {
     type: PluginTypeBefore;

package/lib/esm/types/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/types/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,KAAK,gBAAgB,GAAG,QAAQ,CAAC;AACjC,KAAK,oBAAoB,GAAG,YAAY,CAAC;AACzC,KAAK,qBAAqB,GAAG,aAAa,CAAC;AAC3C,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAEzF,UAAU,UAAU,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACjF,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACrF,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACtF,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/types/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,KAAK,gBAAgB,GAAG,QAAQ,CAAC;AACjC,KAAK,oBAAoB,GAAG,YAAY,CAAC;AACzC,KAAK,qBAAqB,GAAG,aAAa,CAAC;AAC3C,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAEzF,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACzC;AAED,UAAU,UAAU,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,CAAC,QAAQ,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,kBAAkB,CAAC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,eAAe,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClD;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACjF,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACrF,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAC5B,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,CAAE,SAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC;IACtF,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,CAAC,OAAO,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,KAAK,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,UAAU,EAAE,CAAC,GAAG,OAAO,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC"}

package/lib/esm/types/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/types/plugin.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from './event/event';\nimport { IConfig } from '../config';\nimport { Result } from './result';\nimport { CoreClient } from '../core-client';\n\ntype PluginTypeBefore = 'before';\ntype PluginTypeEnrichment = 'enrichment';\ntype PluginTypeDestination = 'destination';\nexport type PluginType = PluginTypeBefore | PluginTypeEnrichment | PluginTypeDestination;\n\ninterface PluginBase<T = CoreClient, U = IConfig> {\n  name?: string;\n  type?: PluginType;\n  setup?(config: U, client: T): Promise<void>;\n  teardown?(): Promise<void>;\n}\n\nexport interface BeforePlugin<T = CoreClient, U = IConfig> extends PluginBase<T, U> {\n  type: PluginTypeBefore;\n  execute?(context: Event): Promise<Event | null>;\n}\n\nexport interface EnrichmentPlugin<T = CoreClient, U = IConfig> extends PluginBase<T, U> {\n  type?: PluginTypeEnrichment;\n  execute?(context: Event): Promise<Event | null>;\n}\n\nexport interface DestinationPlugin<T = CoreClient, U = IConfig> extends PluginBase<T, U> {\n  type: PluginTypeDestination;\n  execute(context: Event): Promise<Result>;\n  flush?(): Promise<void>;\n}\n\nexport type Plugin<T = CoreClient, U = IConfig> = BeforePlugin<T, U> | EnrichmentPlugin<T, U> | DestinationPlugin<T, U>;\n"]}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/types/plugin.ts"],"names":[],"mappings":"","sourcesContent":["import { Event } from './event/event';\nimport { IConfig } from '../config';\nimport { Result } from './result';\nimport { CoreClient } from '../core-client';\n\ntype PluginTypeBefore = 'before';\ntype PluginTypeEnrichment = 'enrichment';\ntype PluginTypeDestination = 'destination';\nexport type PluginType = PluginTypeBefore | PluginTypeEnrichment | PluginTypeDestination;\n\nexport interface AnalyticsIdentity {\n  deviceId?: string;\n  userId?: string;\n  userProperties?: { [key: string]: any };\n}\n\ninterface PluginBase<T = CoreClient, U = IConfig> {\n  name?: string;\n  type?: PluginType;\n  setup?(config: U, client: T): Promise<void>;\n  teardown?(): Promise<void>;\n  /**\n   * Called when the identity is changed. This is a **best-effort** API and may not be triggered in all scenarios.\n   *\n   * Currently supported only in the Browser SDK. Not supported in React Native or Node SDKs.\n   *\n   * @param identity The changed identity. If a field is missing, it means it has not changed.\n   * For example, `{ userId: undefined }` means the userId was explicitly changed to `undefined`,\n   * while deviceId and userProperties remain unchanged.\n   *\n   * Note: `onIdentityChanged()` will be triggered when a user logs in via `setUserId()`.\n   * It will not be triggered on subsequent page loads (e.g., when a user reopens the site in a new tab).\n   */\n  onIdentityChanged?(identity: AnalyticsIdentity): Promise<void>;\n  onSessionIdChanged?(sessionId: number): Promise<void>;\n  onOptOutChanged?(optOut: boolean): Promise<void>;\n}\n\nexport interface BeforePlugin<T = CoreClient, U = IConfig> extends PluginBase<T, U> {\n  type: PluginTypeBefore;\n  execute?(context: Event): Promise<Event | null>;\n}\n\nexport interface EnrichmentPlugin<T = CoreClient, U = IConfig> extends PluginBase<T, U> {\n  type?: PluginTypeEnrichment;\n  execute?(context: Event): Promise<Event | null>;\n}\n\nexport interface DestinationPlugin<T = CoreClient, U = IConfig> extends PluginBase<T, U> {\n  type: PluginTypeDestination;\n  execute(context: Event): Promise<Result>;\n  flush?(): Promise<void>;\n}\n\nexport type Plugin<T = CoreClient, U = IConfig> = BeforePlugin<T, U> | EnrichmentPlugin<T, U> | DestinationPlugin<T, U>;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amplitude/analytics-core",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "description": "",
   "author": "Amplitude Inc",
   "homepage": "https://github.com/amplitude/Amplitude-TypeScript",
@@ -40,5 +40,5 @@
   "files": [
     "lib"
   ],
-  "gitHead": "bed8f4e611b944dab30a9aea4e48022655b0ddb0"
+  "gitHead": "a927cc91ccf2b58b71ed800ff269b1d1e80b071f"
 }