@ninetailed/experience.js 6.3.0 → 6.4.0-beta.1

package/index.cjs

@@ -2604,11 +2604,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.');
@@ -2712,7 +2714,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,
@@ -2727,7 +2729,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,
@@ -2743,7 +2745,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;
@@ -3361,6 +3363,7 @@ class Ninetailed {
     requestTimeout,
     onLog,
     onError,
+    buildClientContext,
     componentViewTrackingThreshold = 2000
   } = {}) {
     this.isInitialized = false;
@@ -3566,6 +3569,7 @@ class Ninetailed {
       profile,
       locale,
       requestTimeout,
+      buildClientContext,
       ninetailed: this
     });
     this.instance = Analytics__default["default"]({

package/index.js

@@ -2597,11 +2597,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.');
@@ -2705,7 +2707,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,
@@ -2720,7 +2722,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,
@@ -2736,7 +2738,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;
@@ -3354,6 +3356,7 @@ class Ninetailed {
     requestTimeout,
     onLog,
     onError,
+    buildClientContext,
     componentViewTrackingThreshold = 2000
   } = {}) {
     this.isInitialized = false;
@@ -3559,6 +3562,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, ElementSeenPayload, TrackComponentView } from './types';
 import { ObserveOptions } from './ElementSeenObserver';
 declare global {
@@ -21,6 +21,7 @@ type Options = {
     onLog?: OnLogHandler;
     onError?: OnErrorHandler;
     componentViewTrackingThreshold?: number;
+    buildClientContext?: () => NinetailedRequestContext;
 };
 type NinetailedApiClientInstanceOrOptions = NinetailedApiClient | NinetailedApiClientOptions;
 export declare class Ninetailed implements NinetailedInstance {
@@ -36,7 +37,7 @@ export declare class Ninetailed implements NinetailedInstance {
     readonly plugins: NinetailedPlugin[];
     readonly logger: Logger;
     private readonly componentViewTrackingThreshold;
-    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, profile, locale, requestTimeout, onLog, onError, componentViewTrackingThreshold, }?: Options);
+    constructor(ninetailedApiClientInstanceOrOptions: NinetailedApiClientInstanceOrOptions, { plugins, url, profile, locale, requestTimeout, onLog, onError, buildClientContext, componentViewTrackingThreshold, }?: Options);
     page: (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     track: (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     /**

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": "6.3.0",
+  "version": "6.4.0-beta.1",
   "module": "./index.js",
   "main": "./index.cjs",
   "type": "module",
   "types": "./index.d.ts",
   "dependencies": {
-    "@ninetailed/experience.js-shared": "6.3.0",
+    "@ninetailed/experience.js-shared": "6.4.0-beta.1",
     "analytics": "0.8.1",
     "zod": "3.21.4"
   },