@ninetailed/experience.js 1.0.0-beta.0

package/lib/Ninetailed.d.ts

@@ -0,0 +1,47 @@
+import { PageData, AnalyticsPlugin, DetachListeners } from 'analytics';
+import { Locale, Traits, Profile } from '@ninetailed/experience.js-shared';
+import { ProfileState } from './types';
+declare type Options = {
+    url?: string;
+    locale?: Locale;
+    plugins?: AnalyticsPlugin[];
+    profile?: Profile;
+};
+declare type EventFunctionOptions = {
+    plugins?: {
+        all: boolean;
+        [key: string]: boolean;
+    };
+};
+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 Identify = (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<void>;
+export declare type Reset = () => void;
+export declare type Debug = (enable: boolean) => void;
+export declare type OnProfileChange = (cb: OnProfileChangeCallback) => DetachListeners;
+export interface NinetailedInstance {
+    page: Page;
+    track: Track;
+    identify: Identify;
+    reset: Reset;
+    debug: Debug;
+    profileState: ProfileState;
+    onProfileChange: OnProfileChange;
+}
+export declare class Ninetailed implements NinetailedInstance {
+    private readonly instance;
+    private readonly plugins;
+    private _profileState;
+    constructor(apiKey: string, { plugins, url, profile, locale }: Options);
+    page: (data?: PageData, options?: EventFunctionOptions) => Promise<any>;
+    track: (event: string, payload?: unknown, options?: EventFunctionOptions) => Promise<any>;
+    identify: (uid: string, traits?: Traits, options?: EventFunctionOptions) => Promise<any>;
+    reset: () => any;
+    debug: (enabled: boolean) => any;
+    onProfileChange: (cb: OnProfileChangeCallback) => DetachListeners;
+    get profileState(): ProfileState;
+    private buildOptions;
+    private registerWindowHandlers;
+}
+export {};

package/lib/analytics/Cache/cache.d.ts

@@ -0,0 +1,11 @@
+import { AnalyticsInstance } from 'analytics';
+import { Cache } from '@ninetailed/experience.js-shared';
+declare type CacheOptions = {
+    instance: AnalyticsInstance;
+};
+export declare const initialize: ({ instance }: CacheOptions, data?: Partial<Cache>) => Cache;
+export declare const get: ({ instance }: CacheOptions) => Cache | null;
+export declare const set: (cache: Cache, { instance }: CacheOptions) => Cache;
+export declare const remove: ({ instance }: CacheOptions) => void;
+export declare const reset: ({ instance }: CacheOptions) => Cache;
+export {};

package/lib/analytics/Cache/index.d.ts

@@ -0,0 +1 @@
+export * from './cache';

package/lib/analytics/Events/build-context.d.ts

@@ -0,0 +1,2 @@
+import { NinetailedRequestContext } from '@ninetailed/experience.js-shared';
+export declare const buildClientNinetailedRequestContext: () => NinetailedRequestContext;

package/lib/analytics/Events/build-locale.d.ts

@@ -0,0 +1 @@
+export declare const buildClientLocale: () => string;

package/lib/analytics/Events/index.d.ts

@@ -0,0 +1 @@
+export * from './build-context';

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

@@ -0,0 +1,22 @@
+import { AnalyticsPlugin } from 'analytics';
+import { Profile, Locale } from '@ninetailed/experience.js-shared';
+declare global {
+    interface Window {
+        ninetailed?: any;
+    }
+}
+declare type AnalyticsPluginNinetailedConfig = {
+    apiKey: string;
+    url?: string;
+    profile?: Profile;
+    locale?: Locale;
+};
+export declare const NINETAILED_TRACKER_EVENTS: {
+    /**
+     * `profile` - Fires when the profile is returned by the cdp API.
+     */
+    profile: string;
+};
+export declare const PLUGIN_NAME = "ninetailed";
+export declare const ninetailedPlugin: ({ apiKey, url, profile, locale, }: AnalyticsPluginNinetailedConfig) => AnalyticsPlugin;
+export {};

package/lib/analytics/index.d.ts

@@ -0,0 +1 @@
+export * from './get-analytics-plugin';

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

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

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

@@ -0,0 +1,3 @@
+export declare const log: any;
+export declare const enable: () => void;
+export declare const disable: () => any;

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

@@ -0,0 +1,2 @@
+export * from './apiClient';
+export * from './debug';

package/lib/selectVariant.d.ts

@@ -0,0 +1,34 @@
+import { ProfileState, Variant } from './types';
+declare type Options = {
+    holdout?: number;
+};
+declare type Loading<T> = {
+    loading: true;
+    variant: T;
+    audience: {
+        id: 'baseline';
+    };
+    isPersonalized: false;
+    error: null;
+};
+declare type Success<T> = {
+    loading: false;
+    variant: T;
+    audience: {
+        id: string;
+    };
+    isPersonalized: boolean;
+    error: null;
+};
+declare type Fail<T> = {
+    loading: false;
+    variant: T;
+    audience: {
+        id: 'baseline';
+    };
+    isPersonalized: false;
+    error: Error;
+};
+declare type Result<T> = Loading<T> | Success<T> | Fail<T>;
+export declare const selectVariant: <T>(baseline: T, variants: Variant<T>[], { loading, profile, error }: ProfileState, options?: Options) => Result<T>;
+export {};

package/lib/types.d.ts

@@ -0,0 +1,12 @@
+import { Profile } from "@ninetailed/experience.js-shared";
+export declare type Variant<P> = {
+    audience: {
+        id: string;
+    };
+} & P;
+export declare type ProfileState = {
+    loading: boolean;
+    profile?: Profile;
+    error?: Error;
+    from: 'api' | 'hydrated';
+};

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@ninetailed/experience.js",
+  "version": "1.0.0-beta.0",
+  "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",
+    "uuid": "^8.3.2",
+    "ts-toolbelt": "^9.6.0",
+    "locale-enum": "^1.1.1",
+    "i18n-iso-countries": "^7.3.0",
+    "lodash": "^4.17.21"
+  },
+  "peerDependencies": {}
+}