@ninetailed/experience.js 1.0.0-beta.0 → 1.0.0-beta.14

package/lib/Ninetailed.d.ts

@@ -1,10 +1,10 @@
 import { PageData, AnalyticsPlugin, DetachListeners } from 'analytics';
-import { Locale, Traits, Profile } from '@ninetailed/experience.js-shared';
+import { Locale, Traits, Profile, Variant } from '@ninetailed/experience.js-shared';
 import { ProfileState } from './types';
 declare type Options = {
     url?: string;
     locale?: Locale;
-    plugins?: AnalyticsPlugin[];
+    plugins?: (AnalyticsPlugin | AnalyticsPlugin[])[];
     profile?: Profile;
 };
 declare type EventFunctionOptions = {
@@ -16,6 +16,13 @@ declare type EventFunctionOptions = {
 declare type OnProfileChangeCallback = (profile: ProfileState) => void;
 export declare type Page = (data?: PageData, options?: EventFunctionOptions) => Promise<void>;
 export declare type Track = (event: string, payload?: unknown, options?: EventFunctionOptions) => Promise<void>;
+export declare type TrackHasSeenComponent = (payload: {
+    variant: Variant<unknown>;
+    audience: {
+        id: string;
+    };
+    isPersonalized: boolean;
+}) => Promise<void>;
 export declare type Identify = (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<void>;
 export declare type Reset = () => void;
 export declare type Debug = (enable: boolean) => void;
@@ -23,6 +30,7 @@ export declare type OnProfileChange = (cb: OnProfileChangeCallback) => DetachLis
 export interface NinetailedInstance {
     page: Page;
     track: Track;
+    trackHasSeenComponent: TrackHasSeenComponent;
     identify: Identify;
     reset: Reset;
     debug: Debug;
@@ -33,9 +41,13 @@ export declare class Ninetailed implements NinetailedInstance {
     private readonly instance;
     private readonly plugins;
     private _profileState;
-    constructor(apiKey: string, { plugins, url, profile, locale }: Options);
+    constructor({ clientId, environment }: {
+        clientId: string;
+        environment?: string;
+    }, { plugins, url, profile, locale }?: Options);
     page: (data?: PageData, options?: EventFunctionOptions) => Promise<any>;
     track: (event: string, payload?: unknown, options?: EventFunctionOptions) => Promise<any>;
+    trackHasSeenComponent: TrackHasSeenComponent;
     identify: (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<any>;
     reset: () => any;
     debug: (enabled: boolean) => any;

package/lib/analytics/get-analytics-plugin.d.ts

@@ -6,7 +6,8 @@ declare global {
     }
 }
 declare type AnalyticsPluginNinetailedConfig = {
-    apiKey: string;
+    clientId: string;
+    environment?: string;
     url?: string;
     profile?: Profile;
     locale?: Locale;
@@ -18,5 +19,5 @@ export declare const NINETAILED_TRACKER_EVENTS: {
     profile: string;
 };
 export declare const PLUGIN_NAME = "ninetailed";
-export declare const ninetailedPlugin: ({ apiKey, url, profile, locale, }: AnalyticsPluginNinetailedConfig) => AnalyticsPlugin;
+export declare const ninetailedPlugin: ({ clientId, environment, url, profile, locale, }: AnalyticsPluginNinetailedConfig) => AnalyticsPlugin;
 export {};

package/lib/analytics/utility/apiClient.d.ts

@@ -1,6 +1,7 @@
 import { AudienceSignals, IngestProfileEventsRequestBody, Profile, Session } from '@ninetailed/experience.js-shared';
 declare type NinetailedApiClientOptions = {
-    apiKey: string;
+    clientId: string;
+    environment: string;
     url?: string;
 };
 declare type ProfileOptions = IngestProfileEventsRequestBody;
@@ -11,9 +12,10 @@ declare type ProfileResponse = {
     sessions: Session[];
 };
 export declare class NinetailedApiClient {
-    private readonly apiKey;
+    private readonly clientId;
+    private readonly environment;
     private readonly url;
-    constructor({ apiKey, url }: NinetailedApiClientOptions);
+    constructor({ clientId, environment, url, }: NinetailedApiClientOptions);
     profile(options: ProfileOptions): Promise<ProfileResponse>;
 }
 export {};

package/lib/selectVariant.d.ts

@@ -1,10 +1,11 @@
-import { ProfileState, Variant } from './types';
+import { Variant } from '@ninetailed/experience.js-shared';
+import { ProfileState } from './types';
 declare type Options = {
     holdout?: number;
 };
 declare type Loading<T> = {
     loading: true;
-    variant: T;
+    variant: Variant<T>;
     audience: {
         id: 'baseline';
     };
@@ -13,7 +14,7 @@ declare type Loading<T> = {
 };
 declare type Success<T> = {
     loading: false;
-    variant: T;
+    variant: Variant<T>;
     audience: {
         id: string;
     };
@@ -22,7 +23,7 @@ declare type Success<T> = {
 };
 declare type Fail<T> = {
     loading: false;
-    variant: T;
+    variant: Variant<T>;
     audience: {
         id: 'baseline';
     };

package/lib/types.d.ts

@@ -1,9 +1,4 @@
 import { Profile } from "@ninetailed/experience.js-shared";
-export declare type Variant<P> = {
-    audience: {
-        id: string;
-    };
-} & P;
 export declare type ProfileState = {
     loading: boolean;
     profile?: Profile;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ninetailed/experience.js",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.14",
   "main": "./index.umd.js",
   "module": "./index.esm.js",
   "typings": "./index.d.ts",
   "dependencies": {
     "analytics": "^0.8.0",
-    "@ninetailed/experience.js-shared": "1.0.0-beta.0",
+    "@ninetailed/experience.js-shared": "1.0.0-beta.14",
     "uuid": "^8.3.2",
     "ts-toolbelt": "^9.6.0",
     "locale-enum": "^1.1.1",