@zoho_apptics/apptics-js-sdk 2.0.0-beta → 2.0.0-beta.2

package/dist/cjs/remoteconfig/country.d.ts

@@ -0,0 +1,4 @@
+/** The ISO code of a time zone's country, '' for one with none (UTC) or unknown. */
+export declare function timeZoneCountryCode(timeZone: string): string;
+/** The country: the user's, else the time zone's. '' when neither says. */
+export declare function deviceCountry(): string;

package/dist/cjs/remoteconfig/country.js

@@ -0,0 +1,73 @@
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
+'use strict';
+
+var state = require('../core/state.js');
+var env = require('../core/env.js');
+var tzCountries = require('./tz-countries.js');
+
+/**
+ * The country of this device, for remote config's `country` criteria, by its English name as the
+ * console lists it ("India").
+ *
+ * The one AppticsUser.setUser registered comes first. Otherwise it is the country of the
+ * browser's time zone, which is the device clock's: Asia/Kolkata (or Chrome's Asia/Calcutta) is
+ * India, whatever language the browser is in. A browser has no other source short of asking for
+ * the user's location, which is a permission prompt. A zone shared by several countries is the
+ * one tzdata names for it.
+ */
+/** Zone -> ISO code, unpacked on first use. */
+var byZone = null;
+function zones() {
+    if (byZone !== null) {
+        return byZone;
+    }
+    var out = {};
+    tzCountries.TZ_COUNTRIES.split(';').forEach(function (entry) {
+        var colon = entry.indexOf(':'); // no i18n
+        var code = entry.slice(0, colon);
+        entry.slice(colon + 1).split('|').forEach(function (group) {
+            // "Area/City,City", or bare names with no area ("Cuba,Egypt")
+            var slash = group.indexOf('/'); // no i18n
+            var area = slash === -1 ? '' : group.slice(0, slash + 1); // no i18n
+            group.slice(area.length).split(',').forEach(function (city) {
+                out[area + city] = code;
+            });
+        });
+    });
+    byZone = out;
+    return out;
+}
+/** The ISO code of a time zone's country, '' for one with none (UTC) or unknown. */
+function timeZoneCountryCode(timeZone) {
+    var all = zones();
+    return Object.prototype.hasOwnProperty.call(all, timeZone) ? all[timeZone] : ''; // no i18n
+}
+/** IN -> India, in English; the code itself where the browser has no region names. */
+function regionName(code) {
+    try {
+        var names = new Intl.DisplayNames(['en'], { type: 'region' }); // no i18n
+        return names.of(code) || code;
+    }
+    catch (err) {
+        return code;
+    }
+}
+/** The country: the user's, else the time zone's. '' when neither says. */
+function deviceCountry() {
+    var named = String(state._ZAP._user_info.country || '').trim(); // no i18n
+    if (named !== '') {
+        return named;
+    }
+    var timeZone = ''; // no i18n
+    try {
+        timeZone = String(env.getTimeZone() || ''); // no i18n
+    }
+    catch (err) {
+        timeZone = ''; // no i18n
+    }
+    var code = timeZoneCountryCode(timeZone);
+    return code === '' ? '' : regionName(code); // no i18n
+}
+
+exports.deviceCountry = deviceCountry;
+exports.timeZoneCountryCode = timeZoneCountryCode;

package/dist/cjs/remoteconfig/custom.d.ts

@@ -1,10 +1,10 @@
-/** The value set for a custom criteria key, or undefined when none is. */
-export declare function customConditionValue(key: string): string | undefined;
+/** The values set for a condition, by its name; empty when none are. */
+export declare function customConditionValues(conditionname: string): string[];
 /**
- * Sets what this device is for a custom criteria, or removes it with an empty value. Re-applies
- * the stored rules as soon as storage is ready, so the next read sees the new result without a
- * fetch.
+ * Sets what this device is for a custom condition, by its name, as comma separated values; an
+ * empty value removes it. Re-applies the stored rules once storage is ready, so the next read sees
+ * the new result without a fetch.
  */
-export declare function setCustomConditionValue(key: string, value: string | number | boolean | null | undefined): void;
-/** reset(): forgets the values set on this page; the stored ones go with the rest of storage. */
+export declare function setCustomConditionValue(conditionname: string, value: string | number | boolean | null | undefined): void;
+/** reset(): forgets the values set on this page. */
 export declare function clearCustomConditionValues(): void;

package/dist/cjs/remoteconfig/custom.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 var storage = require('../core/storage.js');
@@ -6,73 +6,53 @@ var logger = require('../core/logger.js');
 var store = require('./store.js');
 
 /**
- * Custom condition values, as Android's AppticsRemoteConfig.setCustomConditionValue: the app says
- * what this device is for a custom criteria the console defines (a condition key with a list of
- * values), and a condition on that key matches when the value set here is one of the listed ones.
+ * Custom condition values: a console condition on the custom criteria (`custom_sdk_value`) is
+ * answered by what the app says this device is for that condition, by the condition's name:
  *
- *   AppticsRemoteConfig.setCustomConditionValue('plan_tier', 'gold');
+ *   AppticsRemoteConfig.setCustomConditionValue('is_custom', 'custom_color');
+ *   AppticsRemoteConfig.setCustomConditionValue('is_custom', 'gold,platinum');   // several
  *
- * The rules are evaluated on the device, so the values have to be here on the next visit too:
- * they are stored, and a value set on this page wins over a stored one. Setting one before
- * storage has loaded — before init(), say — is kept in memory and saved once it has.
- *
- * Assumed wire format, until the server confirms it: a custom criteria arrives with the custom
- * key as its `key` and operator 1 ("is one of"), the same shape as the built-in criteria. A
- * different shape fails closed — the condition does not match and the default is used.
+ * The condition matches when one of the comma separated values is one of the values it lists.
+ * Values are for this page: an app sets them as it starts, as it would any other app state.
  */
-const STORE_KEY = 'remoteconfig_custom'; // no i18n
-/** This page's values; null marks a key removed here, so a stored value no longer counts. */
 var mine = {};
-function stored() {
-    var saved = storage.user_defaults.item(STORE_KEY);
-    return saved && typeof saved === 'object' ? saved : {}; // no i18n
-}
-/** The value set for a custom criteria key, or undefined when none is. */
-function customConditionValue(key) {
-    if (Object.prototype.hasOwnProperty.call(mine, key)) {
-        var here = mine[key];
-        return here === null ? undefined : here;
-    }
-    var saved = stored();
-    return Object.prototype.hasOwnProperty.call(saved, key) ? saved[key] : undefined;
+/** The values set for a condition, by its name; empty when none are. */
+function customConditionValues(conditionname) {
+    var name = String(conditionname || '').trim(); // no i18n
+    return Object.prototype.hasOwnProperty.call(mine, name) ? mine[name] : [];
 }
 /**
- * Sets what this device is for a custom criteria, or removes it with an empty value. Re-applies
- * the stored rules as soon as storage is ready, so the next read sees the new result without a
- * fetch.
+ * Sets what this device is for a custom condition, by its name, as comma separated values; an
+ * empty value removes it. Re-applies the stored rules once storage is ready, so the next read sees
+ * the new result without a fetch.
  */
-function setCustomConditionValue(key, value) {
-    var name = typeof key === 'string' ? key.trim() : ''; // no i18n
+function setCustomConditionValue(conditionname, value) {
+    var name = typeof conditionname === 'string' ? conditionname.trim() : ''; // no i18n
     if (name === '') { // no i18n
-        logger.Console.warn('AppticsRemoteConfig.setCustomConditionValue: a condition key is required'); // no i18n
+        logger.Console.warn('AppticsRemoteConfig.setCustomConditionValue: a condition name is required'); // no i18n
         return;
     }
-    var text = value === null || value === undefined ? '' : String(value).trim(); // no i18n
-    mine[name] = text === '' ? null : text; // no i18n
+    var values = (value === null || value === undefined ? '' : String(value)).split(',') // no i18n
+        .map(function (one) { return one.trim(); })
+        .filter(function (one, i, all) { return one !== '' && all.indexOf(one) === i; }); // no i18n
+    if (values.length === 0) {
+        delete mine[name];
+    }
+    else {
+        mine[name] = values;
+    }
     storage.storageReady().then(function (backend) {
-        if (!backend) {
-            return;
-        }
-        var saved = stored();
-        Object.keys(mine).forEach(function (one) {
-            var here = mine[one];
-            if (here === null || here === undefined) {
-                delete saved[one];
-            }
-            else {
-                saved[one] = here;
-            }
-        });
-        storage.user_defaults.add(STORE_KEY, saved);
         // only once storage has loaded: re-resolving before it would read an empty rule set and keep it
-        store.reresolve();
+        if (backend) {
+            store.reresolve();
+        }
     });
 }
-/** reset(): forgets the values set on this page; the stored ones go with the rest of storage. */
+/** reset(): forgets the values set on this page. */
 function clearCustomConditionValues() {
     mine = {};
 }
 
 exports.clearCustomConditionValues = clearCustomConditionValues;
-exports.customConditionValue = customConditionValue;
+exports.customConditionValues = customConditionValues;
 exports.setCustomConditionValue = setCustomConditionValue;

package/dist/cjs/remoteconfig/evaluate.d.ts

@@ -10,10 +10,10 @@ export declare function conditionMatches(condition: Dict): boolean;
 /**
  * The value of one parameter on this device, as the string the server stores it as.
  *
- * `byId` is every condition the answer carried, keyed by its id — the mapping on the parameter
- * names a condition but does not repeat its criteria.
+ * `conditions` is `all_condition` as the server sent it: its order is the order they are tried
+ * in. The parameter's own `conditions` say which of them apply to it, and with what value.
  */
-export declare function resolve(parameter: Dict, byId: Record<string, Dict>): string;
+export declare function resolve(parameter: Dict, conditions: Dict[]): string;
 /**
  * Every parameter resolved against this device, as a flat name -> value map.
  *

package/dist/cjs/remoteconfig/evaluate.js

@@ -1,10 +1,11 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 var logger = require('../core/logger.js');
 var state = require('../core/state.js');
 var utils = require('../core/utils.js');
 var custom = require('./custom.js');
+var country = require('./country.js');
 
 /**
  * Working out what a parameter is worth on this device.
@@ -13,11 +14,17 @@ var custom = require('./custom.js');
  * condition with its criteria, and the mapping between them. Resolving it here rather than on
  * the server is what lets a value be read with no network at all on the next visit.
  *
- * A parameter resolves by walking its conditions in `conditionorder` and taking the value of the
- * first one that matches this device. Nothing matches, or nothing is mapped: the default.
+ * A parameter resolves by walking the conditions in the order of `all_condition`, the console's
+ * own order, and taking the value the parameter maps to the first one that both applies to it and
+ * matches this device. A condition matches when every one of its criteria does. Nothing matches,
+ * or nothing is mapped: the parameter's default value.
+ *
+ * Criteria are answered from what the browser knows about itself (app version, device type,
+ * country...), except a custom one (`custom_sdk_value`): that is answered by what the app set with
+ * setCustomConditionValue(conditionname, 'a,b'), and matches when one of those values is listed.
  *
  * Everything fails closed. An operator we do not recognise, a criteria key we cannot answer, a
- * condition the parameter names but the server did not send — each one means "does not match",
+ * condition the parameter names but the server did not send: each one means "does not match",
  * never "matches". A config system that guesses hands an app a value its author never chose, on
  * a device they cannot see, and that is far worse than falling back to the default.
  */
@@ -41,9 +48,12 @@ const FACTS = Object.freeze({
     osversion: function () { return String(state._ZAP._device_info.osversion || ''); }, // no i18n
     devicetype: function () { return String(state._ZAP._device_info.devicetype || ''); }, // no i18n
     language: function () { return String(navigator.language || ''); }, // no i18n
+    country: country.deviceCountry,
     customergroupid: function () { return String(state._ZAP._user_info.groupid || ''); }, // no i18n
     userid: function () { return String(state._ZAP._user_info.userid || ''); }, // no i18n
 });
+/** The criteria key of a custom condition, answered by setCustomConditionValue. */
+const CUSTOM_KEY = 'custom_sdk_value'; // no i18n
 /** Codes and keys already complained about, so one unknown rule is not a log per read. */
 var reported = {};
 function sayOnce(key, message) {
@@ -65,8 +75,8 @@ function valuesOf(criteria) {
     }
     return raw.map(function (one) { return String(one); });
 }
-/** Whether one criteria holds on this device. */
-function criteriaMatches(criteria) {
+/** Whether one criteria holds on this device; `conditionname` answers a custom criteria. */
+function criteriaMatches(criteria, conditionname) {
     var key = String(criteria.key || ''); // no i18n
     var operator = OPERATORS[String(criteria.status)];
     if (operator === undefined) {
@@ -74,21 +84,31 @@ function criteriaMatches(criteria) {
             + '", so conditions using it will not match'); // no i18n
         return false;
     }
+    var listed = valuesOf(criteria);
+    if (key === CUSTOM_KEY) {
+        var mine = custom.customConditionValues(conditionname);
+        if (mine.length === 0) {
+            sayOnce('custom:' + conditionname, 'AppticsRemoteConfig: no value for the custom condition "' + conditionname // no i18n
+                + '"; set one with setCustomConditionValue, or it will not match'); // no i18n
+            return false;
+        }
+        // 'in': one of the values the app set is one of the listed ones
+        return mine.some(function (one) { return listed.indexOf(one) !== -1; });
+    }
     var fact = FACTS[key];
-    // not something a browser knows about itself: a custom criteria, answered by what the app set
-    // with setCustomConditionValue
-    var actual = fact !== undefined ? fact() : custom.customConditionValue(key);
-    if (actual === undefined) {
-        sayOnce('key:' + key, 'AppticsRemoteConfig: no value for criteria "' + key // no i18n
-            + '"; set one with setCustomConditionValue, or conditions using it will not match'); // no i18n
+    if (fact === undefined) {
+        // not something a browser knows about itself
+        sayOnce('key:' + key, 'AppticsRemoteConfig: unknown criteria "' + key // no i18n
+            + '", so conditions using it will not match'); // no i18n
         return false;
     }
+    var actual = fact();
     if (actual === '') {
         return false;
     }
     // 'in': the device's value is one of the listed ones. Compared as strings because that is
     // what both sides are - '1.1' is a version, not the number 1.1
-    return valuesOf(criteria).indexOf(actual) !== -1;
+    return listed.indexOf(actual) !== -1;
 }
 /**
  * Whether a condition holds: every one of its criteria must. The template requires at least one
@@ -101,43 +121,40 @@ function conditionMatches(condition) {
         return false;
     }
     for (var i = 0; i < criterias.length; i++) {
-        if (!criteriaMatches(criterias[i])) {
+        if (!criteriaMatches(criterias[i], String(condition.conditionname || ''))) { // no i18n
             return false;
         }
     }
     return true;
 }
-/** The conditions a parameter names, in the order the console put them in. */
-function orderedConditions(parameter) {
-    var mapped = parameter.conditions;
-    if (!Array.isArray(mapped)) {
-        return [];
-    }
-    return mapped.slice().sort(function (a, b) {
-        return Number(a.conditionorder || 0) - Number(b.conditionorder || 0); // no i18n
-    });
-}
 /**
  * The value of one parameter on this device, as the string the server stores it as.
  *
- * `byId` is every condition the answer carried, keyed by its id — the mapping on the parameter
- * names a condition but does not repeat its criteria.
+ * `conditions` is `all_condition` as the server sent it: its order is the order they are tried
+ * in. The parameter's own `conditions` say which of them apply to it, and with what value.
  */
-function resolve(parameter, byId) {
-    var mapped = orderedConditions(parameter);
-    for (var i = 0; i < mapped.length; i++) {
-        var link = mapped[i];
-        var condition = byId[String(link.conditionid)];
-        if (condition === undefined) {
-            // the parameter points at a condition the answer did not include
-            sayOnce('missing:' + link.conditionid, 'AppticsRemoteConfig: parameter "' + parameter.paramname // no i18n
-                + '" uses condition ' + link.conditionid + ', which the server did not send'); // no i18n
-            continue;
-        }
-        if (conditionMatches(condition)) {
+function resolve(parameter, conditions) {
+    var links = {};
+    (Array.isArray(parameter.conditions) ? parameter.conditions : []).forEach(function (link) {
+        links[String(link.conditionid)] = link;
+    });
+    var sent = {};
+    for (var i = 0; i < conditions.length; i++) {
+        var condition = conditions[i];
+        var id = String(condition.conditionid);
+        sent[id] = true;
+        var link = links[id];
+        if (link !== undefined && conditionMatches(condition)) {
             return String(link.value === undefined || link.value === null ? '' : link.value);
         }
     }
+    Object.keys(links).forEach(function (id) {
+        if (!sent[id]) {
+            // the parameter points at a condition the answer did not include
+            sayOnce('missing:' + id, 'AppticsRemoteConfig: parameter "' + parameter.paramname // no i18n
+                + '" uses condition ' + id + ', which the server did not send'); // no i18n
+        }
+    });
     return String(parameter.defaultvalue === undefined || parameter.defaultvalue === null ? '' : parameter.defaultvalue);
 }
 /**
@@ -151,16 +168,12 @@ function resolveAll(remoteconfig) {
     var out = {};
     var parameters = Array.isArray(remoteconfig.all_parameter) ? remoteconfig.all_parameter : [];
     var conditions = Array.isArray(remoteconfig.all_condition) ? remoteconfig.all_condition : [];
-    var byId = {};
-    conditions.forEach(function (condition) {
-        byId[String(condition.conditionid)] = condition;
-    });
     parameters.forEach(function (parameter) {
         var name = String(parameter.paramname || ''); // no i18n
         if (name === '') {
             return;
         }
-        out[name] = resolve(parameter, byId);
+        out[name] = resolve(parameter, conditions);
     });
     return out;
 }

package/dist/cjs/remoteconfig/fetch.d.ts

@@ -1,22 +1,29 @@
 /**
- * Asks for the rule set, if anything has changed since the last one.
+ * Asks for the rule set: the whole of it with flagtime 0 on the first fetch of a page load, then
+ * only what changed since the last answered request, which is merged into what is stored.
  *
- * Resolves with the parameters as they stand afterwards, whether or not the answer carried a new
- * rule set — an answer with no `remoteconfig` block means nothing has changed, which is the
- * normal case and not a failure.
+ * Resolves with the answer, whether or not it carried a rule set — a later answer with no
+ * `remoteconfig` block means nothing has changed, which is the normal case and not a failure.
  *
- * A second caller joins the first rather than making another request.
+ * With `whole`, a cold fetch: flagtime 0 whatever this page has fetched already, and the answer
+ * replaces the stored set as the first fetch of a page load does.
+ *
+ * A second caller joins the first rather than making another request. A cold fetch joins one
+ * only when it asked with flagtime 0 too, and otherwise asks once it has answered.
  */
-export declare function fetchRemoteConfig(): Promise<Record<string, unknown>>;
+export declare function fetchRemoteConfig(whole?: boolean): Promise<Record<string, unknown>>;
 /**
  * reset(): forgets the rule set, its values and what the server last reported, and disowns a
  * request still in flight, whose answer would otherwise put the old rule set back.
  */
 export declare function resetRemoteConfig(): void;
 /**
- * Makes sure the values are this page's own: from a fetch that just succeeded, or one within
- * CACHE_MS. Resolves true when they are, false when the fetch failed, could not be made, or was
- * past the coldFetch limit — the caller then decides whether stored values will do. Never rejects.
+ * Makes sure the values are this page's own: from a fetch on this page that succeeded, kept up to
+ * date by the polling after it. With `coldFetch`, a fetch with flagtime 0 now, whatever this page
+ * already has, whose answer replaces what is stored: at most COLD_LIMIT a minute, and one past
+ * that answers from what this page has. Resolves true when they are, false when the
+ * fetch failed or could not be made — the caller then decides whether stored values will do.
+ * Never rejects.
  *
  * Waits for start-up and for the device to be registered, which a first visit is still doing
  * when ready() resolves: getupdates is refused without the device ids.