@ninetailed/experience.js-react 3.0.1-beta.3 → 3.0.2-beta.0

package/lib/Experience/ESRLoadingComponent.d.ts

@@ -1,5 +1,6 @@
-import React from 'react';
+import React, { PropsWithChildren } from 'react';
 import { ExperienceBaseProps } from './Experience';
+import { Reference } from '@ninetailed/experience.js';
 declare type ESRContextValue = {
     experienceVariantsMap: Record<string, number>;
 };
@@ -7,9 +8,9 @@ export declare const ESRContext: React.Context<ESRContextValue | undefined>;
 declare type ESRProviderProps = {
     experienceVariantsMap: Record<string, number>;
 };
-export declare const ESRProvider: React.FC<ESRProviderProps>;
+export declare const ESRProvider: React.FC<PropsWithChildren<ESRProviderProps>>;
 export declare const useESR: () => {
     experienceVariantsMap: Record<string, number>;
 };
-export declare const ESRLoadingComponent: <P extends Record<string, unknown>>({ experiences, component: Component, passthroughProps, ...baseline }: ExperienceBaseProps<P, Partial<P>>) => JSX.Element;
+export declare const ESRLoadingComponent: <P extends Record<string, unknown> & Reference>({ experiences, component: Component, passthroughProps, ...baseline }: ExperienceBaseProps<P, Partial<P>, Pick<P, Exclude<keyof P, keyof P>> & Reference>) => JSX.Element;
 export {};

package/lib/Experience/Experience.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { Baseline, ExperienceConfiguration } from '@ninetailed/experience.js';
+import { Baseline, ExperienceConfiguration, Reference } from '@ninetailed/experience.js';
 export declare type ExperienceComponent<P> = React.ComponentType<Omit<P, 'id'> & {
     ninetailed?: {
         isPersonalized: boolean;
@@ -8,20 +8,20 @@ export declare type ExperienceComponent<P> = React.ComponentType<Omit<P, 'id'> &
         };
     };
 }>;
-export declare type ExperienceBaseProps<P, PassThroughProps extends Partial<P>> = Baseline<Pick<P, Exclude<keyof P, keyof PassThroughProps>>> & {
-    experiences: ExperienceConfiguration[];
-    component: ExperienceComponent<P> | React.ComponentType<P>;
+export declare type ExperienceBaseProps<P, PassThroughProps extends Partial<P>, Variant extends Pick<P, Exclude<keyof P, keyof PassThroughProps>> & Reference> = Baseline<Pick<P, Exclude<keyof P, keyof PassThroughProps>>> & {
+    experiences: ExperienceConfiguration<Variant>[];
+    component: React.ComponentType<P>;
     passthroughProps?: PassThroughProps;
 };
-export declare type ExperienceLoadingComponent<P, PassThroughProps extends Partial<P>> = React.ComponentType<ExperienceBaseProps<P, PassThroughProps>>;
-export declare type ExperienceProps<P, PassThroughProps extends Partial<P>> = ExperienceBaseProps<P, PassThroughProps> & {
-    experiences: ExperienceConfiguration[];
-    component: ExperienceComponent<P> | React.ComponentType<P>;
-    loadingComponent?: ExperienceLoadingComponent<P, PassThroughProps>;
+export declare type ExperienceLoadingComponent<P, PassThroughProps extends Partial<P>, Variant extends Pick<P, Exclude<keyof P, keyof PassThroughProps>> & Reference> = React.ComponentType<ExperienceBaseProps<P, PassThroughProps, Variant>>;
+export declare type ExperienceProps<P, PassThroughProps extends Partial<P>, Variant extends Pick<P, Exclude<keyof P, keyof PassThroughProps>> & Reference> = ExperienceBaseProps<P, PassThroughProps, Variant> & {
+    experiences: ExperienceConfiguration<Variant>[];
+    component: React.ComponentType<P>;
+    loadingComponent?: ExperienceLoadingComponent<P, PassThroughProps, Variant>;
 };
-declare type DefaultExperienceLoadingComponentProps = ExperienceBaseProps<{}, {}> & {
+declare type DefaultExperienceLoadingComponentProps = ExperienceBaseProps<Record<string, unknown>, Record<string, unknown>, Record<string, unknown> & Reference> & {
     unhideAfterMs?: number;
 };
 export declare const DefaultExperienceLoadingComponent: React.FC<DefaultExperienceLoadingComponentProps>;
-export declare const Experience: <P extends Object, PassThroughProps extends Partial<P> = Partial<P>>({ experiences, component: Component, loadingComponent: LoadingComponent, passthroughProps, ...baseline }: ExperienceProps<P, PassThroughProps>) => JSX.Element;
+export declare const Experience: <P, PassThroughProps extends Partial<P> = Partial<P>, Variant extends Pick<P, Exclude<keyof P, keyof PassThroughProps>> & Reference = Pick<P, Exclude<keyof P, keyof PassThroughProps>> & Reference>({ experiences, component: Component, loadingComponent: LoadingComponent, passthroughProps, ...baseline }: ExperienceProps<P, PassThroughProps, Variant>) => JSX.Element;
 export {};

package/lib/Experience/ExperimentsContext.d.ts

@@ -1,6 +1,9 @@
-import { ExperienceConfiguration } from '@ninetailed/experience.js';
-declare type ExperimentsContextValue = {
-    experiments: ExperienceConfiguration[];
+/// <reference types="react" />
+import { ExperienceConfiguration, Reference } from '@ninetailed/experience.js';
+import { JoinExperiment } from './useProvideJoinExperiment';
+declare type ExperimentsContextValue<Variant extends Reference> = {
+    experiments: ExperienceConfiguration<Variant>[];
+    joinExperiment: JoinExperiment;
 };
-export declare const ExperimentsContext: import("react").Context<ExperimentsContextValue | undefined>;
+export declare const ExperimentsContext: import("react").Context<ExperimentsContextValue<any> | undefined>;
 export {};

package/lib/Experience/ExperimentsProvider.d.ts

@@ -1,7 +1,8 @@
-import React from 'react';
-import { ExperienceConfiguration } from '@ninetailed/experience.js';
-declare type ExperimentsProviderProps = {
-    experiments: ExperienceConfiguration[];
-};
-export declare const ExperimentsProvider: React.FC<ExperimentsProviderProps>;
+import React, { PropsWithChildren } from 'react';
+import { ExperienceConfiguration, Reference } from '@ninetailed/experience.js';
+declare type ExperimentsProviderProps<Variant extends Reference> = React.PropsWithChildren<{
+    experiments: ExperienceConfiguration<Variant>[];
+    maximumActiveExperiments?: number;
+}>;
+export declare const ExperimentsProvider: <Variant extends Reference>({ experiments, maximumActiveExperiments, children, }: React.PropsWithChildren<ExperimentsProviderProps<Variant>>) => JSX.Element;
 export {};

package/lib/Experience/TrackExperience.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { Profile } from '@ninetailed/experience.js-shared';
 import { ExperienceConfiguration } from '@ninetailed/experience.js';
 declare type TrackExperienceProps = {
-    experience: ExperienceConfiguration;
+    experience: ExperienceConfiguration<any>;
     variant: {
         id: string;
     };

package/lib/Experience/index.d.ts

@@ -1,3 +1,8 @@
 export { Experience, DefaultExperienceLoadingComponent } from './Experience';
-export type { ExperienceProps, ExperienceBaseProps, ExperienceComponent, ExperienceLoadingComponent } from './Experience';
+export type { ExperienceProps, ExperienceBaseProps, ExperienceComponent, ExperienceLoadingComponent, } from './Experience';
 export { ESRProvider, ESRLoadingComponent } from './ESRLoadingComponent';
+export { useExperience } from './useExperience';
+export { ExperimentsProvider } from './ExperimentsProvider';
+export { useExperiments } from './useExperiments';
+export { useJoinExperiment } from './useJoinExperiment';
+export { TrackExperience } from './TrackExperience';

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

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

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

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

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

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

package/lib/Experience/useExperiementsContext.d.ts

@@ -0,0 +1,4 @@
+export declare const useExperimentsContext: () => {
+    experiments: import("@ninetailed/experience.js").ExperienceConfiguration<any>[];
+    joinExperiment: import("./useProvideJoinExperiment").JoinExperiment;
+};

package/lib/Experience/useExperience.d.ts

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

package/lib/Experience/useExperiments.d.ts

@@ -1,3 +1,3 @@
 export declare const useExperiments: () => {
-    experiments: import("@ninetailed/experience.js").ExperienceConfiguration[];
+    experiments: import("@ninetailed/experience.js").ExperienceConfiguration<any>[];
 };

package/lib/Experience/useJoinExperiment.d.ts

@@ -1,10 +1 @@
-import { Profile, ExperienceConfiguration } 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 {};
+export declare const useJoinExperiment: () => import("./useProvideJoinExperiment").JoinExperiment;

package/lib/Experience/useProvideJoinExperiment.d.ts

@@ -0,0 +1,13 @@
+import { Profile, ExperienceConfiguration, Reference, VariantRef } from '@ninetailed/experience.js';
+export declare type JoinExperimentArgs = {
+    experiences: ExperienceConfiguration[];
+    experiment: ExperienceConfiguration<Reference | VariantRef>;
+    profile: Profile;
+};
+export declare type JoinExperiment = (args: JoinExperimentArgs) => Promise<void>;
+declare type UseJoinExperimentArgs = {
+    experiments: ExperienceConfiguration[];
+    maximumActiveExperiments?: number;
+};
+export declare const useProvideJoinExperiment: ({ experiments, maximumActiveExperiments, }: UseJoinExperimentArgs) => (data: JoinExperimentArgs) => Promise<void>;
+export {};

package/lib/NinetailedContext.d.ts

@@ -1,2 +1,3 @@
+/// <reference types="react" />
 import { NinetailedInstance } from '@ninetailed/experience.js';
 export declare const NinetailedContext: import("react").Context<NinetailedInstance | undefined>;

package/lib/NinetailedProvider.d.ts

@@ -5,7 +5,8 @@ import { Profile, Locale, OnErrorHandler, OnLogHandler } from '@ninetailed/exper
 export declare type NinetailedProviderProps = {
     clientId: string;
     environment?: string;
-    experiments?: ExperienceConfiguration[];
+    experiments?: ExperienceConfiguration<any>[];
+    maximumActiveExperiments?: number;
     preview?: boolean;
     url?: string;
     plugins?: (AnalyticsPlugin | AnalyticsPlugin[])[];
@@ -15,4 +16,4 @@ export declare type NinetailedProviderProps = {
     onLog?: OnLogHandler;
     onError?: OnErrorHandler;
 };
-export declare const NinetailedProvider: React.FC<React.PropsWithChildren<NinetailedProviderProps>>;
+export declare const NinetailedProvider: ({ children, clientId, experiments, maximumActiveExperiments, environment, preview, url, profile, locale, requestTimeout, plugins, onLog, onError, }: React.PropsWithChildren<NinetailedProviderProps>) => JSX.Element;

package/lib/Personalize.d.ts

@@ -19,5 +19,5 @@ declare type PersonalizeProps<P> = Baseline<P> & {
     loadingComponent?: React.ComponentType;
     holdout?: number;
 };
-export declare const Personalize: <P extends Object>({ component: Component, loadingComponent: LoadingComponent, variants, holdout, ...baseline }: PersonalizeProps<P>) => JSX.Element;
+export declare const Personalize: <P extends object>({ component: Component, loadingComponent: LoadingComponent, variants, holdout, ...baseline }: PersonalizeProps<P>) => JSX.Element;
 export {};

package/lib/index.d.ts

@@ -9,5 +9,5 @@ export { Personalize } from './Personalize';
 export type { PersonalizedComponent } from './Personalize';
 export { MergeTag } from './MergeTag';
 export { TrackHasSeenComponent } from './TrackHasSeenComponent';
-export { Experience, ESRProvider, ESRLoadingComponent, DefaultExperienceLoadingComponent } from './Experience';
+export { ExperimentsProvider, Experience, ESRProvider, ESRLoadingComponent, DefaultExperienceLoadingComponent, TrackExperience, useExperience, useExperiments, useJoinExperiment, } from './Experience';
 export type { ExperienceProps, ExperienceBaseProps, ExperienceComponent, ExperienceLoadingComponent, } from './Experience';

package/lib/useProfile.d.ts

@@ -12,7 +12,7 @@ export declare const useProfile: () => {
         id: string;
         random: number;
         audiences: string[];
-        traits: import("@ninetailed/experience.js-shared").Traits;
+        traits: import("@ninetailed/experience.js-shared").Properties;
         location: {
             coordinates?: {
                 latitude: number;
@@ -29,7 +29,7 @@ export declare const useProfile: () => {
         };
         session: {
             isReturningVisitor: boolean;
-            ladingPage: {
+            landingPage: {
                 path: string;
                 url: string;
                 query: Record<string, string>;

package/package.json

@@ -1,25 +1,20 @@
 {
   "name": "@ninetailed/experience.js-react",
-  "version": "3.0.1-beta.3",
+  "version": "3.0.2-beta.0",
   "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": "3.0.1-beta.3",
-    "@ninetailed/experience.js-shared": "3.0.1-beta.3",
-    "ts-toolbelt": "^9.6.0",
-    "diary": "^0.3.1",
-    "zod": "^3.18.0",
-    "locale-enum": "^1.1.1",
-    "i18n-iso-countries": "^7.3.0",
-    "analytics": "^0.8.0",
-    "murmurhash-js": "^1.0.0",
-    "react-intersection-observer": "^8.33.1"
+    "lodash": "4.17.21",
+    "@ninetailed/experience.js": "3.0.2-beta.0",
+    "react-intersection-observer": "8.34.0",
+    "@ninetailed/experience.js-shared": "3.0.2-beta.0",
+    "analytics": "0.8.1"
   },
-  "main": "./index.umd.js",
-  "module": "./index.esm.js",
-  "typings": "./index.d.ts"
+  "module": "./index.js",
+  "main": "./index.cjs",
+  "type": "module",
+  "types": "./index.d.ts"
 }