@ninetailed/experience.js 4.3.0-beta.6 → 4.4.0-beta.2

package/lib/analytics/index.d.ts

@@ -1,3 +1,2 @@
 export * from './get-analytics-plugin';
 export * from './constants';
-export * from './Events';

package/lib/constants.d.ts

@@ -1,3 +1,2 @@
+export declare const HAS_SEEN_EXPERIENCE = "has_seen_experience";
 export declare const HAS_SEEN_COMPONENT = "has_seen_component";
-export declare const HAS_SEEN_ELEMENT = "has_seen_element";
-export declare const PAGE_HIDDEN = "page_hidden";

package/lib/experience/makeExperienceSelectMiddleware.d.ts

@@ -11,10 +11,9 @@ type MakeExperienceSelectMiddlewareArg<Variant extends Reference> = {
 export declare const makeExperienceSelectMiddleware: <Variant extends Reference>({ plugins, onChange, experiences, baseline, profile, }: MakeExperienceSelectMiddlewareArg<Variant>) => {
     addListeners: () => void;
     removeListeners: () => void;
-    middleware: ({ experience, variant, variantIndex, }: ExperienceSelectionMiddlewareReturnArg<Variant | VariantRef>) => {
+    middleware: ({ experience, variant, }: ExperienceSelectionMiddlewareReturnArg<Variant | VariantRef>) => {
         experience: ExperienceConfiguration<Variant | VariantRef> | null;
-        variant: Variant | VariantRef;
-        variantIndex: number;
+        variant: Variant | VariantRef | null;
     };
 };
 export {};

package/lib/types/TrackingProperties.d.ts

@@ -1,4 +1,83 @@
 import { z } from 'zod';
+export declare const TrackExperienceProperties: z.ZodObject<{
+    experience: z.ZodObject<{
+        id: z.ZodString;
+        type: z.ZodUnion<[z.ZodLiteral<"nt_experiment">, z.ZodLiteral<"nt_personalization">]>;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+        type: "nt_experiment" | "nt_personalization";
+        id: string;
+        name: string;
+    }, {
+        description?: string | undefined;
+        type: "nt_experiment" | "nt_personalization";
+        id: string;
+        name: string;
+    }>;
+    audience: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | undefined;
+        description?: string | undefined;
+        id: string;
+    }, {
+        name?: string | undefined;
+        description?: string | undefined;
+        id: string;
+    }>>>;
+    selectedVariant: z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodUnknown, {
+        [x: string]: unknown;
+        id: string;
+    }, {
+        [x: string]: unknown;
+        id: string;
+    }>;
+    selectedVariantIndex: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    experience: {
+        description?: string | undefined;
+        type: "nt_experiment" | "nt_personalization";
+        id: string;
+        name: string;
+    };
+    audience: {
+        name?: string | undefined;
+        description?: string | undefined;
+        id: string;
+    };
+    selectedVariant: {
+        [x: string]: unknown;
+        id: string;
+    };
+    selectedVariantIndex: number;
+}, {
+    audience?: {
+        name?: string | undefined;
+        description?: string | undefined;
+        id: string;
+    } | undefined;
+    experience: {
+        description?: string | undefined;
+        type: "nt_experiment" | "nt_personalization";
+        id: string;
+        name: string;
+    };
+    selectedVariant: {
+        [x: string]: unknown;
+        id: string;
+    };
+    selectedVariantIndex: number;
+}>;
+export type TrackExperienceProperties = z.input<typeof TrackExperienceProperties>;
+export type SanitizedTrackExperienceProperties = z.infer<typeof TrackExperienceProperties> & {
+    selectedVariantSelector: string;
+};
 export declare const TrackComponentProperties: z.ZodObject<{
     variant: z.ZodObject<{
         id: z.ZodString;
@@ -16,18 +95,18 @@ export declare const TrackComponentProperties: z.ZodObject<{
     }>;
     isPersonalized: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
-    variant: {
+    audience: {
         id: string;
     };
-    audience: {
+    variant: {
         id: string;
     };
     isPersonalized: boolean;
 }, {
-    variant: {
+    audience: {
         id: string;
     };
-    audience: {
+    variant: {
         id: string;
     };
     isPersonalized: boolean;

package/lib/types/index.d.ts

@@ -1,9 +1,7 @@
 import { Logger, PageviewProperties, Profile, Properties, Traits } from '@ninetailed/experience.js-shared';
 import { DetachListeners } from 'analytics';
-import { TrackComponentProperties } from './TrackingProperties';
+import { TrackExperienceProperties, TrackComponentProperties } from './TrackingProperties';
 import { NinetailedPlugin } from './NinetailedPlugin';
-import { type Ninetailed } from '../Ninetailed';
-import { ElementSeenPayload } from './ElementSeenPayload';
 type Loading = {
     status: 'loading';
     profile: null;
@@ -37,13 +35,11 @@ export type OnProfileChangeCallback = (profile: ProfileState) => void;
 export type Page = (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<FlushResult>;
 export type Track = (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<FlushResult>;
 export type TrackHasSeenComponent = (properties: TrackComponentProperties) => Promise<void>;
-export type TrackHasSeenExperience = (properties: ElementSeenPayload) => Promise<void>;
+export type TrackHasSeenExperience = (properties: TrackExperienceProperties) => Promise<void>;
 export type Identify = (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<FlushResult>;
 export type Reset = () => void;
 export type Debug = (enable: boolean) => void;
 export type OnProfileChange = (cb: OnProfileChangeCallback) => DetachListeners;
-type ObserveElement = Ninetailed['observeElement'];
-type UnObserveElement = Ninetailed['unobserveElement'];
 export interface NinetailedInstance {
     page: Page;
     track: Track;
@@ -57,13 +53,8 @@ export interface NinetailedInstance {
     plugins: NinetailedPlugin[];
     logger: Logger;
     onIsInitialized: OnIsInitialized;
-    observeElement: ObserveElement;
-    unobserveElement: UnObserveElement;
 }
-export { NinetailedPlugin, TrackComponentProperties };
+export { NinetailedPlugin, TrackExperienceProperties, 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';
+export type { SanitizedTrackExperienceProperties } from './TrackingProperties';

package/lib/types/interfaces/HasExperienceSelectionMiddleware.d.ts

@@ -1,8 +1,7 @@
 import { ExperienceConfiguration, Reference } from '@ninetailed/experience.js-shared';
 export type ExperienceSelectionMiddlewareReturnArg<Variant extends Reference> = {
     experience: ExperienceConfiguration<Variant> | null;
-    variant: Variant;
-    variantIndex: number;
+    variant: Variant | null;
 };
 type ExperienceSelectionMiddlewareReturn<Variant extends Reference> = (arg: ExperienceSelectionMiddlewareReturnArg<Variant>) => ExperienceSelectionMiddlewareReturnArg<Variant>;
 type ExperienceSelectionMiddlewareArg<Variant extends Reference> = {

package/package.json

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

package/lib/ElementSeenObserver.d.ts

@@ -1,16 +0,0 @@
-export type ElementSeenObserverOptions = {
-    onElementSeen: (element: Element) => void;
-};
-export type ObserveOptions = {
-    delay?: number;
-};
-export declare class ElementSeenObserver {
-    private _options;
-    private _intersectionObserver?;
-    private _elementDelays;
-    private _intersectionTimers;
-    constructor(_options: ElementSeenObserverOptions);
-    private onIntersection;
-    observe(element: Element, options?: ObserveOptions): void;
-    unobserve(element: Element): void;
-}

package/lib/guards/acceptsCredentials.d.ts

@@ -1,2 +0,0 @@
-import { AcceptsCredentials } from '../types/interfaces/AcceptsCredentials';
-export declare const acceptsCredentials: (plugin: unknown) => plugin is AcceptsCredentials;

package/lib/guards/isInterestedInHiddenPage.d.ts

@@ -1,2 +0,0 @@
-import { InterestedInHiddenPage } from '../types/interfaces/InterestedInHiddenPage';
-export declare const isInterestedInHiddenPage: (arg: unknown) => arg is InterestedInHiddenPage;

package/lib/guards/isInterestedInSeenElements.d.ts

@@ -1,2 +0,0 @@
-import { InterestedInSeenElements } from '../types/interfaces/InterestedInSeenElements';
-export declare const isInterestedInSeenElements: (arg: unknown) => arg is InterestedInSeenElements;

package/lib/types/Credentials.d.ts

@@ -1,4 +0,0 @@
-export type Credentials = {
-    clientId: string;
-    environment: string;
-};

package/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/lib/types/ProfileChangedPayload.d.ts

@@ -1,4 +0,0 @@
-import { type Profile } from '@ninetailed/experience.js-shared';
-export type ProfileChangedPayload = {
-    profile: Profile;
-};

package/lib/types/interfaces/AcceptsCredentials.d.ts

@@ -1,4 +0,0 @@
-import { type Credentials } from '../Credentials';
-export interface AcceptsCredentials {
-    setCredentials(credentials: Credentials): void;
-}

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

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

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

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

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

@@ -1,6 +0,0 @@
-import { HAS_SEEN_ELEMENT } from '../../constants';
-import { ElementSeenPayload } from '../ElementSeenPayload';
-import { EventHandler } from '../EventHandler';
-export interface InterestedInSeenElements {
-    [HAS_SEEN_ELEMENT]: EventHandler<ElementSeenPayload>;
-}