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

package/dist/esm/core/framework-id.d.ts

@@ -1 +1 @@
-export declare const FRAMEWORK_ID = 6002;
+export declare const FRAMEWORK_ID = 6003;

package/dist/esm/core/framework-id.js

@@ -1,7 +1,7 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 // Generated by scripts/register-version.mjs — do not edit by hand.
 // The framework id Apptics issued for this SDK, from POST /sdk/web/v1/framework/addversion
-// (version 2.0.0-beta.1, platform Browser). Regenerated on every npm pack.
-const FRAMEWORK_ID = 6002;
+// (version 2.0.0-beta.2, platform Browser). Regenerated on every npm pack.
+const FRAMEWORK_ID = 6003;
 
 export { FRAMEWORK_ID };

package/dist/esm/core/guard.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { _ZAP } from './state.js';
 import { warnAlways, logFailure } from './logger.js';
 

package/dist/esm/core/hooks.d.ts

@@ -36,4 +36,9 @@ export declare const hooks: {
     remoteConfigStarted: () => void;
     /** Set by remoteconfig/fetch.ts: AppticsUser.setUser changed who this is, so conditions on the user re-apply. */
     remoteConfigUserChanged: () => void;
+    /**
+     * Set by device/index.ts: getsdkconfig is asked now, outside its next_check_after. setUser calls
+     * it once a user is registered, and remote config when getupdates reports a module changed.
+     */
+    askServerSettings: () => void;
 };

package/dist/esm/core/hooks.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 /**
  * Late-bound calls from lower modules up to the modules above them (see spec §5). device.ts and
  * remotelog/index.ts assign these when they are evaluated; the defaults only run if that module
@@ -15,6 +15,7 @@ const hooks = {
     screenTrackedByApp: () => { },
     remoteConfigStarted: () => { },
     remoteConfigUserChanged: () => { },
+    askServerSettings: () => { },
 };
 
 export { hooks };

package/dist/esm/core/locks.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 /**
  * Runs `run` while holding the Web Lock `name`, waiting for it if another tab of this site holds
  * it. Locks are shared by every tab of an origin, which is what keeps two tabs from registering

package/dist/esm/core/logger.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { _ZAP } from './state.js';
 import { each } from './utils.js';
 

package/dist/esm/core/state.d.ts

@@ -1,4 +1,4 @@
-import { type ApConfig } from './constants.js';
+import { type ApConfig, type EngagementType } from './constants.js';
 import type { DeviceInfo, Dict, QuartzSettings, TrackingStatus, UserInfo } from '../types.js';
 /** Runtime state shared by every module (the former `_ZAP` object). */
 export interface State {
@@ -19,7 +19,6 @@ export interface State {
     _token: string;
     _frameworkID: number;
     _platform: string;
-    _isanonrequired: boolean;
     _devicestatus: TrackingStatus;
     _uuid: string;
     _apid: string;
@@ -30,9 +29,12 @@ export interface State {
     _current_session: Dict;
     _properties: Dict;
     _ignoreDnt: boolean;
-    _isGlobalErrorTracking: boolean;
     _shouldTrack: boolean;
-    _engagementTracking: boolean;
+    /**
+     * getsdkconfig's engagement modules, one per kind of item, keyed by the item's type: event (5),
+     * api (6), screen (10) and session (11).
+     */
+    _engagementTracking: Record<EngagementType, boolean>;
     _errorTracking: boolean;
     /** getsdkconfig module 18. Heatmap has its own flag in v2; before that it rode engagement. */
     _heatmapTracking: boolean;

package/dist/esm/core/state.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { AP_TRACKING_STATUS, AP_CONSTANTS, DEFAULT_INACTIVE_MINUTES, AP_CONFIG } from './constants.js';
 import { nowMs } from './utils.js';
 import { FRAMEWORK_ID } from './framework-id.js';
@@ -21,7 +21,6 @@ function initialState() {
         // issued by Apptics at pack time; see scripts/register-version.mjs
         _frameworkID: FRAMEWORK_ID,
         _platform: AP_CONSTANTS.BROWSER,
-        _isanonrequired: true,
         _devicestatus: AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII,
         _uuid: '', // no i18n
         _apid: '', // no i18n
@@ -32,9 +31,8 @@ function initialState() {
         _current_session: {},
         _properties: {},
         _ignoreDnt: false,
-        _isGlobalErrorTracking: true,
         _shouldTrack: true,
-        _engagementTracking: true,
+        _engagementTracking: { event: true, screen: true, session: true, api: true },
         _heatmapTracking: true,
         _remoteLoggerEnabled: true,
         _remoteConfigEnabled: true,

package/dist/esm/core/storage.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { AP_TRACKING_STATUS } from './constants.js';
 import { _ZAP, isExpired, getConfig } from './state.js';
 import { Console } from './logger.js';
@@ -291,9 +291,6 @@ const tracking_preference = {
     },
     update_status(tracking_status) {
         _ZAP._devicestatus = tracking_status;
-        // Legacy order kept: this reads the status *before* the write below (setTrackingStatus recomputes it after).
-        _ZAP._isanonrequired =
-            tracking_preference.opt_in_status() == AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII ? false : _ZAP._isanonrequired;
         var track = Object.assign({}, settings.trackinfo && typeof settings.trackinfo === 'object' ? settings.trackinfo : {}); // no i18n
         track.tracking_status = tracking_status;
         if (_ZAP._trackinfo && typeof _ZAP._trackinfo === 'object') { // no i18n

package/dist/esm/core/stylesheet.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 /**
  * Adds the feedback form's styles to the page, once, as a <style> element, so no app imports or
  * links a stylesheet: the css is carried in the JavaScript, for npm and the CDN builds alike.

package/dist/esm/core/transport.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { API_VERSIONS, PATHS_WITHOUT_ORG, DEFAULT_API_PATHS, DEBUG_CAPABLE_PATHS, AP_TRACKING_STATUS, DEVICE_NAME_MAX } from './constants.js';
 import { getConfig, _ZAP } from './state.js';
 import { Console } from './logger.js';
@@ -139,19 +139,17 @@ function getParameters(path) {
     // v2 device/add declares neither identifier, platform nor appversion: the build is already
     // known from app/addversion, and sending an undeclared param is refused as EXTRA_PARAM_FOUND.
     // What it does declare as mandatory is appversionid, which v1 treated as optional.
+    // isanonrequired is always false: the web SDK has no anonymous mode, only the tracking
+    // statuses (with PII, without PII, none), which devicestatus carries.
     if (path == 'regdevice') { // no i18n
-        returnVal = '?isanonrequired=' + _ZAP._isanonrequired + '&devicestatus=' + _ZAP._devicestatus; // no i18n
+        returnVal = '?isanonrequired=false&devicestatus=' + _ZAP._devicestatus; // no i18n
         if (!isEmpty(_ZAP._device_info.deviceid)) {
             returnVal += '&deviceid=' + encodeURIComponent(String(_ZAP._device_info.deviceid)); // no i18n
         }
         return returnVal + mandatoryParams(returnVal);
     }
-    // getsdkconfig is the one call that must NOT carry deviceid: it declares the param with
-    // decrypt-label="authenticate", which a web SDK cannot satisfy, and sending it is answered
-    // with NOT_AUTHENTICATED. getupdates declares the same param with plain paramdecrypt, so it
-    // does carry one. It still needs appversionid and frameworkid, added at the end.
-    var identifiesDevice = path != 'sdkconfig'; // no i18n
-    if (identifiesDevice) {
+    // getsdkconfig carries no deviceid: the user's ids below are what it answers for
+    if (path != 'sdkconfig') { // no i18n
         if (isEmpty(_ZAP._device_info.deviceid)) {
             hooks.refreshDeviceInfo();
             // the device is missing, but appversionid and frameworkid are mandatory regardless:
@@ -176,14 +174,13 @@ function getParameters(path) {
     // them, and refuses userid as EXTRA_PARAM_FOUND; it has no use for them either, since remote
     // config conditions on the user are evaluated here, against the rule set it answers with
     var carriesUser = path != 'reguser' && path != 'getupdates'; // no i18n
-    if (carriesUser && identifiesDevice) {
-        if (opt_in_status() == AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII) {
-            if (_ZAP._user_info.hasOwnProperty('userid') && !isEmpty(_ZAP._user_info.userid)) { // no i18n
-                returnVal += '&userid=' + encodeURIComponent(String(_ZAP._user_info.userid)); // no i18n
-            }
-            if (_ZAP._user_info.hasOwnProperty('groupid') && !isEmpty(_ZAP._user_info.groupid)) { // no i18n
-                returnVal += '&customergroupid=' + encodeURIComponent(String(_ZAP._user_info.groupid)); // no i18n
-            }
+    if (carriesUser && opt_in_status() == AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII) {
+        if (_ZAP._user_info.hasOwnProperty('userid') && !isEmpty(_ZAP._user_info.userid)) { // no i18n
+            // getsdkconfig has no deviceid before it, so its userid starts the query
+            returnVal += (returnVal === '' ? '?' : '&') + 'userid=' + encodeURIComponent(String(_ZAP._user_info.userid)); // no i18n
+        }
+        if (_ZAP._user_info.hasOwnProperty('groupid') && !isEmpty(_ZAP._user_info.groupid)) { // no i18n
+            returnVal += (returnVal === '' ? '?' : '&') + 'customergroupid=' + encodeURIComponent(String(_ZAP._user_info.groupid)); // no i18n
         }
     }
     returnVal += deviceNameParam(path, returnVal);

package/dist/esm/core/utils.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { AP_CONSTANTS } from './constants.js';
 
 /** Returned from an `each` iterator to stop iterating objects and array-likes. */

package/dist/esm/core/validate.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { Console } from './logger.js';
 import { isEmpty, isEmptyObj } from './utils.js';
 

package/dist/esm/device/appversion.d.ts

@@ -1,4 +1,13 @@
-/** Whether we already hold usable ids for the app and version running now. */
+/**
+ * A fingerprint of the auth key, which is what is stored to tell one key from another: enough to
+ * notice that init() was given a different one, without keeping a second copy of the key itself.
+ * FNV-1a, 32 bits, as hex; '' for no key.
+ */
+export declare function keyFingerprint(key: unknown): string;
+/**
+ * Whether we already hold usable ids for the app, auth key and version running now. Ids stored by
+ * a build that kept no key fingerprint register again once, and the answer then records it.
+ */
 export declare function hasAppVersion(): boolean;
 export declare function appVersionFailedForNetwork(): boolean;
 export declare function registerAppVersion(): Promise<boolean>;

package/dist/esm/device/appversion.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { _ZAP } from '../core/state.js';
 import { Console, warnAlways } from '../core/logger.js';
 import { isEmpty, isSuccess } from '../core/utils.js';
@@ -37,13 +37,34 @@ const REQUIRED_KEYS = ['aaid', 'portalid', 'projectid', 'apid', 'mapid', 'appver
 function missingKeys(data) {
     return REQUIRED_KEYS.filter(function (key) { return isEmpty(data[key]); });
 }
-/** Whether we already hold usable ids for the app and version running now. */
+/**
+ * A fingerprint of the auth key, which is what is stored to tell one key from another: enough to
+ * notice that init() was given a different one, without keeping a second copy of the key itself.
+ * FNV-1a, 32 bits, as hex; '' for no key.
+ */
+function keyFingerprint(key) {
+    var text = isEmpty(key) ? '' : String(key); // no i18n
+    if (text === '') { // no i18n
+        return ''; // no i18n
+    }
+    var hash = 0x811c9dc5;
+    for (var i = 0; i < text.length; i++) {
+        hash ^= text.charCodeAt(i);
+        hash = Math.imul(hash, 0x01000193) >>> 0;
+    }
+    return ('0000000' + hash.toString(16)).slice(-8); // no i18n
+}
+/**
+ * Whether we already hold usable ids for the app, auth key and version running now. Ids stored by
+ * a build that kept no key fingerprint register again once, and the answer then records it.
+ */
 function hasAppVersion() {
     var saved = stored();
     return missingKeys(saved).length === 0
         && saved.appversion === _ZAP._defaultoptions.appversion
         && saved.identifier === _ZAP._defaultoptions.identifier
-        && saved.serviceUrl === _ZAP._defaultoptions.serviceUrl;
+        && saved.serviceUrl === _ZAP._defaultoptions.serviceUrl
+        && saved.zakhash === keyFingerprint(_ZAP._defaultoptions.zak);
 }
 /** Puts the ids where the rest of the SDK reads them from. */
 function apply(data) {
@@ -124,6 +145,7 @@ function registerAppVersion() {
             appversion: _ZAP._defaultoptions.appversion,
             identifier: _ZAP._defaultoptions.identifier,
             serviceUrl: _ZAP._defaultoptions.serviceUrl,
+            zakhash: keyFingerprint(_ZAP._defaultoptions.zak),
         };
         RESULT_KEYS.forEach(function (key) {
             if (!isEmpty(data[key])) {
@@ -161,4 +183,4 @@ function clearAppVersion() {
     user_defaults.add(STORE_KEY, undefined);
 }
 
-export { appVersionFailedForNetwork, applyStoredAppVersion, clearAppVersion, hasAppVersion, registerAppVersion };
+export { appVersionFailedForNetwork, applyStoredAppVersion, clearAppVersion, hasAppVersion, keyFingerprint, registerAppVersion };

package/dist/esm/device/index.d.ts

@@ -28,7 +28,22 @@ export declare function getUpdatesFromServer(): Promise<Dict>;
  */
 export declare function restoreServerSettings(): void;
 /**
- * Fetches the server settings now if the device is registered. On a first visit the ids don't
- * exist yet; registerDeviceWithApptics calls this as soon as device/add succeeds.
+ * next_check_after as a time: the server's value is milliseconds, either a timestamp or a wait
+ * from now. Anything below 1e12 (2001 as a timestamp) can only be a wait.
+ */
+export declare function nextCheckTime(value: unknown, now: number): number;
+/**
+ * Asks for the server settings now if the device is registered, then schedules the next ask
+ * for the time the answer gave in next_check_after. On a first visit the ids don't exist yet;
+ * registerDeviceWithApptics calls this as soon as device/add succeeds.
  */
 export declare function refreshServerSettings(): void;
+/**
+ * Start-up's getsdkconfig. Asked on a first visit and on the first page load in each tab; any
+ * other load (a reload, a link to another page of the site, back/forward) uses the saved answer
+ * and waits for its next_check_after, unless that has already passed. Nothing happens if one has
+ * gone out already on this load (after device/add).
+ */
+export declare function startServerSettingChecks(): void;
+/** reset(): no more checks, and the next init() asks again straight away. */
+export declare function stopServerSettingChecks(): void;

package/dist/esm/device/index.js

@@ -1,8 +1,8 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { SDK_MODULE } from '../core/constants.js';
-import { _ZAP } from '../core/state.js';
+import { _ZAP, getConfig } from '../core/state.js';
 import { Console } from '../core/logger.js';
-import { isEmpty, getNewUUID, isSuccess, compareTwoObjects } from '../core/utils.js';
+import { isEmpty, nowMs, getNewUUID, isSuccess, compareTwoObjects } from '../core/utils.js';
 import { user_defaults, getKeyFromDeviceInfo, setDeviceInfoKey, storedTrackingStatus, reloadSettings } from '../core/storage.js';
 import { withLock } from '../core/locks.js';
 import { getTimeZone, getConnectionType, getReferringURL, getDevice, getBrowserVersion, getBrowser, getOS } from '../core/env.js';
@@ -106,10 +106,18 @@ function checkAndUpdateDeviceInfo() {
     user_defaults.add('device_info', _ZAP._device_info); // no i18n
     addOrUpdateDeviceID(_ZAP._device_info, previous);
 }
+/**
+ * Whether device/add has registered this device: it has a deviceid. anonymousid is not required:
+ * not every Apptics server sends one, nothing the SDK sends carries it, and requiring it had a
+ * server that leaves it out register the same device again on every page load.
+ */
+function isRegistered(info) {
+    return !!info && !isEmpty(info.deviceid);
+}
 function addOrUpdateDeviceID(device_info, previous) {
     var old_device_info = previous !== undefined ? previous : user_defaults.item('device_info') || {}; // no i18n
     // Compare the old and new device infos and update the server if anything changed in the new.
-    if (device_info.deviceid == null || device_info.frameworkid == null || device_info.anonymousid == null) {
+    if (!isRegistered(device_info) || device_info.frameworkid == null) {
         device_info.frameworkid = _ZAP._frameworkID;
         Console.log('addOrUpdateDeviceID: Initiated register the device'); // no i18n
         registerDeviceWithApptics().then(function (result_device_info) {
@@ -186,7 +194,7 @@ function useStoredUuid() {
 function adoptRegisteredDevice() {
     return reloadSettings(['device_info']).then(function () {
         var stored = user_defaults.item('device_info') || {}; // no i18n
-        if (isEmpty(stored.deviceid) || isEmpty(stored.anonymousid)) {
+        if (!isRegistered(stored)) {
             return null;
         }
         // the device is registered under the uuid the other tab sent
@@ -211,7 +219,7 @@ function adoptRegisteredDevice() {
  */
 function prepareDevice() {
     var cached = user_defaults.item('device_info') || {}; // no i18n
-    if (!isEmpty(cached.deviceid) && !isEmpty(cached.anonymousid)) {
+    if (isRegistered(cached)) {
         useStoredUuid();
         checkAndUpdateDeviceInfo();
         return Promise.resolve();
@@ -276,7 +284,7 @@ function registerDeviceWithApptics() {
     if (offline) {
         return offline;
     }
-    if (_ZAP._device_info.deviceid && _ZAP._device_info.anonymousid) {
+    if (isRegistered(_ZAP._device_info)) {
         return Promise.resolve(_ZAP._device_info);
     }
     return new Promise((resolve, reject) => {
@@ -304,8 +312,10 @@ function registerDeviceWithApptics() {
         }).then(function (result) {
             settleRegistration(true, result);
             resolve(result);
-            // first visit: the ids exist now, so fetch the server settings right away
-            refreshServerSettings();
+            // first visit: the ids exist now, so fetch the server settings right away. A device
+            // registered again later (its details or the framework id changed) asks nothing more:
+            // start-up has already asked on this page load
+            startServerSettingChecks();
         }).catch(function (err) {
             settleRegistration(false, err);
             reject(err);
@@ -337,6 +347,12 @@ function getUpdatesFromServer() {
     return postToApptics('sdkconfig', '', apiHeaders(), label).then(function (result) {
         var data = result.data || {};
         applyServerFlags(data);
+        if (_ZAP._nextConfigCheck === 0) {
+            // no next_check_after: getupdates_interval from now, stored so a later page load
+            // can tell whether the answer is still current
+            _ZAP._nextConfigCheck = nowMs() + getConfig('getupdates_interval'); // no i18n
+            _ZAP._trackinfo.next_check_after = _ZAP._nextConfigCheck;
+        }
         // the visitor's tracking status lives in trackinfo too, and is not the server's to replace
         var saved = storedTrackingStatus();
         user_defaults.add('trackinfo', saved === undefined ? _ZAP._trackinfo : Object.assign({}, _ZAP._trackinfo, { tracking_status: saved })); // no i18n
@@ -372,6 +388,10 @@ function applyServerFlags(data) {
     if (data.hasOwnProperty('tracking_enabled')) { // no i18n
         _ZAP._shouldTrack = data.tracking_enabled !== false;
     }
+    else if (data.hasOwnProperty('shouldtrack')) { // no i18n
+        // what this SDK saves, read back on the next visit
+        _ZAP._shouldTrack = data.shouldtrack !== false;
+    }
     else {
         // the old shape: archived versions and untracked customer groups
         var versionArchived = !data.hasOwnProperty('versionarchivestatus') || isEmpty(data.versionarchivestatus)
@@ -381,9 +401,14 @@ function applyServerFlags(data) {
         _ZAP._shouldTrack = versionArchived || !customerGroupTracking;
     }
     if (hasModules) {
-        // sessions carry screens, events and api calls, so module 11 gates all of engagement
-        _ZAP._engagementTracking = moduleEnabled(status, SDK_MODULE.SESSION);
-        _ZAP._errorTracking = moduleEnabled(status, SDK_MODULE.CRASH);
+        // each kind of engagement item has its own module, so the server can turn one off alone
+        _ZAP._engagementTracking = {
+            event: moduleEnabled(status, SDK_MODULE.EVENT),
+            api: moduleEnabled(status, SDK_MODULE.API),
+            screen: moduleEnabled(status, SDK_MODULE.SCREEN),
+            session: moduleEnabled(status, SDK_MODULE.SESSION),
+        };
+        _ZAP._errorTracking = moduleEnabled(status, SDK_MODULE.JS_ERROR);
         _ZAP._heatmapTracking = moduleEnabled(status, SDK_MODULE.HEATMAP);
         _ZAP._remoteLoggerEnabled = moduleEnabled(status, SDK_MODULE.REMOTE_LOGGER);
         _ZAP._feedbackEnabled = moduleEnabled(status, SDK_MODULE.FEEDBACK);
@@ -392,11 +417,22 @@ function applyServerFlags(data) {
         _ZAP._remoteConfigEnabled = moduleEnabled(status, SDK_MODULE.REMOTE_CONFIG);
     }
     else {
-        _ZAP._engagementTracking = data.engagementtracking !== false;
-        _ZAP._errorTracking = data.errortracking !== false;
-        _ZAP._heatmapTracking = data.heatmaptracking !== false;
-        _ZAP._remoteLoggerEnabled = data.remoteloggerenabled !== false;
-        _ZAP._feedbackEnabled = data.feedbackenabled !== false;
+        // this SDK saves one flag per kind under engagement; an earlier build saved one
+        // engagementtracking flag for all four
+        var saved = (data.engagement && typeof data.engagement === 'object' // no i18n
+            ? data.engagement : null);
+        var kindOn = function (kind) {
+            return saved ? saved[kind] !== false : data.engagementtracking !== false;
+        };
+        _ZAP._engagementTracking = { event: kindOn('event'), api: kindOn('api'), screen: kindOn('screen'), session: kindOn('session') }; // no i18n
+        // the same for the others: read the short key this SDK saves, else the earlier build's
+        var flagOn = function (key, oldKey) {
+            return (data.hasOwnProperty(key) ? data[key] : data[oldKey]) !== false;
+        };
+        _ZAP._errorTracking = flagOn('error', 'errortracking'); // no i18n
+        _ZAP._heatmapTracking = flagOn('heatmap', 'heatmaptracking'); // no i18n
+        _ZAP._remoteLoggerEnabled = flagOn('remotelogger', 'remoteloggerenabled'); // no i18n
+        _ZAP._feedbackEnabled = flagOn('feedback', 'feedbackenabled'); // no i18n
     }
     // screen recording, set up in the console: everything the form needs comes from here
     var quartz = (data.quartz && typeof data.quartz === 'object' ? data.quartz : {});
@@ -410,16 +446,15 @@ function applyServerFlags(data) {
         domain: text(quartz.quartz_domain),
         cdnUrl: text(quartz.quartz_cdn_url),
     };
-    // when to ask again, which replaces polling on a fixed interval
-    if (typeof data.next_check_after === 'number' && data.next_check_after > 0) {
-        _ZAP._nextConfigCheck = data.next_check_after;
-    }
+    // when to ask again, which replaces polling on a fixed interval. Kept as a timestamp, so the
+    // stored copy reads back the same. An answer without one falls back to getupdates_interval
+    _ZAP._nextConfigCheck = nextCheckTime(data.next_check_after, nowMs());
     _ZAP._trackinfo = {
-        engagementtracking: _ZAP._engagementTracking,
-        errortracking: _ZAP._errorTracking,
-        heatmaptracking: _ZAP._heatmapTracking,
-        remoteloggerenabled: _ZAP._remoteLoggerEnabled,
-        feedbackenabled: _ZAP._feedbackEnabled,
+        engagement: _ZAP._engagementTracking,
+        error: _ZAP._errorTracking,
+        heatmap: _ZAP._heatmapTracking,
+        remotelogger: _ZAP._remoteLoggerEnabled,
+        feedback: _ZAP._feedbackEnabled,
         // in the server's own shape, so restoring it on the next visit reads it the same way
         quartz: {
             quartz_enabled: _ZAP._quartz.enabled,
@@ -440,22 +475,152 @@ function restoreServerSettings() {
     var saved = user_defaults.item('trackinfo'); // no i18n
     if (saved && typeof saved === 'object') { // no i18n
         applyServerFlags(saved);
+        // saved by an earlier build under the old names: store it again in this SDK's shape now,
+        // rather than at the next getsdkconfig, which may be a while off. The visitor's tracking
+        // status is kept as it is
+        if (OLD_TRACKINFO_KEYS.some(function (key) { return saved.hasOwnProperty(key); })) {
+            user_defaults.add('trackinfo', saved.tracking_status === undefined ? _ZAP._trackinfo // no i18n
+                : Object.assign({}, _ZAP._trackinfo, { tracking_status: saved.tracking_status }));
+        }
         Console.log('restoreServerSettings: ' + JSON.stringify(_ZAP._trackinfo)); // no i18n
     }
 }
+/** trackinfo keys an earlier build saved, which this SDK saves under shorter names. */
+var OLD_TRACKINFO_KEYS = ['engagementtracking', 'errortracking', 'heatmaptracking', 'remoteloggerenabled', 'feedbackenabled']; // no i18n
+/**
+ * next_check_after as a time: the server's value is milliseconds, either a timestamp or a wait
+ * from now. Anything below 1e12 (2001 as a timestamp) can only be a wait.
+ */
+function nextCheckTime(value, now) {
+    if (typeof value !== 'number' || !(value > 0)) { // no i18n
+        return 0;
+    }
+    return value >= 1e12 ? value : now + value;
+}
+/** setTimeout's longest wait; a longer one fires straight away. */
+var MAX_TIMEOUT = 2147483647;
+var configTimer = null;
+var configInFlight = false;
+/** Bumped by stopServerSettingChecks(), so an answer to an ask from before a reset schedules nothing. */
+var configRound = 0;
+/** Whether this page load has asked, or set the timer from the saved answer instead. */
+var configAsked = false;
+/** A user registered, or getupdates reported a change, while a getsdkconfig was in flight: asked again when it answers. */
+var configAskAgain = false;
+/** When the next getsdkconfig is due, as a timestamp. 0 until the first answer. */
+var configDueAt = 0;
 /**
- * Fetches the server settings now if the device is registered. On a first visit the ids don't
- * exist yet; registerDeviceWithApptics calls this as soon as device/add succeeds.
+ * Asks for the server settings now if the device is registered, then schedules the next ask
+ * for the time the answer gave in next_check_after. On a first visit the ids don't exist yet;
+ * registerDeviceWithApptics calls this as soon as device/add succeeds.
  */
 function refreshServerSettings() {
-    if (isEmpty(getHeaderParams('apid')) && isEmpty(getHeaderParams('mapid'))) { // no i18n
+    if (configInFlight || !hasDeviceId() || (isEmpty(getHeaderParams('apid')) && isEmpty(getHeaderParams('mapid')))) { // no i18n
         return;
     }
+    if (configTimer !== null) {
+        clearTimeout(configTimer);
+        configTimer = null;
+    }
+    configInFlight = true;
+    configAsked = true;
+    markTabAsked();
+    var round = configRound;
+    var askedAt = nowMs();
     getUpdatesFromServer().catch(function (err) {
         Console.log(err);
+    }).then(function () {
+        if (round !== configRound) {
+            // stopServerSettingChecks() ran while this was in flight
+            return;
+        }
+        configInFlight = false;
+        if (configAskAgain) {
+            configAskAgain = false;
+            refreshServerSettings();
+            return;
+        }
+        // an answer without a usable next_check_after, or a failed call, waits getupdates_interval
+        configDueAt = _ZAP._nextConfigCheck > nowMs() ? _ZAP._nextConfigCheck : askedAt + getConfig('getupdates_interval'); // no i18n
+        scheduleServerSettingCheck();
     });
 }
+/**
+ * getsdkconfig now, not at the next check: setUser registered a user, or getupdates reported a
+ * module changed.
+ */
+function askServerSettings() {
+    if (configInFlight) {
+        // the one in flight went out before the change: ask again once it answers
+        configAskAgain = true;
+        return;
+    }
+    refreshServerSettings();
+}
+/**
+ * Start-up's getsdkconfig. Asked on a first visit and on the first page load in each tab; any
+ * other load (a reload, a link to another page of the site, back/forward) uses the saved answer
+ * and waits for its next_check_after, unless that has already passed. Nothing happens if one has
+ * gone out already on this load (after device/add).
+ */
+function startServerSettingChecks() {
+    if (configAsked) {
+        return;
+    }
+    if (tabHasAsked() && _ZAP._nextConfigCheck > nowMs()) {
+        Console.log('getsdkconfig: the saved answer is still current'); // no i18n
+        configAsked = true;
+        configDueAt = _ZAP._nextConfigCheck;
+        scheduleServerSettingCheck();
+        return;
+    }
+    refreshServerSettings();
+}
+/** sessionStorage: per tab, and kept across a reload and the site's own links. */
+var TAB_ASKED_KEY = '_apptics_sdkconfig_asked'; // no i18n
+/** Whether getsdkconfig has gone out in this tab before, on an earlier page load. */
+function tabHasAsked() {
+    try {
+        return sessionStorage.getItem(TAB_ASKED_KEY) === '1'; // no i18n
+    }
+    catch (e) {
+        return false; // no sessionStorage (private mode, sandboxed frame): every load asks
+    }
+}
+function markTabAsked() {
+    try {
+        sessionStorage.setItem(TAB_ASKED_KEY, '1'); // no i18n
+    }
+    catch (e) {
+        // as above: without it, every load asks
+    }
+}
+/** Sets the timer for the next getsdkconfig, at configDueAt. */
+function scheduleServerSettingCheck() {
+    if (configTimer !== null) {
+        clearTimeout(configTimer);
+    }
+    var wait = Math.min(Math.max(configDueAt - nowMs(), 0), MAX_TIMEOUT);
+    Console.log('getsdkconfig: next check in ' + wait + ' ms'); // no i18n
+    configTimer = setTimeout(function () {
+        configTimer = null;
+        refreshServerSettings();
+    }, wait);
+}
+/** reset(): no more checks, and the next init() asks again straight away. */
+function stopServerSettingChecks() {
+    if (configTimer !== null) {
+        clearTimeout(configTimer);
+    }
+    configTimer = null;
+    configRound++;
+    configInFlight = false;
+    configAsked = false;
+    configAskAgain = false;
+    configDueAt = 0;
+}
 hooks.updateDevice = updateDeviceWithApptics;
 hooks.refreshDeviceInfo = checkAndUpdateDeviceInfo;
+hooks.askServerSettings = askServerSettings;
 
-export { addOrUpdateDeviceID, checkAndUpdateDeviceInfo, deviceReady, getUpdatesFromServer, needsDevice, prepareDevice, refreshServerSettings, registerDeviceWithApptics, restoreServerSettings, updateDeviceWithApptics };
+export { addOrUpdateDeviceID, checkAndUpdateDeviceInfo, deviceReady, getUpdatesFromServer, needsDevice, nextCheckTime, prepareDevice, refreshServerSettings, registerDeviceWithApptics, restoreServerSettings, startServerSettingChecks, stopServerSettingChecks, updateDeviceWithApptics };

package/dist/esm/engagement/api-rules.js

@@ -1,4 +1,4 @@
-/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 import { warnAlways } from '../core/logger.js';
 
 /**