@ninetailed/experience.js 4.3.0-beta.3 → 5.0.0-beta.3

package/lib/Ninetailed.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="analytics" />
-import { Locale, Traits, Profile, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions } from '@ninetailed/experience.js-shared';
-import { EventFunctionOptions, NinetailedInstance, NinetailedPlugin, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackHasSeenExperience, ElementSeenPayload } from './types';
-import { ObserveOptions } from './ElementSeenObserver';
+import { Locale, Traits, OnLogHandler, OnErrorHandler, Logger, PageviewProperties, Properties, NinetailedApiClient, NinetailedApiClientOptions } from '@ninetailed/experience.js-shared';
+import { EventFunctionOptions, NinetailedInstance, NinetailedPlugin, OnIsInitializedCallback, OnProfileChangeCallback, ProfileState, TrackHasSeenComponent, TrackHasSeenExperience } from './types';
 declare global {
     interface Window {
         ninetailed?: {
@@ -16,7 +15,6 @@ type Options = {
     url?: string;
     locale?: Locale;
     plugins?: (NinetailedPlugin | NinetailedPlugin[])[];
-    profile?: Profile;
     requestTimeout?: number;
     onLog?: OnLogHandler;
     onError?: OnErrorHandler;
@@ -28,20 +26,15 @@ export declare class Ninetailed implements NinetailedInstance {
     private isInitialized;
     private readonly apiClient;
     private readonly eventQueue;
-    private readonly elementSeenObserver;
-    private readonly observedElements;
     private readonly clientId;
     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, locale, requestTimeout, onLog, onError }?: Options);
     page: (data?: Partial<PageviewProperties>, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     track: (event: string, properties?: Properties, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     trackHasSeenComponent: TrackHasSeenComponent;
     trackHasSeenExperience: TrackHasSeenExperience;
-    observeElement: (payload: ElementSeenPayload, options?: ObserveOptions) => void;
-    unobserveElement: (element: Element) => void;
-    private onElementSeen;
     identify: (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<import("./types").FlushResult>;
     reset: () => Promise<void>;
     debug: (enabled: boolean) => Promise<void>;
@@ -51,6 +44,5 @@ export declare class Ninetailed implements NinetailedInstance {
     get profileState(): ProfileState;
     private buildOptions;
     private registerWindowHandlers;
-    private onVisibilityChange;
 }
 export {};

package/lib/analytics/constants.d.ts

@@ -2,6 +2,7 @@ export declare const LEGACY_ANONYMOUS_ID = "__anon_id";
 export declare const ANONYMOUS_ID = "__nt_anonymous_id__";
 export declare const DEBUG_FLAG = "__nt_debug__";
 export declare const PROFILE_FALLBACK_CACHE = "__nt_profile__";
+export declare const EXPERIENCES_FALLBACK_CACHE = "__nt_experiences__";
 export declare const PROFILE_CHANGE = "profile-change";
 export declare const PROFILE_RESET = "profile-reset";
 export declare const CONSENT = "__nt-consent__";

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,4 +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/index.d.ts

@@ -1,4 +1,4 @@
 export * from './types';
-export { EXPERIENCE_TRAIT_PREFIX, selectDistribution, isExperienceMatch, selectVariant as selectExperienceVariant, selectHasVariants as selectHasExperienceVariants, selectVariants as selectExperienceVariants, selectBaselineWithVariants as selectExperienceBaselineWithVariants, selectExperience, selectEligibleExperiences, selectActiveExperiments, } from '@ninetailed/experience.js-shared';
+export { EXPERIENCE_TRAIT_PREFIX, selectDistribution, isExperienceMatch, selectVariantClientSide as selectExperienceVariantClientSide, selectHasVariants as selectHasExperienceVariants, selectVariants as selectExperienceVariants, selectBaselineWithVariants as selectExperienceBaselineWithVariants, selectExperience, selectEligibleExperiences, selectActiveExperiments, } from '@ninetailed/experience.js-shared';
 export { decodeExperienceVariantsMap } from './decodeExperienceVariantsMap';
 export { makeExperienceSelectMiddleware } from './makeExperienceSelectMiddleware';

package/lib/types/TrackingProperties.d.ts

@@ -6,73 +6,73 @@ export declare const TrackExperienceProperties: z.ZodObject<{
         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;
     }, {
+        description?: string | undefined;
         type: "nt_experiment" | "nt_personalization";
         id: string;
         name: string;
-        description?: string | undefined;
     }>;
     audience: z.ZodDefault<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;
+        id: string;
     }>>>;
     selectedVariant: z.ZodObject<{
         id: z.ZodString;
-    }, "strip", z.ZodUnknown, z.objectOutputType<{
-        id: z.ZodString;
-    }, z.ZodUnknown, "strip">, z.objectInputType<{
-        id: z.ZodString;
-    }, z.ZodUnknown, "strip">>;
+    }, "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;
-        description?: string | undefined;
     };
     audience: {
-        id: string;
         name?: string | undefined;
         description?: string | undefined;
+        id: string;
     };
     selectedVariant: {
+        [x: string]: unknown;
         id: string;
-    } & {
-        [k: string]: unknown;
     };
     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;
-        description?: string | undefined;
     };
     selectedVariant: {
+        [x: string]: unknown;
         id: string;
-    } & {
-        [k: string]: unknown;
     };
     selectedVariantIndex: number;
-    audience?: {
-        id: string;
-        name?: string | undefined;
-        description?: string | undefined;
-    } | undefined;
 }>;
 export type TrackExperienceProperties = z.input<typeof TrackExperienceProperties>;
 export type SanitizedTrackExperienceProperties = z.infer<typeof TrackExperienceProperties> & {

package/lib/types/index.d.ts

@@ -1,21 +1,23 @@
-import { Logger, PageviewProperties, Profile, Properties, Traits } from '@ninetailed/experience.js-shared';
+import { Logger, PageviewProperties, Profile, Properties, Traits, SelectedVariantInfo } from '@ninetailed/experience.js-shared';
 import { DetachListeners } from 'analytics';
 import { TrackExperienceProperties, TrackComponentProperties } from './TrackingProperties';
 import { NinetailedPlugin } from './NinetailedPlugin';
-import { type Ninetailed } from '../Ninetailed';
 type Loading = {
     status: 'loading';
     profile: null;
+    experiences: null;
     error: null;
 };
 type Success = {
     status: 'success';
     profile: Profile;
+    experiences: SelectedVariantInfo[];
     error: null;
 };
 type Fail = {
     status: 'error';
     profile: null;
+    experiences: null;
     error: Error;
 };
 export type ProfileState = {
@@ -41,8 +43,6 @@ export type Identify = (uid: string, traits?: Traits, options?: EventFunctionOpt
 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;
@@ -56,13 +56,8 @@ export interface NinetailedInstance {
     plugins: NinetailedPlugin[];
     logger: Logger;
     onIsInitialized: OnIsInitialized;
-    observeElement: ObserveElement;
-    unobserveElement: UnObserveElement;
 }
 export { NinetailedPlugin, TrackExperienceProperties, TrackComponentProperties, };
 export type { EventHandler } from './EventHandler';
 export type { AnalyticsInstance } from './AnalyticsInstance';
 export type { SanitizedTrackExperienceProperties } from './TrackingProperties';
-export type { ElementSeenPayload } from './ElementSeenPayload';
-export type { ProfileChangedPayload } from './ProfileChangedPayload';
-export type { Credentials } from './Credentials';

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "4.3.0-beta.3",
+  "version": "5.0.0-beta.3",
   "module": "./index.js",
   "main": "./index.cjs",
   "type": "module",
   "types": "./index.d.ts",
   "dependencies": {
-    "@ninetailed/experience.js-shared": "4.3.0-beta.3",
+    "@ninetailed/experience.js-shared": "5.0.0-beta.3",
     "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,7 +0,0 @@
-export type ElementSeenPayload = {
-    element: Element;
-    experienceId?: string;
-    baselineId?: string;
-    variantId?: string;
-    audienceId?: string;
-};

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>;
-}