@flagship.io/react-sdk 2.2.0-beta.6 → 3.0.2-alpha.0

package/dist/types/FlagshipContext.d.ts

@@ -1,79 +0,0 @@
-import React, { ReactNode, Dispatch, SetStateAction } from 'react';
-import { BucketingDTO, CampaignDTO, IFlagshipConfig, Modification, 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.
-     */
-    isLoading: boolean;
-    /**
-     * Boolean. true after it has fully finished initialization tasks, false otherwise.
-     */
-    isSdkReady: boolean;
-    lastModified?: Date;
-    /**
-     * Boolean. When true the flagship visitor instance is truthy, false otherwise.
-     */
-    isVisitorDefined?: boolean;
-    /**
-     * 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.
-     */
-    firstInitSuccess?: string;
-}
-export interface FsState {
-    visitor?: Visitor;
-    config?: IFlagshipConfig;
-    modifications?: Map<string, Modification>;
-    status: FsStatus;
-    initialCampaigns?: CampaignDTO[];
-    initialModifications?: Map<string, Modification> | Modification[];
-}
-interface FsContext {
-    state: FsState;
-    setState?: Dispatch<SetStateAction<FsState>>;
-}
-interface FlagshipProviderProps extends IFlagshipConfig {
-    visitorData: {
-        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.
-     */
-    nodeEnv?: string;
-    /**
-     * Callback function called when the SDK starts initialization.
-     */
-    onInitStart?(): void;
-    /**
-     * Callback function called when the SDK ends initialization.
-     */
-    onInitDone?(): void;
-    /**
-     * 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>;
-        config: IFlagshipConfig;
-        status: FsStatus;
-    }): void;
-    initialBucketing?: BucketingDTO;
-    initialCampaigns?: CampaignDTO[];
-    initialModifications?: Map<string, Modification> | Modification[];
-    /**
-     * If true, it'll automatically call synchronizeModifications when the bucketing file has updated
-     */
-    synchronizeOnBucketingUpdated?: boolean;
-}
-export declare const FlagshipContext: React.Context<FsContext>;
-export declare const FlagshipProvider: React.FC<FlagshipProviderProps>;
-export {};

package/dist/types/FlagshipHooks.d.ts

@@ -1,91 +0,0 @@
-import { HitAbstract, HitShape, 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.
- */
-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.
- */
-export declare const useFsModification: {
-    <T>(params: modificationsRequested<T>): T;
-};
-/**
- * Get the campaign modification information value matching the given key.
- * @param {string} key key which identify the modification.
- */
-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>;
-/**
- * Report this user has seen this modification. Report this user has seen these modifications.
- * @param params
- * @returns
- */
-export declare const useFsActivate: {
-    (keys: {
-        key: string;
-    }[]): Promise<void>;
-    (keys: string[]): Promise<void>;
-};
-export declare type UseFlagshipParams<T> = {
-    modifications: {
-        requested: modificationsRequested<T>[];
-        activateAll?: boolean;
-    };
-};
-export declare type UseFlagshipOutput = {
-    modifications: Modification[];
-    status: FsStatus;
-    getModifications<T>(params: modificationsRequested<T>[], activateAll?: boolean): Record<string, T>;
-    getModificationInfo(key: string): Modification | null;
-    synchronizeModifications(): Promise<void>;
-    activateModification: {
-        (keys: {
-            key: string;
-        }[]): Promise<void>;
-        (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.
-   */
-    updateContext(context: Record<string, primitive>): void;
-    /**
-   * clear the actual visitor context
-   */
-    clearContext(): void;
-    /**
- * Authenticate anonymous visitor
- * @param visitorId
- */
-    authenticate(visitorId: string): void;
-    /**
- * This hook change authenticated Visitor to anonymous visitor
- * @param visitorId
- */
-    unauthenticate(): void;
-    hit: {
-        send: {
-            (hit: HitAbstract): 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>;
-        };
-    };
-};
-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/utils.d.ts

@@ -1,5 +0,0 @@
-import { CampaignDTO, IFlagshipConfig, 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 const getModificationsFromCampaigns: (campaigns: Array<CampaignDTO>) => Map<string, Modification>;