@ninetailed/experience.js-react 1.8.1 → 2.0.0-beta.2

package/lib/Experience/Experience.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+import { Baseline, ExperienceConfiguration } from '@ninetailed/experience.js';
+declare type ExperienceComponent<P extends Baseline> = React.ComponentType<Omit<P, 'id'> & {
+    ninetailed?: {
+        isPersonalized: boolean;
+        audience: {
+            id: string;
+        };
+    };
+}>;
+declare type ExperienceProps<P extends Baseline> = P & {
+    experiences: ExperienceConfiguration[];
+    component: ExperienceComponent<P> | React.ComponentType<P>;
+    loadingComponent?: React.ComponentType;
+};
+export declare const Experience: <P extends {
+    id: string;
+}>({ experiences, component: Component, loadingComponent: LoadingComponent, ...baseline }: ExperienceProps<P>) => JSX.Element;
+export {};

package/lib/Experience/ExperimentsContext.d.ts

@@ -0,0 +1,6 @@
+import { ExperienceConfiguration } from './types';
+declare type ExperimentsContextValue = {
+    experiments: ExperienceConfiguration[];
+};
+export declare const ExperimentsContext: import("react").Context<ExperimentsContextValue | undefined>;
+export {};

package/lib/Experience/ExperimentsProvider.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { ExperienceConfiguration } from './types';
+declare type ExperimentsProviderProps = {
+    experiments: ExperienceConfiguration[];
+};
+export declare const ExperimentsProvider: React.FC<ExperimentsProviderProps>;
+export {};

package/lib/Experience/constants.d.ts

@@ -0,0 +1 @@
+export declare const EXPERIENCE_TRAIT_PREFIX = "nt_experiment_";

package/lib/Experience/index.d.ts

@@ -0,0 +1 @@
+export { Experience } from './Experience';

package/lib/Experience/types/Baseline.d.ts

@@ -0,0 +1,3 @@
+export declare type Baseline<P extends Object = Object> = P & {
+    id: string;
+};

package/lib/Experience/types/BaselineWithVariants.d.ts

@@ -0,0 +1,6 @@
+import { Baseline } from './Baseline';
+import { Variant } from './Variant';
+export declare type BaselineWithVariants = {
+    baseline: Baseline<{}>;
+    variants: Variant<{}>[];
+};

package/lib/Experience/types/Variant.d.ts

@@ -0,0 +1,4 @@
+export declare type Variant<P> = P & {
+    id: string;
+    hidden: boolean;
+};

package/lib/Experience/types/index.d.ts

@@ -0,0 +1,4 @@
+export type { Baseline } from './Baseline';
+export type { Variant } from './Variant';
+export type { BaselineWithVariants } from './BaselineWithVariants';
+export type { ExperienceConfiguration } from './ExperienceConfiguration';

package/lib/Experience/useExperience.d.ts

@@ -0,0 +1,46 @@
+import { Baseline, Variant, ExperienceConfiguration, Profile } from '@ninetailed/experience.js';
+declare type Load = {
+    status: 'loading';
+    loading: boolean;
+    hasVariants: boolean;
+    baseline: Baseline;
+    experience: null;
+    variant: null;
+    audience: null;
+    isPersonalized: boolean;
+    profile: null;
+    error: null;
+};
+declare type Success = {
+    status: 'success';
+    loading: boolean;
+    hasVariants: boolean;
+    baseline: Baseline;
+    experience: ExperienceConfiguration | null;
+    variant: Variant | null;
+    audience: {
+        id: string;
+    } | null;
+    isPersonalized: boolean;
+    profile: Profile;
+    error: null;
+};
+declare type Fail = {
+    status: 'error';
+    loading: boolean;
+    hasVariants: boolean;
+    baseline: Baseline;
+    experience: null;
+    variant: null;
+    audience: null;
+    isPersonalized: boolean;
+    profile: null;
+    error: Error;
+};
+declare type UseExperienceArgs = {
+    baseline: Baseline;
+    experiences: ExperienceConfiguration[];
+};
+declare type UseExperienceResponse = Load | Success | Fail;
+export declare const useExperience: ({ baseline, experiences, }: UseExperienceArgs) => UseExperienceResponse;
+export {};

package/lib/Experience/useExperiments.d.ts

@@ -0,0 +1,3 @@
+export declare const useExperiements: () => {
+    experiments: ExperienceConfiguration[];
+};

package/lib/Experience/useJoinExperiment.d.ts

@@ -0,0 +1,11 @@
+import { ExperienceConfiguration } from './types';
+import { Profile } from '@ninetailed/experience.js';
+declare type UseJoinExperimentArgs = {
+    experiences: ExperienceConfiguration[];
+};
+declare type JoinExperimentArgs = {
+    experiment: ExperienceConfiguration;
+    profile: Profile;
+};
+export declare const useJoinExperiment: ({ experiences }: UseJoinExperimentArgs) => ({ experiment, profile }: JoinExperimentArgs) => void;
+export {};

package/lib/Experience/useSelectActiveExperiments.d.ts

@@ -0,0 +1,9 @@
+export declare const useSelectActiveExperiments: () => {
+    loading: boolean;
+    experiments: never[];
+    error: Error;
+} | {
+    loading: boolean;
+    experiments: ExperienceConfiguration[];
+    error: undefined;
+};

package/lib/Experience/useSelectExperience.d.ts

@@ -0,0 +1,10 @@
+import { ExperienceConfiguration } from './types';
+export declare const useSelectExperience: (experiences: ExperienceConfiguration[]) => {
+    loading: boolean;
+    experience: undefined;
+    error: Error;
+} | {
+    loading: boolean;
+    experience: any;
+    error: undefined;
+};

package/lib/Experience/useSelectVariant.d.ts

@@ -0,0 +1,22 @@
+import { Baseline, ExperienceConfiguration, Variant } from './types';
+declare type Loading<T> = {
+    loading: true;
+    variant?: never;
+    experience?: never;
+    error: null;
+};
+declare type Success<T> = {
+    loading: false;
+    variant: Variant<T>;
+    experience: ExperienceConfiguration | undefined;
+    error: null;
+};
+declare type Fail<T> = {
+    loading: false;
+    variant?: never;
+    experience?: never;
+    error: Error;
+};
+declare type SelectVariantResult<T> = Loading<T> | Success<T> | Fail<T>;
+export declare const useSelectVariant: <T extends Baseline<Object>>(experiences: ExperienceConfiguration[], baseline: T) => SelectVariantResult<T>;
+export {};

package/lib/NinetailedProvider.d.ts

@@ -1,9 +1,11 @@
 import React from 'react';
 import { AnalyticsPlugin } from 'analytics';
 import { Profile, Locale } from '@ninetailed/experience.js-shared';
+import { ExperienceConfiguration } from './Experience/types';
 export declare type NinetailedProviderProps = {
     clientId: string;
     environment?: string;
+    experiments?: ExperienceConfiguration[];
     preview?: boolean;
     url?: string;
     plugins?: (AnalyticsPlugin | AnalyticsPlugin[])[];

package/lib/TrackHasSeenComponent.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { Variant } from './Variant';
 declare type TrackHasSeenComponentProps = {
-    variant: Variant;
+    variant: Variant<any>;
     audience: {
         id: string;
     };

package/lib/Variant.d.ts

@@ -1,6 +1,6 @@
-export declare type Variant<P = unknown> = {
+export declare type Variant<P = unknown> = P & {
     id: string;
     audience: {
         id: string;
     };
-} & P;
+};

package/lib/index.d.ts

@@ -8,3 +8,4 @@ export { Personalize } from './Personalize';
 export type { PersonalizedComponent } from './Personalize';
 export { MergeTag } from './MergeTag';
 export { TrackHasSeenComponent } from './TrackHasSeenComponent';
+export { Experience } from './Experience';

package/lib/useProfile.d.ts

@@ -1,2 +1,19 @@
-import { ProfileState } from '@ninetailed/experience.js';
-export declare const useProfile: () => ProfileState;
+export declare const useProfile: () => {
+    loading: boolean;
+    from: "api" | "hydrated";
+    status: "loading";
+    profile: null;
+    error: null;
+} | {
+    loading: boolean;
+    from: "api" | "hydrated";
+    status: "success";
+    profile: import("@ninetailed/experience.js").Profile;
+    error: null;
+} | {
+    loading: boolean;
+    from: "api" | "hydrated";
+    status: "error";
+    profile: null;
+    error: Error;
+};

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@ninetailed/experience.js-react",
-  "version": "1.8.1",
+  "version": "2.0.0-beta.2",
   "peerDependencies": {
     "react": ">=16.8.0"
   },
   "dependencies": {
     "@analytics/google-analytics": "0.5.3",
     "react-visibility-sensor": "5.1.1",
-    "lodash": "^4.17.21",
-    "@ninetailed/experience.js": "1.8.1",
+    "@ninetailed/experience.js": "2.0.0-beta.2",
     "analytics": "^0.8.0",
-    "@ninetailed/experience.js-shared": "1.8.1",
+    "@ninetailed/experience.js-shared": "2.0.0-beta.2",
     "uuid": "^8.3.2",
     "ts-toolbelt": "^9.6.0",
     "locale-enum": "^1.1.1",
     "i18n-iso-countries": "^7.3.0",
+    "lodash": "^4.17.21",
     "react-intersection-observer": "^8.33.1"
   },
   "main": "./index.umd.js",