nana800-remote-config 1.1.0 → 1.2.0

package/README.md

@@ -95,13 +95,22 @@ Loads the variables for the given user and returns `true` on success.
 
 ### `getString(name)`, `getNumber(name)`, `getBoolean(name)`
 Return the variable converted to the requested type, or `undefined` when the variable is missing, cannot be converted, or `initFetch` has not succeeded yet.
-`getNumber` accepts numeric strings, `getBoolean` accepts `"true"` and `"false"`.
+`getNumber` accepts numeric strings, `getBoolean` accepts `"true"` and `"false"`, `getString` returns objects and arrays as JSON text.
+
+### `getJSON<T>(name)`
+Returns the value of a JSON variable. JSON variables arrive already parsed: an object, an array, a string, a number, a boolean or `null`.
+
+```ts
+type Banner = { title: string; url: string }
+const banner = nana800RemoteConfig.getJSON<Banner>('main_banner')
+```
 
 ### `getReceivedVariablesObject()`
 Returns a copy of all received variables.
 
 ### `getLastError()`
 Returns the error text of the last unsuccessful `initFetch` call.
+The fetch endpoint allows 100 requests per 3 seconds and 300 requests per 10 seconds from one IP, above that it answers `HTTP 429`.
 
 ### `isFetched`
 `true` after the first successful `initFetch` call.

package/dist/main.cjs.js

@@ -39,16 +39,9 @@ var RemoteConfigPlatform = /* @__PURE__ */ ((RemoteConfigPlatform2) => {
 })(RemoteConfigPlatform || {});
 var isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 var toRecordsMap = (value) => {
-  const result = {};
-  if (!isPlainObject(value)) return result;
-  for (const key of Object.keys(value)) {
-    const item = value[key];
-    if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
-      result[key] = item;
-    }
-  }
-  return result;
+  return isPlainObject(value) ? value : {};
 };
+var cloneValue = (value) => value !== null && typeof value === "object" ? JSON.parse(JSON.stringify(value)) : value;
 var getErrorMessage = (error) => {
   if (error instanceof Error) {
     return error.name === "AbortError" || error.name === "TimeoutError" ? "request timed out" : error.message;
@@ -95,11 +88,16 @@ var Nana800RemoteConfig = class {
       return this.lastError;
     });
     __publicField(this, "getReceivedVariablesObject", () => {
-      return { ...this.storage };
+      return cloneValue(this.storage);
     });
     __publicField(this, "getString", (variable_name) => {
       const value = this.getVariable(variable_name);
-      return value === void 0 ? void 0 : String(value);
+      if (value === void 0 || value === null) return void 0;
+      return typeof value === "object" ? JSON.stringify(value) : String(value);
+    });
+    /** value of a JSON variable (object, array, string, number, boolean or null), returned as received */
+    __publicField(this, "getJSON", (variable_name) => {
+      return cloneValue(this.getVariable(variable_name));
     });
     __publicField(this, "getNumber", (variable_name) => {
       const value = this.getVariable(variable_name);

package/dist/main.d.mts

@@ -1,4 +1,8 @@
-export type RemoteConfigValue = number | string | boolean | undefined;
+/** value of a JSON variable, already parsed */
+export type RemoteConfigJSONValue = string | number | boolean | null | RemoteConfigJSONValue[] | {
+    [key: string]: RemoteConfigJSONValue;
+};
+export type RemoteConfigValue = RemoteConfigJSONValue | undefined;
 export type RemoteConfigRecordsMapType = Record<string, RemoteConfigValue>;
 export declare enum RemoteConfigPlatform {
     WEB = "WEB",
@@ -29,6 +33,8 @@ declare class Nana800RemoteConfig {
     getLastError: () => string;
     getReceivedVariablesObject: () => RemoteConfigRecordsMapType;
     getString: (variable_name: string) => string | undefined;
+    /** value of a JSON variable (object, array, string, number, boolean or null), returned as received */
+    getJSON: <T = RemoteConfigJSONValue>(variable_name: string) => T | undefined;
     getNumber: (variable_name: string) => number | undefined;
     getBoolean: (variable_name: string) => boolean | undefined;
     private getVariable;

package/dist/main.d.ts

@@ -1,4 +1,8 @@
-export type RemoteConfigValue = number | string | boolean | undefined;
+/** value of a JSON variable, already parsed */
+export type RemoteConfigJSONValue = string | number | boolean | null | RemoteConfigJSONValue[] | {
+    [key: string]: RemoteConfigJSONValue;
+};
+export type RemoteConfigValue = RemoteConfigJSONValue | undefined;
 export type RemoteConfigRecordsMapType = Record<string, RemoteConfigValue>;
 export declare enum RemoteConfigPlatform {
     WEB = "WEB",
@@ -29,6 +33,8 @@ declare class Nana800RemoteConfig {
     getLastError: () => string;
     getReceivedVariablesObject: () => RemoteConfigRecordsMapType;
     getString: (variable_name: string) => string | undefined;
+    /** value of a JSON variable (object, array, string, number, boolean or null), returned as received */
+    getJSON: <T = RemoteConfigJSONValue>(variable_name: string) => T | undefined;
     getNumber: (variable_name: string) => number | undefined;
     getBoolean: (variable_name: string) => boolean | undefined;
     private getVariable;

package/dist/main.mjs

@@ -16,16 +16,9 @@ var RemoteConfigPlatform = /* @__PURE__ */ ((RemoteConfigPlatform2) => {
 })(RemoteConfigPlatform || {});
 var isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 var toRecordsMap = (value) => {
-  const result = {};
-  if (!isPlainObject(value)) return result;
-  for (const key of Object.keys(value)) {
-    const item = value[key];
-    if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
-      result[key] = item;
-    }
-  }
-  return result;
+  return isPlainObject(value) ? value : {};
 };
+var cloneValue = (value) => value !== null && typeof value === "object" ? JSON.parse(JSON.stringify(value)) : value;
 var getErrorMessage = (error) => {
   if (error instanceof Error) {
     return error.name === "AbortError" || error.name === "TimeoutError" ? "request timed out" : error.message;
@@ -72,11 +65,16 @@ var Nana800RemoteConfig = class {
       return this.lastError;
     });
     __publicField(this, "getReceivedVariablesObject", () => {
-      return { ...this.storage };
+      return cloneValue(this.storage);
     });
     __publicField(this, "getString", (variable_name) => {
       const value = this.getVariable(variable_name);
-      return value === void 0 ? void 0 : String(value);
+      if (value === void 0 || value === null) return void 0;
+      return typeof value === "object" ? JSON.stringify(value) : String(value);
+    });
+    /** value of a JSON variable (object, array, string, number, boolean or null), returned as received */
+    __publicField(this, "getJSON", (variable_name) => {
+      return cloneValue(this.getVariable(variable_name));
     });
     __publicField(this, "getNumber", (variable_name) => {
       const value = this.getVariable(variable_name);

package/dist/nana800-remote-config.js

@@ -18,16 +18,9 @@
   })(RemoteConfigPlatform || {});
   var isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
   var toRecordsMap = (value) => {
-    const result = {};
-    if (!isPlainObject(value)) return result;
-    for (const key of Object.keys(value)) {
-      const item = value[key];
-      if (typeof item === "string" || typeof item === "number" || typeof item === "boolean") {
-        result[key] = item;
-      }
-    }
-    return result;
+    return isPlainObject(value) ? value : {};
   };
+  var cloneValue = (value) => value !== null && typeof value === "object" ? JSON.parse(JSON.stringify(value)) : value;
   var getErrorMessage = (error) => {
     if (error instanceof Error) {
       return error.name === "AbortError" || error.name === "TimeoutError" ? "request timed out" : error.message;
@@ -74,11 +67,16 @@
         return this.lastError;
       });
       __publicField(this, "getReceivedVariablesObject", () => {
-        return { ...this.storage };
+        return cloneValue(this.storage);
       });
       __publicField(this, "getString", (variable_name) => {
         const value = this.getVariable(variable_name);
-        return value === void 0 ? void 0 : String(value);
+        if (value === void 0 || value === null) return void 0;
+        return typeof value === "object" ? JSON.stringify(value) : String(value);
+      });
+      /** value of a JSON variable (object, array, string, number, boolean or null), returned as received */
+      __publicField(this, "getJSON", (variable_name) => {
+        return cloneValue(this.getVariable(variable_name));
       });
       __publicField(this, "getNumber", (variable_name) => {
         const value = this.getVariable(variable_name);

package/dist/nana800-remote-config.min.js

@@ -1 +1 @@
-"use strict";(()=>{var m=Object.defineProperty;var b=(r,e,t)=>e in r?m(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t;var n=(r,e,t)=>b(r,typeof e!="symbol"?e+"":e,t);var h="x-nana-api-key",y="https://api.nana800.io";var c="nana800-remote-config:",l=(o=>(o.WEB="WEB",o.ANDROID="ANDROID",o.IOS="IOS",o.DESKTOP="DESKTOP",o))(l||{}),R=r=>typeof r=="object"&&r!==null&&!Array.isArray(r),E=r=>{let e={};if(!R(r))return e;for(let t of Object.keys(r)){let s=r[t];(typeof s=="string"||typeof s=="number"||typeof s=="boolean")&&(e[t]=s)}return e},T=r=>r instanceof Error?r.name==="AbortError"||r.name==="TimeoutError"?"request timed out":r.message:String(r),u=class{constructor(){n(this,"storage",{});n(this,"lastError","");n(this,"isFetched",!1);n(this,"initFetch",async(e,t={})=>{var g;let s=(t.base_url||y).replace(/\/+$/,""),o=typeof AbortController!="undefined"?new AbortController:null,f=o?setTimeout(()=>o.abort(),(g=t.timeout_ms)!=null?g:1e4):null;try{let a=await fetch(`${s}/remote_config_records/fetch_user_remote_config_records`,{method:"POST",headers:{"Content-Type":"application/json",[h]:(e==null?void 0:e.api_key)||""},body:JSON.stringify(e),signal:o==null?void 0:o.signal}),i=await a.json().catch(()=>null);return!a.ok||!(i!=null&&i.success)?(this.lastError=(i==null?void 0:i.error_text)||`HTTP ${a.status}`,console.warn(c,"fetch was not successful:",this.lastError),!1):(this.storage=E(i.records),this.isFetched=!0,this.lastError="",!0)}catch(a){return this.lastError=T(a),console.warn(c,"fetch request error:",this.lastError),!1}finally{f&&clearTimeout(f)}});n(this,"getLastError",()=>this.lastError);n(this,"getReceivedVariablesObject",()=>({...this.storage}));n(this,"getString",e=>{let t=this.getVariable(e);return t===void 0?void 0:String(t)});n(this,"getNumber",e=>{let t=this.getVariable(e);if(typeof t=="number")return t;if(typeof t=="string"&&t.trim()!==""){let s=Number(t);return Number.isFinite(s)?s:void 0}});n(this,"getBoolean",e=>{let t=this.getVariable(e);if(typeof t=="boolean")return t;if(t==="true")return!0;if(t==="false")return!1});n(this,"getVariable",e=>{if(!this.isFetched){console.warn(c,"remote config variables list is not fetched. please run initFetch before.");return}return Object.prototype.hasOwnProperty.call(this.storage,e)?this.storage[e]:void 0})}},p=new u;var d=globalThis;d.nana800RemoteConfig=p;d.RemoteConfigPlatform=l;})();
+"use strict";(()=>{var b=Object.defineProperty;var R=(e,r,t)=>r in e?b(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var n=(e,r,t)=>R(e,typeof r!="symbol"?r+"":r,t);var h="x-nana-api-key",y="https://api.nana800.io";var c="nana800-remote-config:",l=(o=>(o.WEB="WEB",o.ANDROID="ANDROID",o.IOS="IOS",o.DESKTOP="DESKTOP",o))(l||{}),T=e=>typeof e=="object"&&e!==null&&!Array.isArray(e),E=e=>T(e)?e:{},p=e=>e!==null&&typeof e=="object"?JSON.parse(JSON.stringify(e)):e,O=e=>e instanceof Error?e.name==="AbortError"||e.name==="TimeoutError"?"request timed out":e.message:String(e),u=class{constructor(){n(this,"storage",{});n(this,"lastError","");n(this,"isFetched",!1);n(this,"initFetch",async(r,t={})=>{var g;let a=(t.base_url||y).replace(/\/+$/,""),o=typeof AbortController!="undefined"?new AbortController:null,f=o?setTimeout(()=>o.abort(),(g=t.timeout_ms)!=null?g:1e4):null;try{let i=await fetch(`${a}/remote_config_records/fetch_user_remote_config_records`,{method:"POST",headers:{"Content-Type":"application/json",[h]:(r==null?void 0:r.api_key)||""},body:JSON.stringify(r),signal:o==null?void 0:o.signal}),s=await i.json().catch(()=>null);return!i.ok||!(s!=null&&s.success)?(this.lastError=(s==null?void 0:s.error_text)||`HTTP ${i.status}`,console.warn(c,"fetch was not successful:",this.lastError),!1):(this.storage=E(s.records),this.isFetched=!0,this.lastError="",!0)}catch(i){return this.lastError=O(i),console.warn(c,"fetch request error:",this.lastError),!1}finally{f&&clearTimeout(f)}});n(this,"getLastError",()=>this.lastError);n(this,"getReceivedVariablesObject",()=>p(this.storage));n(this,"getString",r=>{let t=this.getVariable(r);if(t!=null)return typeof t=="object"?JSON.stringify(t):String(t)});n(this,"getJSON",r=>p(this.getVariable(r)));n(this,"getNumber",r=>{let t=this.getVariable(r);if(typeof t=="number")return t;if(typeof t=="string"&&t.trim()!==""){let a=Number(t);return Number.isFinite(a)?a:void 0}});n(this,"getBoolean",r=>{let t=this.getVariable(r);if(typeof t=="boolean")return t;if(t==="true")return!0;if(t==="false")return!1});n(this,"getVariable",r=>{if(!this.isFetched){console.warn(c,"remote config variables list is not fetched. please run initFetch before.");return}return Object.prototype.hasOwnProperty.call(this.storage,r)?this.storage[r]:void 0})}},d=new u;var m=globalThis;m.nana800RemoteConfig=d;m.RemoteConfigPlatform=l;})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nana800-remote-config",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Remote Config (remote variables) client for the NANA800.io platform",
   "license": "MIT",
   "homepage": "https://nana800.gitbook.io/doc/features/remote-config-peremennye",