@ninetailed/experience.js 7.13.0-beta.1 → 7.14.0

package/index.cjs.js

@@ -137,12 +137,14 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
         messageId: payload.meta.rid,
         timestamp: payload.meta.ts,
         componentId: payload.componentId,
+        componentType: payload.componentType,
         experienceId: payload.experienceId,
         variantIndex: payload.variantIndex,
         ctx
       }));
     });
     this.methods = {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       reset: (...args) => __awaiter(this, void 0, void 0, function* () {
         experience_jsShared.logger.debug('Resetting profile.');
         const instance = args[args.length - 1];
@@ -161,6 +163,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
         experience_jsShared.logger.info('Profile reset successful.');
         yield delay(10);
       }),
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       debug: (...args) => __awaiter(this, void 0, void 0, function* () {
         const enabled = args[0];
         const instance = args[args.length - 1];
@@ -286,6 +289,7 @@ class NinetailedCorePlugin extends experience_jsPluginAnalytics.NinetailedAnalyt
   onTrackComponent() {
     return Promise.resolve();
   }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   setItemStart({
     abort,
     payload
@@ -764,9 +768,10 @@ class EventBuilder {
       userId: userId || ''
     }));
   }
-  component(componentId, experienceId, variantIndex, data) {
+  component(componentId, componentType, experienceId, variantIndex, data) {
     return experience_jsShared.buildComponentViewEvent(Object.assign(Object.assign({}, this.buildEventBase(data)), {
       componentId,
+      componentType: componentType || 'Entry',
       experienceId: experienceId || '',
       variantIndex: variantIndex || 0
     }));
@@ -910,6 +915,13 @@ class Ninetailed {
         type: experience_jsPluginAnalytics.HAS_SEEN_COMPONENT
       }));
     });
+    this.trackVariableComponentView = properties => {
+      const validatedVariable = experience_jsShared.SerializableObject.parse(properties.variable);
+      return this.instance.dispatch(Object.assign(Object.assign({}, properties), {
+        type: experience_jsPluginAnalytics.HAS_SEEN_VARIABLE,
+        variable: validatedVariable
+      }));
+    };
     this.trackComponentView = properties => {
       return this.instance.dispatch(Object.assign(Object.assign({}, properties), {
         type: experience_jsPluginAnalytics.HAS_SEEN_ELEMENT,
@@ -1352,6 +1364,7 @@ class Ninetailed {
   }
   logInvalidElement(element) {
     const isObject = typeof element === 'object' && element !== null;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const constructorName = isObject ? element.constructor.name : '';
     const isConstructorNameNotObject = constructorName && constructorName !== 'Object';
     experience_jsShared.logger.warn(`ElementSeenObserver.observeElement was called with an invalid element. Expected an Element but got ${typeof element}${isConstructorNameNotObject ? ` of type ${constructorName}` : ''}. This call will be ignored.`);

package/index.esm.js

@@ -1,6 +1,6 @@
-import { FEATURES, buildComponentViewEvent, logger, ConsoleLogSink, buildPageEvent, buildTrackEvent, buildIdentifyEvent, unionBy, pipe, PageviewProperties, Properties, Traits, isPageViewEvent, isTrackEvent, isIdentifyEvent, isComponentViewEvent, selectHasVariants, selectExperience, selectVariant as selectVariant$1, selectBaselineWithVariants, OnLogLogSink, OnErrorLogSink, NinetailedApiClient } from '@ninetailed/experience.js-shared';
+import { FEATURES, buildComponentViewEvent, logger, ConsoleLogSink, buildPageEvent, buildTrackEvent, buildIdentifyEvent, unionBy, pipe, PageviewProperties, Properties, Traits, isPageViewEvent, isTrackEvent, isIdentifyEvent, isComponentViewEvent, SerializableObject, selectHasVariants, selectExperience, selectVariant as selectVariant$1, selectBaselineWithVariants, OnLogLogSink, OnErrorLogSink, NinetailedApiClient } from '@ninetailed/experience.js-shared';
 export { EXPERIENCE_TRAIT_PREFIX, isExperienceMatch, selectActiveExperiments, selectDistribution, selectExperience, selectBaselineWithVariants as selectExperienceBaselineWithVariants, selectVariant as selectExperienceVariant, selectVariants as selectExperienceVariants, selectHasVariants as selectHasExperienceVariants } from '@ninetailed/experience.js-shared';
-import { NinetailedAnalyticsPlugin, HAS_SEEN_COMPONENT, HAS_SEEN_ELEMENT, hasComponentViewTrackingThreshold } from '@ninetailed/experience.js-plugin-analytics';
+import { NinetailedAnalyticsPlugin, HAS_SEEN_COMPONENT, HAS_SEEN_VARIABLE, HAS_SEEN_ELEMENT, hasComponentViewTrackingThreshold } from '@ninetailed/experience.js-plugin-analytics';
 import Analytics from 'analytics';
 import { v4 } from 'uuid';
 
@@ -62,6 +62,9 @@ const SET_ENABLED_FEATURES = 'setEnabledFeatures';
 const EMPTY_MERGE_ID = 'nt:empty-merge-id';
 
 const PLUGIN_NAME = 'ninetailed:core';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+
 const delay = ms => new Promise(resolve => setTimeout(resolve, ms));
 class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
   constructor({
@@ -99,12 +102,14 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
         messageId: payload.meta.rid,
         timestamp: payload.meta.ts,
         componentId: payload.componentId,
+        componentType: payload.componentType,
         experienceId: payload.experienceId,
         variantIndex: payload.variantIndex,
         ctx
       }));
     };
     this.methods = {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       reset: async function (...args) {
         logger.debug('Resetting profile.');
         const instance = args[args.length - 1];
@@ -123,6 +128,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
         logger.info('Profile reset successful.');
         await delay(10);
       },
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
       debug: async function (...args) {
         const enabled = args[0];
         const instance = args[args.length - 1];
@@ -239,6 +245,7 @@ class NinetailedCorePlugin extends NinetailedAnalyticsPlugin {
   onTrackComponent() {
     return Promise.resolve();
   }
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   setItemStart({
     abort,
     payload
@@ -735,9 +742,10 @@ class EventBuilder {
       userId: userId || ''
     }));
   }
-  component(componentId, experienceId, variantIndex, data) {
+  component(componentId, componentType, experienceId, variantIndex, data) {
     return buildComponentViewEvent(Object.assign({}, this.buildEventBase(data), {
       componentId,
+      componentType: componentType || 'Entry',
       experienceId: experienceId || '',
       variantIndex: variantIndex || 0
     }));
@@ -897,6 +905,13 @@ class Ninetailed {
         type: HAS_SEEN_COMPONENT
       }));
     };
+    this.trackVariableComponentView = properties => {
+      const validatedVariable = SerializableObject.parse(properties.variable);
+      return this.instance.dispatch(Object.assign({}, properties, {
+        type: HAS_SEEN_VARIABLE,
+        variable: validatedVariable
+      }));
+    };
     this.trackComponentView = properties => {
       return this.instance.dispatch(Object.assign({}, properties, {
         type: HAS_SEEN_ELEMENT,
@@ -1346,6 +1361,7 @@ class Ninetailed {
   }
   logInvalidElement(element) {
     const isObject = typeof element === 'object' && element !== null;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const constructorName = isObject ? element.constructor.name : '';
     const isConstructorNameNotObject = constructorName && constructorName !== 'Object';
     logger.warn(`ElementSeenObserver.observeElement was called with an invalid element. Expected an Element but got ${typeof element}${isConstructorNameNotObject ? ` of type ${constructorName}` : ''}. This call will be ignored.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "7.13.0-beta.1",
+  "version": "7.14.0",
   "description": "Ninetailed SDK for javascript",
   "license": "MIT",
   "repository": {
@@ -9,8 +9,8 @@
     "directory": "packages/sdks/javascript"
   },
   "dependencies": {
-    "@ninetailed/experience.js-plugin-analytics": "7.13.0-beta.1",
-    "@ninetailed/experience.js-shared": "7.13.0-beta.1",
+    "@ninetailed/experience.js-plugin-analytics": "7.14.0",
+    "@ninetailed/experience.js-shared": "7.14.0",
     "analytics": "0.8.1",
     "uuid": "9.0.0"
   },

package/src/index.d.ts

@@ -10,6 +10,7 @@ export * from './lib/types/interfaces/RequiresEventBuilder';
 export * from './lib/types/interfaces/HasExperienceSelectionMiddleware';
 export * from './lib/types/interfaces/HasChangesModificationMiddleware';
 export * from './lib/types/interfaces/InterestedInSeenElements';
+export * from './lib/types/interfaces/InterestedInSeenVariables';
 export * from './lib/types/interfaces/InterestedInProfileChange';
 export * from './lib/types/interfaces/InterestedInHiddenPage';
 export * from './lib/types/interfaces/AcceptsCredentials';

package/src/lib/Ninetailed.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="analytics" />
 import { Locale, Traits, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions, NinetailedRequestContext, Reference, Event } from '@ninetailed/experience.js-shared';
 import { OnInitProfileId } from './NinetailedCorePlugin';
-import { EventFunctionOptions, NinetailedInstance, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackComponentView, OnChangesChangeCallback } from './types';
+import { EventFunctionOptions, NinetailedInstance, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackComponentView, OnChangesChangeCallback, TrackVariableComponentView } from './types';
 import { ObserveOptions } from './ElementSeenObserver';
 import { OnSelectVariantArgs, OnSelectVariantCallback } from './types/OnSelectVariant';
 import { ElementSeenPayload, NinetailedPlugin } from '@ninetailed/experience.js-plugin-analytics';
@@ -68,6 +68,7 @@ export declare class Ninetailed implements NinetailedInstance {
      * Will be removed in the next version of the SDK
      */
     trackHasSeenComponent: TrackHasSeenComponent;
+    trackVariableComponentView: TrackVariableComponentView;
     trackComponentView: TrackComponentView;
     private get pluginsWithCustomComponentViewThreshold();
     observeElement: (payload: ElementSeenPayload, options?: ObserveOptions) => void;

package/src/lib/NinetailedCorePlugin/actions.d.ts

@@ -1,5 +1,5 @@
-import { HAS_SEEN_COMPONENT, HAS_SEEN_ELEMENT } from '@ninetailed/experience.js-plugin-analytics';
-import { PROFILE_CHANGE, Profile, SelectedVariantInfo, PROFILE_RESET, Change } from '@ninetailed/experience.js-shared';
+import { HAS_SEEN_COMPONENT, HAS_SEEN_ELEMENT, HAS_SEEN_VARIABLE } from '@ninetailed/experience.js-plugin-analytics';
+import { PROFILE_CHANGE, Profile, SelectedVariantInfo, PROFILE_RESET, Change, SerializableObject } from '@ninetailed/experience.js-shared';
 import { HAS_SEEN_STICKY_COMPONENT, PAGE_HIDDEN } from '../constants';
 type ReadyAction = {
     type: 'ready';
@@ -9,6 +9,10 @@ type HasSeenElementAction = {
     seenFor: number | undefined;
     element: Element;
 };
+type HasSeenVariableAction = {
+    type: typeof HAS_SEEN_VARIABLE;
+    variable: SerializableObject;
+};
 type PageHiddenAction = {
     type: typeof PAGE_HIDDEN;
 };
@@ -44,7 +48,7 @@ type ProfileHasSeenComponentAction = {
     };
     isPersonalized: boolean;
 };
-export type DispatchAction = ReadyAction | ProfileChangeAction | ProfileResetAction | ProfileHasSeenStickyComponentAction | HasSeenElementAction | ProfileHasSeenComponentAction | PageHiddenAction;
+export type DispatchAction = ReadyAction | ProfileChangeAction | ProfileResetAction | ProfileHasSeenStickyComponentAction | HasSeenElementAction | HasSeenVariableAction | ProfileHasSeenComponentAction | PageHiddenAction;
 type RemoveTypeField<Type> = {
     [Property in keyof Type as Exclude<Property, 'type'>]: Type[Property];
 };

package/src/lib/types/index.d.ts

@@ -1,6 +1,6 @@
 import { DetachListeners } from 'analytics';
 import { Logger, PageviewProperties, Profile, Properties, Traits, SelectedVariantInfo, Reference, Event, Change } from '@ninetailed/experience.js-shared';
-import { ElementSeenPayload, NinetailedPlugin, TrackComponentProperties } from '@ninetailed/experience.js-plugin-analytics';
+import { ElementSeenPayload, VariableSeenPayload, NinetailedPlugin, TrackComponentProperties } from '@ninetailed/experience.js-plugin-analytics';
 import { type Ninetailed } from '../Ninetailed';
 import { OnSelectVariant } from './OnSelectVariant';
 import { EventBuilder } from '../utils/EventBuilder';
@@ -63,6 +63,7 @@ export type Page = (data?: Partial<PageviewProperties>, options?: EventFunctionO
 export type Track = (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<FlushResult>;
 export type TrackHasSeenComponent = (properties: TrackComponentProperties) => Promise<void>;
 export type TrackComponentView = (properties: Omit<ElementSeenPayload, 'seenFor'>) => Promise<void>;
+export type TrackVariableComponentView = (properties: VariableSeenPayload) => Promise<void>;
 export type Identify = (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<FlushResult>;
 export type Batch = (events: Event[]) => Promise<FlushResult>;
 export type Reset = () => void;
@@ -79,6 +80,7 @@ export interface NinetailedInstance<TBaseline extends Reference = Reference, TVa
      */
     trackHasSeenComponent: TrackHasSeenComponent;
     trackComponentView: TrackComponentView;
+    trackVariableComponentView: TrackVariableComponentView;
     identify: Identify;
     batch: Batch;
     reset: Reset;

package/src/lib/types/interfaces/InterestedInSeenVariables.d.ts

@@ -0,0 +1,4 @@
+import { EventHandler, VariableSeenPayload, HAS_SEEN_VARIABLE } from '@ninetailed/experience.js-plugin-analytics';
+export interface InterestedInSeenVariables {
+    [HAS_SEEN_VARIABLE]: EventHandler<VariableSeenPayload>;
+}

package/src/lib/utils/EventBuilder.d.ts

@@ -1,4 +1,5 @@
 import { BuildPageEventArgs, BuildTrackEventArgs, IdentifyEventArgs, NinetailedRequestContext, Properties } from '@ninetailed/experience.js-shared';
+import type { ComponentViewEventComponentType } from '@ninetailed/experience.js-plugin-analytics';
 type PageData = Partial<Omit<BuildPageEventArgs, 'ctx' | 'properties'>>;
 type TrackData = Partial<Omit<BuildTrackEventArgs, 'ctx' | 'event' | 'properties'>>;
 type IdentifyData = Partial<Omit<IdentifyEventArgs, 'ctx' | 'userId' | 'traits'>>;
@@ -168,7 +169,7 @@ export declare class EventBuilder {
         userId?: string | undefined;
         traits: Properties;
     };
-    component(componentId: string, experienceId?: string, variantIndex?: number, data?: ComponentData): {
+    component(componentId: string, componentType: ComponentViewEventComponentType, experienceId?: string, variantIndex?: number, data?: ComponentData): {
         channel: import("@ninetailed/experience.js-shared").EventChanel;
         context: {
             app?: {
@@ -219,6 +220,7 @@ export declare class EventBuilder {
         sentAt: string;
         type: import("@ninetailed/experience.js-shared").EventType;
         userId?: string | undefined;
+        componentType: import("@ninetailed/experience.js-shared").ComponentViewEventComponentType;
         componentId: string;
         experienceId?: string | undefined;
         variantIndex?: number | undefined;