@flagship.io/react-sdk 2.2.0-beta.3 → 3.0.0

package/dist/types/Flag.d.ts

@@ -0,0 +1,9 @@
+import { IFlag, IFlagMetadata } from '@flagship.io/js-sdk';
+export declare class Flag<T> implements IFlag<T> {
+    private _defaultValue;
+    constructor(defaultValue: T);
+    getValue(): T;
+    exists(): boolean;
+    userExposed(): Promise<void>;
+    get metadata(): IFlagMetadata;
+}

package/dist/types/FlagshipContext.d.ts

@@ -1,6 +1,5 @@
 import React, { ReactNode, Dispatch, SetStateAction } from 'react';
-import { BucketingDTO, CampaignDTO, IFlagshipConfig, Modification, Visitor } from '@flagship.io/js-sdk';
-export declare type primitive = string | number | boolean;
+import { BucketingDTO, CampaignDTO, FlagDTO, IFlagshipConfig, primitive, Visitor } from '@flagship.io/js-sdk';
 export interface FsStatus {
     /**
      * Boolean. When true, the SDK is still not ready to render your App otherwise it'll use default modifications.
@@ -16,8 +15,8 @@ export interface FsStatus {
      */
     isVisitorDefined?: boolean;
     /**
-    * String or null. The last update date occurred on the flagship visitor instance.
-    */
+     * String or null. The last update date occurred on the flagship visitor instance.
+     */
     lastRefresh?: string;
     /**
      * String or null. When null no initialization succeed yet. When string contains stringified date of last successful initialization.
@@ -27,30 +26,34 @@ export interface FsStatus {
 export interface FsState {
     visitor?: Visitor;
     config?: IFlagshipConfig;
-    modifications?: Map<string, Modification>;
+    modifications?: Map<string, FlagDTO>;
     status: FsStatus;
     initialCampaigns?: CampaignDTO[];
-    initialModifications?: Map<string, Modification> | Modification[];
+    initialModifications?: Map<string, FlagDTO> | FlagDTO[];
 }
 interface FsContext {
     state: FsState;
     setState?: Dispatch<SetStateAction<FsState>>;
 }
 interface FlagshipProviderProps extends IFlagshipConfig {
+    /**
+     * This is the data to identify the current visitor using your app
+     */
     visitorData: {
-        id: string;
+        id?: string;
         context?: Record<string, primitive>;
         isAuthenticated?: boolean;
         hasConsented?: boolean;
     };
     envId: string;
     apiKey: string;
-    loadingComponent?: ReactNode;
-    children?: ReactNode;
     /**
-     * If value is other than production , it will also display Debug logs.
+     * This component will be rendered when Flagship is loading at first initialization only.
+     * By default, the value is undefined. It means it will display your app and it might
+     * display default modifications value for a very short moment.
      */
-    nodeEnv?: string;
+    loadingComponent?: ReactNode;
+    children?: ReactNode;
     /**
      * Callback function called when the SDK starts initialization.
      */
@@ -63,16 +66,29 @@ interface FlagshipProviderProps extends IFlagshipConfig {
      * Callback function called when the SDK is updated. For example, after a synchronize is triggered or visitor context has changed.
      */
     onUpdate?(params: {
-        fsModifications: Map<string, Modification>;
+        fsModifications: Map<string, FlagDTO>;
         config: IFlagshipConfig;
         status: FsStatus;
     }): void;
+    /**
+     * This is an object of the data received when fetching bucketing endpoint.
+     * Providing this prop will make bucketing ready to use and the first polling will immediatly check for an update.
+     * If the shape of an element is not correct, an error log will give the reason why.
+     */
     initialBucketing?: BucketingDTO;
     initialCampaigns?: CampaignDTO[];
-    initialModifications?: Map<string, Modification> | Modification[];
     /**
- * If true, it'll automatically call synchronizeModifications when the bucketing file has updated
- */
+     * This is a set of flag data provided to avoid the SDK to have an empty cache during the first initialization.
+     * @deprecated use initialFlagsData instead
+     */
+    initialModifications?: Map<string, FlagDTO> | FlagDTO[];
+    /**
+     * This is a set of flag data provided to avoid the SDK to have an empty cache during the first initialization.
+     */
+    initialFlagsData?: Map<string, FlagDTO> | FlagDTO[];
+    /**
+     * If true, it'll automatically call synchronizeModifications when the bucketing file has updated
+     */
     synchronizeOnBucketingUpdated?: boolean;
 }
 export declare const FlagshipContext: React.Context<FsContext>;

package/dist/types/FlagshipHooks.d.ts

@@ -1,11 +1,13 @@
-import { HitAbstract, IHit, Modification, modificationsRequested, primitive } from '@flagship.io/js-sdk';
+import { FlagDTO, HitAbstract, HitShape, IFlag, IHit, Modification, modificationsRequested, primitive } from '@flagship.io/js-sdk';
 import { FsStatus } from './FlagshipContext';
 /**
  * Retrieve a modification value by its key. If no modification match the given key or if the stored value type and default value type do not match, default value will be returned.
+ * @deprecated use useFsGetFlag instead
  */
 export declare const useFsModifications: <T extends unknown>(params: modificationsRequested<T>[], activateAll?: boolean | undefined) => Record<string, T>;
 /**
  * Retrieve a modification value by its key. If no modification match the given key or if the stored value type and default value type do not match, default value will be returned.
+ * @deprecated use useFsGetFlag instead
  */
 export declare const useFsModification: {
     <T>(params: modificationsRequested<T>): T;
@@ -13,17 +15,22 @@ export declare const useFsModification: {
 /**
  * Get the campaign modification information value matching the given key.
  * @param {string} key key which identify the modification.
+ * @deprecated use useFsGetFlag instead
  */
 export declare const useFsModificationInfo: {
     (key: string): Modification | null;
 };
 /**
- * This function calls the decision api and update all the campaigns modifications from the server according to the visitor context.
-*/
-export declare const useFsSynchronizeModifications: () => Promise<void>;
+ * This hook returns a flag object by its key. If no flag match the given key an empty flag will be returned.
+ * @param key
+ * @param defaultValue
+ * @returns
+ */
+export declare const useFsFlag: <T extends unknown>(key: string, defaultValue: T) => IFlag<T>;
 /**
  * Report this user has seen this modification. Report this user has seen these modifications.
  * @param params
+ * @deprecated use useFsGetFlag instead
  * @returns
  */
 export declare const useFsActivate: {
@@ -39,11 +46,38 @@ export declare type UseFlagshipParams<T> = {
     };
 };
 export declare type UseFlagshipOutput = {
+    visitorId?: string;
+    anonymousId?: string | null;
+    context?: Record<string, primitive>;
+    hasConsented?: boolean;
+    /**
+     * Set if visitor has consented for protected data usage.
+     * @param hasConsented  True if the visitor has consented false otherwise.
+     */
+    setConsent: (hasConsented: boolean) => void;
     modifications: Modification[];
+    FlagsData: FlagDTO[];
     status: FsStatus;
+    /**
+     *
+     * @param params
+     * @param activateAll
+     * @deprecated use useFsGetFlag instead
+     */
     getModifications<T>(params: modificationsRequested<T>[], activateAll?: boolean): Record<string, T>;
+    /**
+     *
+     * @param key
+     * @deprecated use useFsGetFlag instead
+     */
     getModificationInfo(key: string): Modification | null;
+    /**
+     * @deprecated use useFsFetchFlags instead
+     */
     synchronizeModifications(): Promise<void>;
+    /**
+     * @deprecated use useFsGetFlag instead
+     */
     activateModification: {
         (keys: {
             key: string;
@@ -51,37 +85,46 @@ export declare type UseFlagshipOutput = {
         (keys: string[]): Promise<void>;
     };
     /**
-   * Update the visitor context values, matching the given keys, used for targeting.
-   * A new context value associated with this key will be created if there is no previous matching value.
-   * Context keys must be String, and values types must be one of the following : Number, Boolean, String.
-   * @param context collection of keys, values.
-   */
+     * Update the visitor context values, matching the given keys, used for targeting.
+     * A new context value associated with this key will be created if there is no previous matching value.
+     * Context keys must be String, and values types must be one of the following : Number, Boolean, String.
+     * @param context collection of keys, values.
+     */
     updateContext(context: Record<string, primitive>): void;
     /**
-   * clear the actual visitor context
-   */
+     * clear the actual visitor context
+     */
     clearContext(): void;
     /**
- * Authenticate anonymous visitor
- * @param visitorId
- */
+     * Authenticate anonymous visitor
+     * @param visitorId
+     */
     authenticate(visitorId: string): void;
     /**
- * This hook change authenticated Visitor to anonymous visitor
- * @param visitorId
- */
+     * This function change authenticated Visitor to anonymous visitor
+     * @param visitorId
+     */
     unauthenticate(): void;
     hit: {
         send: {
             (hit: HitAbstract): Promise<void>;
-            (hit: HitAbstract | IHit): Promise<void>;
+            (hit: IHit): Promise<void>;
+            (hit: HitShape): Promise<void>;
+            (hit: HitAbstract | IHit | HitShape): Promise<void>;
         };
         sendMultiple: {
             (hit: HitAbstract[]): Promise<void>;
             (hit: IHit[]): Promise<void>;
+            (hit: HitShape[]): Promise<void>;
+            (hit: HitAbstract[] | IHit[] | HitShape[]): Promise<void>;
         };
     };
+    /**
+     * Retrieve a Flag object by its key. If no flag match the given key an empty flag will be returned.
+     * @param key flag key
+     * @param defaultValue
+     */
+    getFlag<T>(key: string, defaultValue: T): IFlag<T>;
+    fetchFlags: () => Promise<void>;
 };
 export declare const useFlagship: () => UseFlagshipOutput;
-export declare const noVisitorMessage = "sdk not correctly initialized... Make sure fsVisitor is ready.";
-export declare const noVisitorDefault = "fsVisitor not initialized, returns default value";

package/dist/types/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const noVisitorMessage = "sdk not correctly initialized... Make sure fsVisitor is ready.";
+export declare const noVisitorDefault = "fsVisitor not initialized, returns default value";

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
 export * from './FlagshipContext';
-export { DecisionMode } from '@flagship.io/js-sdk';
+export * from '@flagship.io/js-sdk';
 export * from './FlagshipHooks';

package/dist/types/utils.d.ts

@@ -1,5 +1,7 @@
-import { CampaignDTO, IFlagshipConfig, Modification } from '@flagship.io/js-sdk';
+import { CampaignDTO, IFlagshipConfig, LogLevel, Modification } from '@flagship.io/js-sdk';
 export declare function logError(config: IFlagshipConfig | undefined, message: string, tag: string): void;
 export declare function logInfo(config: IFlagshipConfig | undefined, message: string, tag: string): void;
 export declare function logWarn(config: IFlagshipConfig | undefined, message: string, tag: string): void;
+export declare function log(level: LogLevel, message: string, tag: string): void;
 export declare const getModificationsFromCampaigns: (campaigns: Array<CampaignDTO>) => Map<string, Modification>;
+export declare function uuidV4(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flagship.io/react-sdk",
-  "version": "2.2.0-beta.3",
+  "version": "3.0.0",
   "description": "Flagship REACT SDK",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
@@ -11,7 +11,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@flagship.io/js-sdk": "^2.3.1-beta.6",
+    "@flagship.io/js-sdk": "^3.0.0",
     "encoding": "^0.1.13"
   },
   "peerDependencies": {
@@ -97,4 +97,4 @@
       "last 1 safari version"
     ]
   }
-}
+}