nana800-remote-config 1.0.1 → 1.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Andreas Linnert
+Copyright (c) 2025 Bekender
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+

package/README.md

@@ -1,5 +1,8 @@
 # Nana800 Remote Config from NANA800.io 🍺
 
+Lightweight client (no dependencies, about 2 KB minified) for the Remote Config (remote variables) feature of the NANA800.io platform.
+Works in browsers, React Native, Node.js 18+ and any runtime with `fetch`.
+
 ### Detail Documentation
 
 [NANA800 Documentation 📊](https://nana800.gitbook.io/doc/features/remote-config-peremennye)
@@ -35,7 +38,10 @@ window.addEventListener('load', async () => {
         version: 1
     })
     console.log({isFetched})
-    
+    if (!isFetched) {
+        console.log(nana800RemoteConfig.getLastError())
+    }
+
     const landingUrl = nana800RemoteConfig.getString('landing_url');
     console.log({landingUrl})
 })
@@ -44,7 +50,7 @@ window.addEventListener('load', async () => {
 #### For HTML/JS projects:
 
 ```html
-<script src="https://s3.timeweb.cloud/c14a1252-bekender-files/cdn_libraries/nana800-remote-config.cjs.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/nana800-remote-config@1/dist/nana800-remote-config.min.js"></script>
 
 <script>
     window.addEventListener('load', async () => {
@@ -64,11 +70,14 @@ window.addEventListener('load', async () => {
 </script>
 ```
 
+The script defines the global `nana800RemoteConfig` object and the `RemoteConfigPlatform` enum.
+
 #### For other platforms (cURL):
 
 ```bash
 curl --location 'https://api.nana800.io/remote_config_records/fetch_user_remote_config_records' \
 --header 'Content-Type: application/json' \
+--header 'x-nana-api-key: your-api-key' \
 --data '{
   "api_key": "your-api-key",
   "remote_config_project_id": "your-project-id",
@@ -78,6 +87,34 @@ curl --location 'https://api.nana800.io/remote_config_records/fetch_user_remote_
 }'
 ```
 
+## API
+
+### `initFetch(input, options?)`
+Loads the variables for the given user and returns `true` on success.
+`options.timeout_ms` sets the request timeout (10000 by default).
+
+### `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"`, `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.
+
 ## FAQ
 
 ### Where is the API key ("api_key"):