@ninetailed/experience.js 6.4.1 → 7.1.0-beta.0

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, 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 {
@@ -12,15 +12,24 @@ declare global {
         } & unknown;
     }
 }
+type GetItem<T = any> = (key: string) => T;
+type SetItem<T = any> = (key: string, value: T) => void;
+type RemoveItem = (key: string) => void;
+export type Storage = {
+    getItem: GetItem;
+    setItem: SetItem;
+    removeItem: RemoveItem;
+};
 type Options = {
     url?: string;
     locale?: Locale;
     plugins?: (NinetailedPlugin | NinetailedPlugin[])[];
-    profile?: Profile;
     requestTimeout?: number;
     onLog?: OnLogHandler;
     onError?: OnErrorHandler;
     componentViewTrackingThreshold?: number;
+    buildClientContext?: () => NinetailedRequestContext;
+    storageImpl?: Storage;
 };
 type NinetailedApiClientInstanceOrOptions = NinetailedApiClient | NinetailedApiClientOptions;
 export declare class Ninetailed implements NinetailedInstance {
@@ -36,7 +45,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, locale, requestTimeout, onLog, onError, buildClientContext, componentViewTrackingThreshold, storageImpl, }?: 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/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/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/lib/selectVariant.d.ts

@@ -33,5 +33,5 @@ type Fail<T> = {
 type Result<T> = Loading<T> | Success<T> | Fail<T>;
 export declare const selectVariant: <T extends {
     id: string;
-}>(baseline: T, variants: Variant<T>[], { status, profile, error }: ProfileState, options?: Options) => Result<T>;
+}>(baseline: T, variants: Variant<T>[], { status, profile, error }: Omit<ProfileState, 'experiences'>, options?: Options) => Result<T>;
 export {};

package/lib/types/index.d.ts

@@ -1,4 +1,4 @@
-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 { TrackComponentProperties } from './TrackingProperties';
 import { NinetailedPlugin } from './NinetailedPlugin';
@@ -7,16 +7,19 @@ import { ElementSeenPayload } from './ElementSeenPayload';
 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 = {

package/package.json

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