Adjus types.d.ts, bump to 3.4.1

Author: kyle-ssg

examples/nextjs/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-es",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Feature flagging to support continuous development. This is an esm equivalent of the standard flagsmith npm module.",
   "main": "./index.js",
   "type": "module",

flagsmith-es/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Feature flagging to support continuous development",
   "main": "./index.js",
   "repository": {

flagsmith/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-flagsmith",
-  "version": "3.4.0",
+  "version": "3.4.1",
   "description": "Feature flagging to support continuous development",
   "main": "./index.js",
   "repository": {

react-native-flagsmith/package.json

@@ -1,102 +1,149 @@
-export interface IBulletTrainFeature {
-    enabled: boolean;
-    value?: string | number | boolean;
+export interface IFlagsmithFeature {
+    enabled: boolean
+    value?: string|number|boolean
 }
-export interface IFlagsmithFeature extends IBulletTrainFeature {
-}
-export declare type IFlagsmithTrait = string | number | boolean;
+
+export type IFlagsmithTrait = string|number|boolean
+
+/*
+    example: {hero:{enabled:true, value:"blue"}, myCoolFeature:{enabled:true}}
+* */
 export interface IFlags {
-    [key: string]: IFlagsmithFeature;
+    [key: string]: IFlagsmithFeature
 }
+
+/*
+    example: {favourite_color: "blue", age: 21}
+* */
 export interface ITraits {
-    [key: string]: IFlagsmithTrait;
-}
-export interface IUserIdentity {
-    flags: IFlagsmithFeature;
-    traits: ITraits;
+    [key: string]: IFlagsmithTrait
 }
+
 export interface IRetrieveInfo {
-    isFromServer: boolean;
-    flagsChanged: boolean;
-    traitsChanged: boolean;
+    isFromServer: boolean
+    flagsChanged: boolean
+    traitsChanged: boolean
 }
 export interface IState {
-    api: string;
-    environmentID: string;
-    flags?: IFlags;
-    identity?: string;
-    traits: ITraits;
+    api: string
+    environmentID: string
+    flags?: IFlags
+    identity?: string
+    traits: ITraits
+}
+type ICacheOptions = {
+    ttl?:number, // how long to persist the cache in ms (defaults to 0 which is infinite)
+    /*
+    If this is true and there's cache available, it will skip hitting the API as if preventFetch was true
+    Note: this is just for flagsmith.init(), Calls to identify, getFlags etc will still hit the API regardless
+    */
+    skipAPI?:boolean
+}
+export interface IInitConfig {
+    AsyncStorage?: any // an AsyncStorage implementation
+    api?: string // the api you wish to use, important if self hosting
+    cacheFlags?: boolean // whether to local storage flags, needs AsyncStorage defined
+    cacheOptions?: ICacheOptions // A ttl in ms (default to 0 which is infinite) and option to skip hitting the API in flagsmith.init if there's cache available.
+    defaultFlags?: IFlags //
+    enableAnalytics?: boolean // Enable sending flag analytics for getValue and hasFeature evaluations.
+    enableDynatrace?: boolean // Enables the Dynatrace RUM integration
+    enableLogs?: boolean // whether to enable logs
+    angularHttpClient?: any // an angular http client to support ssr
+    environmentID: string // your Flagsmith environment id
+    headers?: object // pass custom headers for flagsmith api calls
+    identity?: string // Initialise with a given identity
+    traits?: ITraits // Initialise with a given set of traits
+    onChange?: (previousFlags:IFlags, params:IRetrieveInfo)=> void // triggered when the flags are retrieved
+    onError?: (res:{message:string}) => void // triggered if there was an api error
+    preventFetch?: boolean // whether to prevent fetching flags on init
+    state?: IState // set a predefined state, useful for isomorphic applications
+    _trigger?: ()=>void // Used internally, this function will callback separately to onChange whenever flags are updated
 }
 export interface IFlagsmith {
     /**
      * Initialise the sdk against a particular environment
      */
-    init: (config: {
-        environmentID: string;
-        api?: string;
-        headers?: object;
-        AsyncStorage?: any;
-        cacheFlags?: boolean;
-        preventFetch?: boolean;
-        enableAnalytics?: boolean;
-        enableLogs?: boolean;
-        onChange?: (previousFlags: IFlags, params: IRetrieveInfo) => void;
-        state?: IState;
-        onError?: (res: {
-            message: string;
-        }) => void;
-        defaultFlags?: IFlags;
-    }) => Promise<void>;
+    init:(config: IInitConfig) => Promise<void>
+
     /**
      * Trigger a manual fetch of the environment features
      */
-    getFlags: () => Promise<null>;
+    getFlags:()=> Promise<null>
+
     /**
      * Returns the current flags
      */
-    getAllFlags: () => IFlags;
+    getAllFlags:()=> IFlags
+
     /**
      * Identify user, triggers a call to get flags if flagsmith.init has been called
      */
-    identify: (userId: string, traits?: Record<string, string | number | boolean>) => Promise<void>;
+    identify:(userId:string, traits?: Record<string, string|number|boolean>,) => Promise<void>
+
     /**
      * Retrieves the current state of flagsmith
      */
-    getState: () => IState;
+    getState:()=> IState
+
     /**
      * Clears the identity, triggers a call to getFlags
      */
-    logout: () => Promise<null>;
+    logout:()=> Promise<null>
+
     /**
      * Polls the flagsmith API, specify interval in ms
      */
-    startListening: (interval?: number) => void;
+    startListening:(interval?:number)=> void
+
     /**
      * Stops polling
      */
-    stopListening: () => void;
+    stopListening:()=> void
+
     /**
      * Get the whether a flag is enabled e.g. flagsmith.hasFeature("powerUserFeature")
      */
-    hasFeature: (key: string) => boolean;
+    hasFeature:(key: string)=> boolean
+
     /**
      * Get the value of a particular remote config e.g. flagsmith.getValue("font_size")
      */
-    getValue: (key: string) => string | number | boolean;
+    getValue:(key: string) => string|number|boolean
+
     /**
      * Get the value of a particular trait for the identified user
      */
-    getTrait: (key: string) => string | number | boolean;
+    getTrait:(key: string) => string|number|boolean
+
     /**
      * Set a specific trait for a given user id, triggers a call to get flags
      */
-    setTrait: (key: string, value: string | number | boolean) => Promise<null>;
+    setTrait:(
+        key: string,
+        value: string|number|boolean
+    )=> Promise<null>
+
     /**
      * Set a key value set of traits for a given user, triggers a call to get flags
      */
-    setTraits: (traits: Record<string, string | number | boolean>) => Promise<null>;
+    setTraits:(
+        traits: Record<string, string|number|boolean>,
+    )=> Promise<null>
+
     /**
      * The stored identity of the user
      */
-    identity?: string;
+    identity?:string
+
+    /**
+     * Whether the flagsmith SDK is initialised
+     */
+    initialised?:boolean
+
+    /**
+     * Used internally, this function will callback separately to onChange whenever flags are updated
+     */
+    trigger?:()=>{}
+
+    cacheOptions: { ttl: number, skipAPI: boolean }
 }