@amplitude/unified 1.0.0-beta.5 → 1.0.0-beta.7

package/lib/esm/unified.js

@@ -2,34 +2,34 @@ import { __assign, __awaiter, __extends, __generator } from "tslib";
 import { AmplitudeBrowser } from '@amplitude/analytics-browser';
 import { sessionReplayPlugin, SessionReplayPlugin, } from '@amplitude/plugin-session-replay-browser';
 import { ExperimentPlugin, experimentPlugin, } from '@amplitude/plugin-experiment-browser';
+import { plugin as EngagementPlugin } from '@amplitude/engagement-browser';
 import { libraryPlugin } from './library';
 var AmplitudeUnified = /** @class */ (function (_super) {
     __extends(AmplitudeUnified, _super);
     function AmplitudeUnified() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
-    Object.defineProperty(AmplitudeUnified.prototype, "experiment", {
-        get: function () {
-            // Return when init() or initAll() is not called
-            if (this.config === undefined) {
-                return undefined;
-            }
-            var expPlugins = this.plugins(ExperimentPlugin);
-            if (expPlugins.length === 0) {
-                this.config.loggerProvider.debug("".concat(ExperimentPlugin.pluginName, " plugin is not found."));
-                return undefined;
-            }
-            else if (expPlugins.length === 1) {
-                return expPlugins[0].experiment;
-            }
-            else {
-                this.config.loggerProvider.debug("Multiple instances of ".concat(ExperimentPlugin.pluginName, " are found."));
-                return undefined;
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
+    AmplitudeUnified.prototype.sessionReplay = function () {
+        return this._sessionReplay;
+    };
+    AmplitudeUnified.prototype.experiment = function () {
+        // Return when init() or initAll() is not called
+        if (this.config === undefined) {
+            return undefined;
+        }
+        var expPlugins = this.plugins(ExperimentPlugin);
+        if (expPlugins.length === 0) {
+            this.config.loggerProvider.debug("".concat(ExperimentPlugin.pluginName, " plugin is not found."));
+            return undefined;
+        }
+        else if (expPlugins.length === 1) {
+            return expPlugins[0].experiment;
+        }
+        else {
+            this.config.loggerProvider.debug("Multiple instances of ".concat(ExperimentPlugin.pluginName, " are found."));
+            return undefined;
+        }
+    };
     /**
      * Initialize SDKs with configuration options.
      *
@@ -62,8 +62,11 @@ var AmplitudeUnified = /** @class */ (function (_super) {
                             this.config.loggerProvider.debug("".concat(SessionReplayPlugin.pluginName, " plugin is not found."));
                         }
                         else {
-                            this.sessionReplay = srPlugin.sessionReplay;
+                            this._sessionReplay = srPlugin.sessionReplay;
                         }
+                        return [4 /*yield*/, _super.prototype.add.call(this, EngagementPlugin(__assign(__assign({}, unifiedOptions === null || unifiedOptions === void 0 ? void 0 : unifiedOptions.engagement), sharedOptions))).promise];
+                    case 4:
+                        _a.sent();
                         return [2 /*return*/];
                 }
             });

package/lib/esm/unified.js.map

@@ -1 +1 @@
-{"version":3,"file":"unified.js","sourceRoot":"","sources":["../../src/unified.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAGL,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAGL,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAmB1C;IAAsC,oCAAgB;IAAtD;;IA2DA,CAAC;IAtDC,sBAAI,wCAAU;aAAd;YACE,gDAAgD;YAChD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;gBAC7B,OAAO,SAAS,CAAC;aAClB;YAED,IAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAClD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,UAAG,gBAAgB,CAAC,UAAU,0BAAuB,CAAC,CAAC;gBACxF,OAAO,SAAS,CAAC;aAClB;iBAAM,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;gBAClC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;aACjC;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,gCAAyB,gBAAgB,CAAC,UAAU,gBAAa,CAAC,CAAC;gBACpG,OAAO,SAAS,CAAC;aAClB;QACH,CAAC;;;OAAA;IAED;;;;;;OAMG;IACG,kCAAO,GAAb,UAAc,MAAc,EAAE,cAA+B;;;;;;wBACrD,aAAa,GAAG;4BACpB,UAAU,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,UAAU;4BACtC,YAAY,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,YAAY;yBAC3C,CAAC;wBAEF,iBAAM,GAAG,YAAC,aAAa,EAAE,CAAC,CAAC;wBAC3B,qBAAM,iBAAM,IAAI,YAAC,MAAM,wBAAO,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,SAAS,GAAK,aAAa,EAAG,CAAC,OAAO,EAAA;;wBAApF,SAAoF,CAAC;wBAErF,qBAAM,iBAAM,GAAG,YAAC,mBAAmB,uBAAM,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,aAAa,GAAK,aAAa,EAAG,CAAC,CAAC,OAAO,EAAA;;wBAApG,SAAoG,CAAC;wBAErG,qBAAM,iBAAM,GAAG,YAAC,gBAAgB,uBAAM,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,UAAU,GAAK,aAAa,EAAG,CAAC,CAAC,OAAO,EAAA;;wBAA9F,SAA8F,CAAC;wBAEzF,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;wBAC7D,IAAI,QAAQ,KAAK,SAAS,EAAE;4BAC1B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,UAAG,mBAAmB,CAAC,UAAU,0BAAuB,CAAC,CAAC;yBAC5F;6BAAM;4BACL,IAAI,CAAC,aAAa,GAAI,QAAgC,CAAC,aAAa,CAAC;yBACtE;;;;;KACF;IAED;;OAEG;IACH,0BAA0B;IAC1B,+BAAI,GAAJ,UAAK,MAAW,EAAE,eAAyC,EAAE,YAA6B;QAArF,uBAAA,EAAA,WAAW;QACd,IAAM,GAAG,GAAG,iBAAM,IAAI,YAAC,MAAM,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;QAC9D,OAAO,GAAG,CAAC;IACb,CAAC;IACH,uBAAC;AAAD,CAAC,AA3DD,CAAsC,gBAAgB,GA2DrD","sourcesContent":["import { AmplitudeBrowser } from '@amplitude/analytics-browser';\nimport {\n  AmplitudeSessionReplay,\n  SessionReplayOptions,\n  sessionReplayPlugin,\n  SessionReplayPlugin,\n} from '@amplitude/plugin-session-replay-browser';\nimport {\n  IExperimentClient,\n  ExperimentPluginConfig,\n  ExperimentPlugin,\n  experimentPlugin,\n} from '@amplitude/plugin-experiment-browser';\nimport { BrowserClient, BrowserOptions } from '@amplitude/analytics-core';\nimport { libraryPlugin } from './library';\n\nexport interface UnifiedSharedOptions {\n  serverZone?: 'US' | 'EU';\n  instanceName?: string;\n}\n\nexport type UnifiedOptions = UnifiedSharedOptions & {\n  analytics?: BrowserOptions;\n  sessionReplay?: Omit<SessionReplayOptions, keyof UnifiedSharedOptions>;\n  experiment?: Omit<ExperimentPluginConfig, keyof UnifiedSharedOptions>;\n};\n\nexport interface UnifiedClient extends BrowserClient {\n  initAll(apiKey: string, unifiedOptions?: UnifiedOptions): Promise<void>;\n  sessionReplay: AmplitudeSessionReplay;\n  experiment: IExperimentClient | undefined;\n}\n\nexport class AmplitudeUnified extends AmplitudeBrowser implements UnifiedClient {\n  // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n  // @ts-ignore\n  sessionReplay: AmplitudeSessionReplay;\n\n  get experiment(): IExperimentClient | undefined {\n    // Return when init() or initAll() is not called\n    if (this.config === undefined) {\n      return undefined;\n    }\n\n    const expPlugins = this.plugins(ExperimentPlugin);\n    if (expPlugins.length === 0) {\n      this.config.loggerProvider.debug(`${ExperimentPlugin.pluginName} plugin is not found.`);\n      return undefined;\n    } else if (expPlugins.length === 1) {\n      return expPlugins[0].experiment;\n    } else {\n      this.config.loggerProvider.debug(`Multiple instances of ${ExperimentPlugin.pluginName} are found.`);\n      return undefined;\n    }\n  }\n\n  /**\n   * Initialize SDKs with configuration options.\n   *\n   * @param apiKey Amplitude API key.\n   * @param analyticsOptions Analytics configuration options. Refer to {@link https://amplitude.com/docs/sdks/analytics/browser/browser-sdk-2#configure-the-sdk here} for more info.\n   * @param unifiedOptions Shared configuration for all SDKs and for blade SDKs.\n   */\n  async initAll(apiKey: string, unifiedOptions?: UnifiedOptions) {\n    const sharedOptions = {\n      serverZone: unifiedOptions?.serverZone,\n      instanceName: unifiedOptions?.instanceName,\n    };\n\n    super.add(libraryPlugin());\n    await super.init(apiKey, { ...unifiedOptions?.analytics, ...sharedOptions }).promise;\n\n    await super.add(sessionReplayPlugin({ ...unifiedOptions?.sessionReplay, ...sharedOptions })).promise;\n\n    await super.add(experimentPlugin({ ...unifiedOptions?.experiment, ...sharedOptions })).promise;\n\n    const srPlugin = this.plugin(SessionReplayPlugin.pluginName);\n    if (srPlugin === undefined) {\n      this.config.loggerProvider.debug(`${SessionReplayPlugin.pluginName} plugin is not found.`);\n    } else {\n      this.sessionReplay = (srPlugin as SessionReplayPlugin).sessionReplay;\n    }\n  }\n\n  /**\n   * Only analytics SDK is initialized. Use initAll() instead to initialize all blade SDKs.\n   */\n  /* istanbul ignore next */\n  init(apiKey = '', userIdOrOptions?: string | BrowserOptions, maybeOptions?: BrowserOptions) {\n    const res = super.init(apiKey, userIdOrOptions, maybeOptions);\n    return res;\n  }\n}\n"]}
+{"version":3,"file":"unified.js","sourceRoot":"","sources":["../../src/unified.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAGL,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAGL,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAe,MAAM,IAAI,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAoB1C;IAAsC,oCAAgB;IAAtD;;IAsEA,CAAC;IAjEC,wCAAa,GAAb;QACE,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,qCAAU,GAAV;QACE,gDAAgD;QAChD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,SAAS,CAAC;SAClB;QAED,IAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAClD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,UAAG,gBAAgB,CAAC,UAAU,0BAAuB,CAAC,CAAC;YACxF,OAAO,SAAS,CAAC;SAClB;aAAM,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;SACjC;aAAM;YACL,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,gCAAyB,gBAAgB,CAAC,UAAU,gBAAa,CAAC,CAAC;YACpG,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED;;;;;;OAMG;IACG,kCAAO,GAAb,UAAc,MAAc,EAAE,cAA+B;;;;;;wBACrD,aAAa,GAAG;4BACpB,UAAU,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,UAAU;4BACtC,YAAY,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,YAAY;yBAC3C,CAAC;wBAEF,iBAAM,GAAG,YAAC,aAAa,EAAE,CAAC,CAAC;wBAC3B,qBAAM,iBAAM,IAAI,YAAC,MAAM,wBAAO,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,SAAS,GAAK,aAAa,EAAG,CAAC,OAAO,EAAA;;wBAApF,SAAoF,CAAC;wBAErF,qBAAM,iBAAM,GAAG,YAAC,mBAAmB,uBAAM,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,aAAa,GAAK,aAAa,EAAG,CAAC,CAAC,OAAO,EAAA;;wBAApG,SAAoG,CAAC;wBAErG,qBAAM,iBAAM,GAAG,YAAC,gBAAgB,uBAAM,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,UAAU,GAAK,aAAa,EAAG,CAAC,CAAC,OAAO,EAAA;;wBAA9F,SAA8F,CAAC;wBAEzF,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;wBAC7D,IAAI,QAAQ,KAAK,SAAS,EAAE;4BAC1B,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,UAAG,mBAAmB,CAAC,UAAU,0BAAuB,CAAC,CAAC;yBAC5F;6BAAM;4BACL,IAAI,CAAC,cAAc,GAAI,QAAgC,CAAC,aAAa,CAAC;yBACvE;wBAED,qBAAM,iBAAM,GAAG,YACb,gBAAgB,uBACX,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,UAAU,GAC1B,aAAa,EAChB,CACH,CAAC,OAAO,EAAA;;wBALT,SAKS,CAAC;;;;;KACX;IAED;;OAEG;IACH,0BAA0B;IAC1B,+BAAI,GAAJ,UAAK,MAAW,EAAE,eAAyC,EAAE,YAA6B;QAArF,uBAAA,EAAA,WAAW;QACd,IAAM,GAAG,GAAG,iBAAM,IAAI,YAAC,MAAM,EAAE,eAAe,EAAE,YAAY,CAAC,CAAC;QAC9D,OAAO,GAAG,CAAC;IACb,CAAC;IACH,uBAAC;AAAD,CAAC,AAtED,CAAsC,gBAAgB,GAsErD","sourcesContent":["import { AmplitudeBrowser } from '@amplitude/analytics-browser';\nimport {\n  AmplitudeSessionReplay,\n  SessionReplayOptions,\n  sessionReplayPlugin,\n  SessionReplayPlugin,\n} from '@amplitude/plugin-session-replay-browser';\nimport {\n  IExperimentClient,\n  ExperimentPluginConfig,\n  ExperimentPlugin,\n  experimentPlugin,\n} from '@amplitude/plugin-experiment-browser';\nimport { InitOptions, plugin as EngagementPlugin } from '@amplitude/engagement-browser';\nimport { BrowserClient, BrowserOptions } from '@amplitude/analytics-core';\nimport { libraryPlugin } from './library';\n\nexport interface UnifiedSharedOptions {\n  serverZone?: 'US' | 'EU';\n  instanceName?: string;\n}\n\nexport type UnifiedOptions = UnifiedSharedOptions & {\n  analytics?: BrowserOptions;\n  sessionReplay?: Omit<SessionReplayOptions, keyof UnifiedSharedOptions>;\n  experiment?: Omit<ExperimentPluginConfig, keyof UnifiedSharedOptions>;\n  engagement?: Omit<InitOptions, keyof UnifiedSharedOptions>;\n};\n\nexport interface UnifiedClient extends BrowserClient {\n  initAll(apiKey: string, unifiedOptions?: UnifiedOptions): Promise<void>;\n  sessionReplay(): AmplitudeSessionReplay;\n  experiment(): IExperimentClient | undefined;\n}\n\nexport class AmplitudeUnified extends AmplitudeBrowser implements UnifiedClient {\n  // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n  // @ts-ignore\n  private _sessionReplay: AmplitudeSessionReplay;\n\n  sessionReplay(): AmplitudeSessionReplay {\n    return this._sessionReplay;\n  }\n\n  experiment(): IExperimentClient | undefined {\n    // Return when init() or initAll() is not called\n    if (this.config === undefined) {\n      return undefined;\n    }\n\n    const expPlugins = this.plugins(ExperimentPlugin);\n    if (expPlugins.length === 0) {\n      this.config.loggerProvider.debug(`${ExperimentPlugin.pluginName} plugin is not found.`);\n      return undefined;\n    } else if (expPlugins.length === 1) {\n      return expPlugins[0].experiment;\n    } else {\n      this.config.loggerProvider.debug(`Multiple instances of ${ExperimentPlugin.pluginName} are found.`);\n      return undefined;\n    }\n  }\n\n  /**\n   * Initialize SDKs with configuration options.\n   *\n   * @param apiKey Amplitude API key.\n   * @param analyticsOptions Analytics configuration options. Refer to {@link https://amplitude.com/docs/sdks/analytics/browser/browser-sdk-2#configure-the-sdk here} for more info.\n   * @param unifiedOptions Shared configuration for all SDKs and for blade SDKs.\n   */\n  async initAll(apiKey: string, unifiedOptions?: UnifiedOptions) {\n    const sharedOptions = {\n      serverZone: unifiedOptions?.serverZone,\n      instanceName: unifiedOptions?.instanceName,\n    };\n\n    super.add(libraryPlugin());\n    await super.init(apiKey, { ...unifiedOptions?.analytics, ...sharedOptions }).promise;\n\n    await super.add(sessionReplayPlugin({ ...unifiedOptions?.sessionReplay, ...sharedOptions })).promise;\n\n    await super.add(experimentPlugin({ ...unifiedOptions?.experiment, ...sharedOptions })).promise;\n\n    const srPlugin = this.plugin(SessionReplayPlugin.pluginName);\n    if (srPlugin === undefined) {\n      this.config.loggerProvider.debug(`${SessionReplayPlugin.pluginName} plugin is not found.`);\n    } else {\n      this._sessionReplay = (srPlugin as SessionReplayPlugin).sessionReplay;\n    }\n\n    await super.add(\n      EngagementPlugin({\n        ...unifiedOptions?.engagement,\n        ...sharedOptions,\n      }),\n    ).promise;\n  }\n\n  /**\n   * Only analytics SDK is initialized. Use initAll() instead to initialize all blade SDKs.\n   */\n  /* istanbul ignore next */\n  init(apiKey = '', userIdOrOptions?: string | BrowserOptions, maybeOptions?: BrowserOptions) {\n    const res = super.init(apiKey, userIdOrOptions, maybeOptions);\n    return res;\n  }\n}\n"]}

package/lib/esm/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.0.0-beta.5";
+export declare const VERSION = "1.0.0-beta.7";
 //# sourceMappingURL=version.d.ts.map

package/lib/esm/version.js

@@ -1,3 +1,3 @@
 // Autogenerated by `yarn version-file`. DO NOT EDIT
-export var VERSION = '1.0.0-beta.5';
+export var VERSION = '1.0.0-beta.7';
 //# sourceMappingURL=version.js.map

package/lib/esm/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,MAAM,CAAC,IAAM,OAAO,GAAG,cAAc,CAAC","sourcesContent":["// Autogenerated by `yarn version-file`. DO NOT EDIT\nexport const VERSION = '1.0.0-beta.5';\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,oDAAoD;AACpD,MAAM,CAAC,IAAM,OAAO,GAAG,cAAc,CAAC","sourcesContent":["// Autogenerated by `yarn version-file`. DO NOT EDIT\nexport const VERSION = '1.0.0-beta.7';\n"]}