Merge pull request #147 from azriel46d/feature/parse-json-values

Parse json values on getValue

Author: kyle-ssg

flagsmith-core.ts

@@ -1,4 +1,4 @@
-import { IFlags, IFlagsmith, IFlagsmithResponse, IInitConfig, IState, ITraits } from './types';
+import { IFlags, IFlagsmith, GetValueOptions, IFlagsmithResponse, IInitConfig, IState, ITraits } from './types';
 export type LikeFetch = (input: Partial<RequestInfo>, init?: Partial<RequestInit>) => Promise<Partial<Response>>
 let _fetch: LikeFetch;
 type RequestOptions = {
@@ -622,16 +622,23 @@ const Flagsmith = class {
         this.updateEventStorage();
     }
 
-    getValue = (key:string) => {
+    getValue = (key:string, options?: GetValueOptions) => {
         const flag = this.flags && this.flags[key.toLowerCase().replace(/ /g, '_')];
         let res = null;
         if (flag) {
             res = flag.value;
         }
+
         this.evaluateFlag(key);
 
+        if (options?.json) {
+            try {
+                return JSON.parse(res as string)
+            } catch (e) {
+                return options.fallback
+            }
+        }
         //todo record check for value
-
         return res;
     }
 

lib/flagsmith-es/index.js

@@ -1,4 +1,4 @@
-import { IFlags, IFlagsmith, IFlagsmithResponse, IInitConfig, IState, ITraits } from './types';
+import { IFlags, IFlagsmith, GetValueOptions, IFlagsmithResponse, IInitConfig, IState, ITraits } from './types';
 export type LikeFetch = (input: Partial<RequestInfo>, init?: Partial<RequestInit>) => Promise<Partial<Response>>
 let _fetch: LikeFetch;
 type RequestOptions = {
@@ -622,16 +622,23 @@ const Flagsmith = class {
         this.updateEventStorage();
     }
 
-    getValue = (key:string) => {
+    getValue = (key:string, options?: GetValueOptions) => {
         const flag = this.flags && this.flags[key.toLowerCase().replace(/ /g, '_')];
         let res = null;
         if (flag) {
             res = flag.value;
         }
+
         this.evaluateFlag(key);
 
+        if (options?.json) {
+            try {
+                return JSON.parse(res as string)
+            } catch (e) {
+                return options.fallback
+            }
+        }
         //todo record check for value
-
         return res;
     }
 

lib/flagsmith-es/isomorphic.js

@@ -7,6 +7,10 @@ export interface IFlagsmithFeature {
 export declare type IFlagsmithTrait = IFlagsmithValue;
 export declare type IFlags<F extends string = string> = Record<F, IFlagsmithFeature>;
 export declare type ITraits<T extends string = string> = Record<T, IFlagsmithTrait>;
+export declare type GetValueOptions<T = Array<any> | object> = {
+    json: boolean;
+    fallback?: T;
+};
 export interface IRetrieveInfo {
     isFromServer: boolean;
     flagsChanged: boolean;
@@ -107,7 +111,7 @@ export interface IFlagsmith<F extends string = string, T extends string = string
     /**
      * Get the value of a particular remote config e.g. flagsmith.getValue("font_size")
      */
-    getValue: (key: F) => IFlagsmithValue;
+    getValue<T>(key: F, options?: GetValueOptions<T>): T | IFlagsmithValue;
     /**
      * Get the value of a particular trait for the identified user
      */

lib/flagsmith-es/next-middleware.js

@@ -1,4 +1,4 @@
-import { IFlags, IFlagsmith, IFlagsmithResponse, IInitConfig, IState, ITraits } from './types';
+import { IFlags, IFlagsmith, GetValueOptions, IFlagsmithResponse, IInitConfig, IState, ITraits } from './types';
 export type LikeFetch = (input: Partial<RequestInfo>, init?: Partial<RequestInit>) => Promise<Partial<Response>>
 let _fetch: LikeFetch;
 type RequestOptions = {
@@ -622,16 +622,23 @@ const Flagsmith = class {
         this.updateEventStorage();
     }
 
-    getValue = (key:string) => {
+    getValue = (key:string, options?: GetValueOptions) => {
         const flag = this.flags && this.flags[key.toLowerCase().replace(/ /g, '_')];
         let res = null;
         if (flag) {
             res = flag.value;
         }
+
         this.evaluateFlag(key);
 
+        if (options?.json) {
+            try {
+                return JSON.parse(res as string)
+            } catch (e) {
+                return options.fallback
+            }
+        }
         //todo record check for value
-
         return res;
     }