@ninetailed/experience.js 7.6.0-beta.1 → 7.6.0-beta.3

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "7.6.0-beta.1",
-  "license": "BSL-1.1",
-  "module": "./index.js",
-  "main": "./index.cjs",
+  "version": "7.6.0-beta.3",
   "type": "module",
-  "types": "./src/index.d.ts",
+  "description": "Ninetailed SDK for javascript",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ninetailed-inc/experience.js.git",
+    "directory": "packages/sdks/javascript"
+  },
   "dependencies": {
-    "@ninetailed/experience.js-shared": "7.6.0-beta.1",
     "analytics": "0.8.1",
-    "uuid": "9.0.0",
-    "zod": "3.21.4"
+    "@ninetailed/experience.js-plugin-analytics": "*",
+    "@ninetailed/experience.js-shared": "*",
+    "uuid": "9.0.0"
   },
-  "peerDependencies": {}
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js"
 }

package/src/index.d.ts

@@ -1,5 +1,5 @@
 export * from './lib/constants';
-export * from './lib/ninetailedCorePlugin';
+export * from './lib/NinetailedCorePlugin';
 export * from './lib/Ninetailed';
 export * from './lib/selectVariant';
 export * from './lib/types';

package/src/lib/ElementSeenObserver.d.ts

@@ -1,5 +1,5 @@
 export type ElementSeenObserverOptions = {
-    onElementSeen: (element: Element) => void;
+    onElementSeen: (element: Element, delay?: number) => void;
 };
 export type ObserveOptions = {
     delay?: number;

package/src/lib/Ninetailed.d.ts

@@ -1,9 +1,10 @@
 /// <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, NinetailedPlugin, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, ElementSeenPayload, TrackComponentView } from './types';
+import { OnInitProfileId } from './NinetailedCorePlugin';
+import { EventFunctionOptions, NinetailedInstance, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackComponentView } from './types';
 import { ObserveOptions } from './ElementSeenObserver';
 import { OnSelectVariantArgs, OnSelectVariantCallback } from './types/OnSelectVariant';
+import { ElementSeenPayload, NinetailedPlugin } from '@ninetailed/experience.js-plugin-analytics';
 import { EventBuilder } from './utils/EventBuilder';
 declare global {
     interface Window {
@@ -68,6 +69,7 @@ export declare class Ninetailed implements NinetailedInstance {
      */
     trackHasSeenComponent: TrackHasSeenComponent;
     trackComponentView: TrackComponentView;
+    private get pluginsWithCustomComponentViewThreshold();
     observeElement: (payload: ElementSeenPayload, options?: ObserveOptions) => void;
     unobserveElement: (element: Element) => void;
     private onElementSeen;

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

@@ -0,0 +1,69 @@
+import { AnalyticsInstance } from 'analytics';
+import { Locale, NinetailedApiClient, NinetailedRequestContext } from '@ninetailed/experience.js-shared';
+import { NinetailedAnalyticsPlugin, NinetailedPlugin, SanitizedElementSeenPayload } from '@ninetailed/experience.js-plugin-analytics';
+import { NinetailedInstance, FlushResult } from '../types';
+import { HAS_SEEN_STICKY_COMPONENT } from '../constants';
+import { HasComponentViewTrackingThreshold } from '../types/interfaces/HasComponentViewTrackingThreshold';
+export type OnInitProfileId = (profileId?: string) => Promise<string | undefined> | string | undefined;
+type AnalyticsPluginNinetailedConfig = {
+    apiClient: NinetailedApiClient;
+    locale?: Locale;
+    requestTimeout?: number;
+    onInitProfileId?: OnInitProfileId;
+    buildClientContext?: () => NinetailedRequestContext;
+    ninetailed: NinetailedInstance;
+};
+export declare const PLUGIN_NAME = "ninetailed:core";
+type EventFn = {
+    payload: any;
+    instance: InternalAnalyticsInstance;
+};
+type AbortableFnParams = {
+    abort: () => void;
+    payload: unknown;
+};
+type InternalAnalyticsInstance = AnalyticsInstance & {
+    dispatch: (action: any) => void;
+};
+export interface NinetailedCorePlugin extends NinetailedPlugin {
+    flush: (args: void) => Promise<FlushResult>;
+}
+export declare class NinetailedCorePlugin extends NinetailedAnalyticsPlugin implements NinetailedCorePlugin, HasComponentViewTrackingThreshold {
+    name: string;
+    private _instance?;
+    private queue;
+    private enabledFeatures;
+    private readonly buildContext;
+    private readonly onInitProfileId?;
+    private readonly apiClient;
+    private readonly locale?;
+    private readonly ninetailed;
+    constructor({ apiClient, locale, ninetailed, onInitProfileId, buildClientContext, }: AnalyticsPluginNinetailedConfig);
+    initialize({ instance, }: {
+        instance: InternalAnalyticsInstance;
+    }): Promise<void>;
+    pageStart(params: AbortableFnParams): unknown;
+    page({ payload }: EventFn): Promise<void>;
+    trackStart(params: AbortableFnParams): unknown;
+    track({ payload }: EventFn): Promise<void>;
+    identifyStart(params: AbortableFnParams): unknown;
+    identify({ payload }: EventFn): Promise<void>;
+    getComponentViewTrackingThreshold(): number;
+    protected onTrackExperience(properties: SanitizedElementSeenPayload): Promise<void>;
+    protected onTrackComponent(): Promise<void>;
+    [HAS_SEEN_STICKY_COMPONENT]: ({ payload }: EventFn) => Promise<void>;
+    setItemStart({ abort, payload }: {
+        abort: any;
+        payload: any;
+    }): any;
+    methods: {
+        reset: (...args: any[]) => Promise<void>;
+        debug: (...args: any[]) => Promise<void>;
+    };
+    private enqueueEvent;
+    private abortNonClientEvents;
+    private get instance();
+    flush: (args: void) => Promise<FlushResult>;
+    private _flush;
+}
+export {};

package/src/lib/{ninetailedCorePlugin → NinetailedCorePlugin}/index.d.ts

@@ -1,3 +1,3 @@
-export * from './ninetailedCorePlugin';
+export * from './NinetailedCorePlugin';
 export * from './constants';
 export * from './Events';

package/src/lib/constants.d.ts

@@ -1,5 +1,3 @@
-export declare const HAS_SEEN_COMPONENT = "has_seen_component";
-export declare const HAS_SEEN_ELEMENT = "has_seen_element";
 export declare const COMPONENT = "component";
 export declare const COMPONENT_START = "componentStart";
 export declare const PAGE_HIDDEN = "page_hidden";

package/src/lib/experience/makeExperienceSelectMiddleware.d.ts

@@ -1,5 +1,5 @@
 import { ExperienceConfiguration, Profile, Reference } from '@ninetailed/experience.js-shared';
-import { NinetailedPlugin } from '../types/NinetailedPlugin';
+import { NinetailedPlugin } from '@ninetailed/experience.js-plugin-analytics';
 import { ExperienceSelectionMiddleware, ExperienceSelectionMiddlewareArg } from '../types/interfaces/HasExperienceSelectionMiddleware';
 type MakeExperienceSelectMiddlewareArg<Baseline extends Reference, Variant extends Reference> = {
     plugins: NinetailedPlugin[];

package/src/lib/guards/hasComponentViewTrackingThreshold.d.ts

@@ -0,0 +1,3 @@
+import { NinetailedPlugin } from '@ninetailed/experience.js-plugin-analytics';
+import type { HasComponentViewTrackingThreshold } from '../types/interfaces/HasComponentViewTrackingThreshold';
+export declare const hasComponentViewTrackingThreshold: (arg: NinetailedPlugin) => arg is NinetailedPlugin & HasComponentViewTrackingThreshold;

package/src/lib/plugins/selectPluginsHavingExperienceSelectionMiddleware.d.ts

@@ -1,4 +1,4 @@
 import { Reference } from '@ninetailed/experience.js-shared';
+import { NinetailedPlugin } from '@ninetailed/experience.js-plugin-analytics';
 import { HasExperienceSelectionMiddleware } from '../types/interfaces/HasExperienceSelectionMiddleware';
-import { NinetailedPlugin } from '../types/NinetailedPlugin';
 export declare const selectPluginsHavingExperienceSelectionMiddleware: <Baseline extends Reference, Variant extends Reference>(plugins: NinetailedPlugin[]) => HasExperienceSelectionMiddleware<Baseline, Variant>[];

package/src/lib/plugins/selectPluginsHavingOnChangeEmitter.d.ts

@@ -1,3 +1,3 @@
-import { NinetailedPlugin } from '../types/NinetailedPlugin';
+import { NinetailedPlugin } from '@ninetailed/experience.js-plugin-analytics';
 import { HasOnChangeEmitter } from '../types/interfaces/HasOnChangeEmitter';
 export declare const selectPluginsHavingOnChangeEmitter: (plugins: NinetailedPlugin[]) => HasOnChangeEmitter[];

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

@@ -1,9 +1,7 @@
-import { Logger, PageviewProperties, Profile, Properties, Traits, SelectedVariantInfo, Reference, Event } from '@ninetailed/experience.js-shared';
 import { DetachListeners } from 'analytics';
-import { TrackComponentProperties } from './TrackingProperties';
-import { NinetailedPlugin } from './NinetailedPlugin';
+import { Logger, PageviewProperties, Profile, Properties, Traits, SelectedVariantInfo, Reference, Event } from '@ninetailed/experience.js-shared';
+import { ElementSeenPayload, NinetailedPlugin, TrackComponentProperties } from '@ninetailed/experience.js-plugin-analytics';
 import { type Ninetailed } from '../Ninetailed';
-import { ElementSeenPayload } from './ElementSeenPayload';
 import { OnSelectVariant } from './OnSelectVariant';
 import { EventBuilder } from '../utils/EventBuilder';
 type Loading = {
@@ -72,10 +70,6 @@ export interface NinetailedInstance<TBaseline extends Reference = Reference, TVa
     unobserveElement: UnObserveElement;
     onSelectVariant: OnSelectVariant<TBaseline, TVariant>;
 }
-export { NinetailedPlugin, TrackComponentProperties };
-export type { EventHandler } from './EventHandler';
 export type { AnalyticsInstance } from './AnalyticsInstance';
-export { ElementSeenPayloadSchema } from './ElementSeenPayload';
-export type { ElementSeenPayload } from './ElementSeenPayload';
 export type { ProfileChangedPayload } from './ProfileChangedPayload';
 export type { Credentials } from './Credentials';

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

@@ -0,0 +1,3 @@
+export interface HasComponentViewTrackingThreshold {
+    getComponentViewTrackingThreshold: () => number;
+}

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

@@ -1,5 +1,5 @@
 import { PAGE_HIDDEN } from '../../constants';
-import { EventHandler } from '../EventHandler';
+import { EventHandler } from '@ninetailed/experience.js-plugin-analytics';
 export interface InterestedInHiddenPage {
     [PAGE_HIDDEN]: EventHandler<void>;
 }

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

@@ -1,5 +1,5 @@
 import { PROFILE_CHANGE } from '@ninetailed/experience.js-shared';
-import { EventHandler } from '../EventHandler';
+import { EventHandler } from '@ninetailed/experience.js-plugin-analytics';
 import { ProfileChangedPayload } from '../ProfileChangedPayload';
 export interface InterestedInProfileChange {
     [PROFILE_CHANGE]: EventHandler<ProfileChangedPayload>;

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

@@ -1,6 +1,4 @@
-import { HAS_SEEN_ELEMENT } from '../../constants';
-import { ElementSeenPayload } from '../ElementSeenPayload';
-import { EventHandler } from '../EventHandler';
+import { EventHandler, ElementSeenPayload, HAS_SEEN_ELEMENT } from '@ninetailed/experience.js-plugin-analytics';
 export interface InterestedInSeenElements {
     [HAS_SEEN_ELEMENT]: EventHandler<ElementSeenPayload>;
 }

package/src/lib/ninetailedCorePlugin/ninetailedCorePlugin.d.ts

@@ -1,17 +0,0 @@
-import { Locale, NinetailedApiClient, NinetailedRequestContext } from '@ninetailed/experience.js-shared';
-import { NinetailedInstance, FlushResult, NinetailedPlugin } from '../types';
-export type OnInitProfileId = (profileId?: string) => Promise<string | undefined> | string | undefined;
-type AnalyticsPluginNinetailedConfig = {
-    apiClient: NinetailedApiClient;
-    locale?: Locale;
-    requestTimeout?: number;
-    onInitProfileId?: OnInitProfileId;
-    buildClientContext?: () => NinetailedRequestContext;
-    ninetailed: NinetailedInstance;
-};
-export declare const PLUGIN_NAME = "ninetailed";
-export interface NinetailedCorePlugin extends NinetailedPlugin {
-    flush: () => Promise<FlushResult>;
-}
-export declare const ninetailedCorePlugin: ({ apiClient, locale, ninetailed, onInitProfileId, buildClientContext, }: AnalyticsPluginNinetailedConfig) => NinetailedCorePlugin;
-export {};

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

@@ -1,82 +0,0 @@
-import { z } from 'zod';
-export declare const ElementSeenPayloadSchema: z.ZodObject<{
-    element: z.ZodAny;
-    experience: z.ZodNullable<z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        type: z.ZodUnion<[z.ZodLiteral<"nt_experiment">, z.ZodLiteral<"nt_personalization">]>;
-        name: z.ZodOptional<z.ZodString>;
-        description: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        type: "nt_experiment" | "nt_personalization";
-        name?: string | undefined;
-        description?: string | undefined;
-    }, {
-        id: string;
-        type: "nt_experiment" | "nt_personalization";
-        name?: string | undefined;
-        description?: string | undefined;
-    }>>>;
-    audience: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodOptional<z.ZodString>;
-        description: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        name?: string | undefined;
-        description?: string | undefined;
-    }, {
-        id: string;
-        name?: string | undefined;
-        description?: string | undefined;
-    }>>>>;
-    variant: z.ZodObject<{
-        id: z.ZodString;
-    }, "strip", z.ZodUnknown, z.objectOutputType<{
-        id: z.ZodString;
-    }, z.ZodUnknown, "strip">, z.objectInputType<{
-        id: z.ZodString;
-    }, z.ZodUnknown, "strip">>;
-    variantIndex: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    audience: {
-        id: string;
-        name?: string | undefined;
-        description?: string | undefined;
-    } | null;
-    variant: {
-        id: string;
-    } & {
-        [k: string]: unknown;
-    };
-    variantIndex: number;
-    element?: any;
-    experience?: {
-        id: string;
-        type: "nt_experiment" | "nt_personalization";
-        name?: string | undefined;
-        description?: string | undefined;
-    } | null | undefined;
-}, {
-    variant: {
-        id: string;
-    } & {
-        [k: string]: unknown;
-    };
-    variantIndex: number;
-    element?: any;
-    experience?: {
-        id: string;
-        type: "nt_experiment" | "nt_personalization";
-        name?: string | undefined;
-        description?: string | undefined;
-    } | null | undefined;
-    audience?: {
-        id: string;
-        name?: string | undefined;
-        description?: string | undefined;
-    } | null | undefined;
-}>;
-export type ElementSeenPayload = Omit<z.input<typeof ElementSeenPayloadSchema>, 'element'> & {
-    element: Element;
-};

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

@@ -1,6 +0,0 @@
-import { AnalyticsInstance } from './AnalyticsInstance';
-export type EventHandlerParams<T = unknown> = {
-    payload: T;
-    instance: AnalyticsInstance;
-};
-export type EventHandler<T = unknown> = (params: EventHandlerParams<T>) => void;

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

@@ -1,11 +0,0 @@
-import { AnalyticsPlugin } from 'analytics';
-import { AnalyticsInstance } from './AnalyticsInstance';
-export type EventHandlerParams<T = unknown> = {
-    payload: T;
-    instance: AnalyticsInstance;
-};
-export type EventHandler<T = unknown> = (params: EventHandlerParams<T>) => void;
-export declare abstract class NinetailedPlugin implements AnalyticsPlugin {
-    [x: string]: unknown;
-    abstract readonly name: string;
-}

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

@@ -1,35 +0,0 @@
-import { z } from 'zod';
-export declare const TrackComponentProperties: z.ZodObject<{
-    variant: z.ZodObject<{
-        id: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-    }, {
-        id: string;
-    }>;
-    audience: z.ZodObject<{
-        id: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-    }, {
-        id: string;
-    }>;
-    isPersonalized: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    variant: {
-        id: string;
-    };
-    audience: {
-        id: string;
-    };
-    isPersonalized: boolean;
-}, {
-    variant: {
-        id: string;
-    };
-    audience: {
-        id: string;
-    };
-    isPersonalized: boolean;
-}>;
-export type TrackComponentProperties = z.infer<typeof TrackComponentProperties>;