@ninetailed/experience.js 4.4.0-beta.1 → 4.5.0-beta.1

package/index.cjs

@@ -2591,11 +2591,13 @@ const ninetailedPlugin = ({
   apiClient,
   profile,
   locale,
-  ninetailed
+  ninetailed,
+  buildClientContext
 }) => {
   let _instance;
   let queue = [];
   let enabledFeatures = Object.values(experience_jsShared.FEATURES);
+  const buildContext = buildClientContext || buildClientNinetailedRequestContext;
   const flush = () => __awaiter(void 0, void 0, void 0, function* () {
     const events = Object.assign([], queue);
     experience_jsShared.logger.info('Start flushing events.');
@@ -2699,7 +2701,7 @@ const ninetailedPlugin = ({
       payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       experience_jsShared.logger.info('Sending Page event.');
-      const ctx = buildClientNinetailedRequestContext();
+      const ctx = buildContext();
       return enqueueEvent(experience_jsShared.buildPageEvent({
         messageId: payload.meta.rid,
         timestamp: payload.meta.ts,
@@ -2714,7 +2716,7 @@ const ninetailedPlugin = ({
       payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       experience_jsShared.logger.info('Sending Track event.');
-      const ctx = buildClientNinetailedRequestContext();
+      const ctx = buildContext();
       return enqueueEvent(experience_jsShared.buildTrackEvent({
         messageId: payload.meta.rid,
         timestamp: payload.meta.ts,
@@ -2730,7 +2732,7 @@ const ninetailedPlugin = ({
       payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       experience_jsShared.logger.info('Sending Identify event.');
-      const ctx = buildClientNinetailedRequestContext();
+      const ctx = buildContext();
       if (payload.userId === EMPTY_MERGE_ID && (!payload.traits || typeof payload.traits === 'object' && Object.keys(payload.traits).length === 0)) {
         experience_jsShared.logger.info('Skipping Identify event as no userId and no traits are set.');
         return;
@@ -3299,7 +3301,8 @@ class Ninetailed {
     locale,
     requestTimeout,
     onLog,
-    onError
+    onError,
+    buildClientContext
   } = {}) {
     this.isInitialized = false;
     this.page = (data, options) => __awaiter(this, void 0, void 0, function* () {
@@ -3466,6 +3469,7 @@ class Ninetailed {
       profile,
       locale,
       requestTimeout,
+      buildClientContext,
       ninetailed: this
     });
     this.instance = Analytics__default["default"]({

package/index.js

@@ -2584,11 +2584,13 @@ const ninetailedPlugin = ({
   apiClient,
   profile,
   locale,
-  ninetailed
+  ninetailed,
+  buildClientContext
 }) => {
   let _instance;
   let queue = [];
   let enabledFeatures = Object.values(FEATURES);
+  const buildContext = buildClientContext || buildClientNinetailedRequestContext;
   const flush = () => __awaiter(void 0, void 0, void 0, function* () {
     const events = Object.assign([], queue);
     logger.info('Start flushing events.');
@@ -2692,7 +2694,7 @@ const ninetailedPlugin = ({
       payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       logger.info('Sending Page event.');
-      const ctx = buildClientNinetailedRequestContext();
+      const ctx = buildContext();
       return enqueueEvent(buildPageEvent({
         messageId: payload.meta.rid,
         timestamp: payload.meta.ts,
@@ -2707,7 +2709,7 @@ const ninetailedPlugin = ({
       payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       logger.info('Sending Track event.');
-      const ctx = buildClientNinetailedRequestContext();
+      const ctx = buildContext();
       return enqueueEvent(buildTrackEvent({
         messageId: payload.meta.rid,
         timestamp: payload.meta.ts,
@@ -2723,7 +2725,7 @@ const ninetailedPlugin = ({
       payload
     }) => __awaiter(void 0, void 0, void 0, function* () {
       logger.info('Sending Identify event.');
-      const ctx = buildClientNinetailedRequestContext();
+      const ctx = buildContext();
       if (payload.userId === EMPTY_MERGE_ID && (!payload.traits || typeof payload.traits === 'object' && Object.keys(payload.traits).length === 0)) {
         logger.info('Skipping Identify event as no userId and no traits are set.');
         return;
@@ -3292,7 +3294,8 @@ class Ninetailed {
     locale,
     requestTimeout,
     onLog,
-    onError
+    onError,
+    buildClientContext
   } = {}) {
     this.isInitialized = false;
     this.page = (data, options) => __awaiter(this, void 0, void 0, function* () {
@@ -3459,6 +3462,7 @@ class Ninetailed {
       profile,
       locale,
       requestTimeout,
+      buildClientContext,
       ninetailed: this
     });
     this.instance = Analytics({

package/lib/Ninetailed.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="analytics" />
-import { Locale, Traits, Profile, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions } from '@ninetailed/experience.js-shared';
+import { Locale, Traits, Profile, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions, NinetailedRequestContext } from '@ninetailed/experience.js-shared';
 import { EventFunctionOptions, NinetailedInstance, NinetailedPlugin, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackHasSeenExperience } from './types';
 declare global {
     interface Window {
@@ -19,6 +19,7 @@ type Options = {
     requestTimeout?: number;
     onLog?: OnLogHandler;
     onError?: OnErrorHandler;
+    buildClientContext?: () => NinetailedRequestContext;
 };
 type NinetailedApiClientInstanceOrOptions = NinetailedApiClient | NinetailedApiClientOptions;
 export declare class Ninetailed implements NinetailedInstance {
@@ -31,7 +32,7 @@ export declare class Ninetailed implements NinetailedInstance {
     private readonly environment;
     readonly plugins: NinetailedPlugin[];
     readonly logger: Logger;
-    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, profile, locale, requestTimeout, onLog, onError, }?: Options);
+    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, profile, locale, requestTimeout, onLog, onError, buildClientContext, }?: Options);
     page: (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     track: (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     trackHasSeenComponent: TrackHasSeenComponent;

package/lib/analytics/get-analytics-plugin.d.ts

@@ -1,16 +1,17 @@
 import { AnalyticsPlugin } from 'analytics';
-import { Profile, Locale, NinetailedApiClient } from '@ninetailed/experience.js-shared';
+import { Profile, Locale, NinetailedApiClient, NinetailedRequestContext } from '@ninetailed/experience.js-shared';
 import { NinetailedInstance, FlushResult } from '../types';
 type AnalyticsPluginNinetailedConfig = {
     apiClient: NinetailedApiClient;
     profile?: Profile;
     locale?: Locale;
     requestTimeout?: number;
+    buildClientContext?: () => NinetailedRequestContext;
     ninetailed: NinetailedInstance;
 };
 export declare const PLUGIN_NAME = "ninetailed";
 export interface NinetailedEventQueue extends AnalyticsPlugin {
     flush: () => Promise<FlushResult>;
 }
-export declare const ninetailedPlugin: ({ apiClient, profile, locale, ninetailed, }: AnalyticsPluginNinetailedConfig) => NinetailedEventQueue;
+export declare const ninetailedPlugin: ({ apiClient, profile, locale, ninetailed, buildClientContext, }: AnalyticsPluginNinetailedConfig) => NinetailedEventQueue;
 export {};

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "4.4.0-beta.1",
+  "version": "4.5.0-beta.1",
   "module": "./index.js",
   "main": "./index.cjs",
   "type": "module",
   "types": "./index.d.ts",
   "dependencies": {
-    "@ninetailed/experience.js-shared": "4.4.0-beta.1",
+    "@ninetailed/experience.js-shared": "4.5.0-beta.1",
     "analytics": "0.8.1",
     "zod": "3.21.4"
   },