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

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

@@ -1,5 +1,5 @@
-import { type ApConfig } from './constants.js';
-import type { DeviceInfo, Dict, TrackingStatus, UserInfo } from '../types.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 {
     _initialised: boolean;
@@ -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;
@@ -44,7 +46,8 @@ export interface State {
     _remoteConfigReported: boolean;
     /** getsdkconfig module 12. */
     _feedbackEnabled: boolean;
-    _quartzEnabled: boolean;
+    /** getsdkconfig's `quartz` block: screen recording in the feedback form. Off until it says otherwise. */
+    _quartz: QuartzSettings;
     /** Epoch ms getsdkconfig asked us to wait until before asking again. 0 means no answer yet. */
     _nextConfigCheck: number;
     /**

package/dist/cjs/core/state.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 constants = require('./constants.js');
@@ -23,7 +23,6 @@ function initialState() {
         // issued by Apptics at pack time; see scripts/register-version.mjs
         _frameworkID: frameworkId.FRAMEWORK_ID,
         _platform: constants.AP_CONSTANTS.BROWSER,
-        _isanonrequired: true,
         _devicestatus: constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII,
         _uuid: '', // no i18n
         _apid: '', // no i18n
@@ -34,9 +33,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,
@@ -45,7 +43,7 @@ function initialState() {
         _nextConfigCheck: 0,
         _debugUntil: 0,
         _errorTracking: true,
-        _quartzEnabled: true,
+        _quartz: { enabled: false, workspace: '', department: '', domain: '', cdnUrl: '' }, // no i18n
         _trackinfo: {},
     };
 }

package/dist/cjs/core/storage.d.ts

@@ -20,23 +20,38 @@ export declare const error_transactions: Queue;
  * These are not sent on their own: feedback/logs.ts renders them into the files that
  * feedback/add carries, and removes the ones a submission took with it.
  */
-export declare const log_transactions: Queue;
+export declare const feedbacklog_transactions: Queue;
 /** Clicks and scrolls waiting for heatmap/add. */
 export declare const heatmap_transactions: Queue;
 /**
- * Remote log lines waiting for console/addlog. Stored rather than sent straight out because the
+ * Remote log lines waiting for log/add. Stored rather than sent straight out because the
  * endpoint takes one line per call and counts retries (`attempt`), so a line has to outlive a
  * failed send — and a reload.
  */
-export declare const consolelog_transactions: Queue;
-/** Token, uuid, appversion, device_info, users, trackinfo. */
+export declare const remotelog_transactions: Queue;
+/**
+ * Sets one key of the stored device_info, and of this tab's copy: the uuid the device is
+ * registered under, whether it has had a session. Its other keys stay as they are.
+ */
+export declare function setDeviceInfoKey(key: string, value: unknown): void;
+/** device_info (uuid included), app_version_info, trackinfo (tracking_status included), users, user_info, and the rest. */
 export declare const user_defaults: {
     all(): Dict;
     item(key: string): any;
     add(key: string, value: unknown): void;
+    /** As add(), and resolves once the value is in storage, where other tabs can read it. */
+    save(key: string, value: unknown): Promise<void>;
     clear(): void;
 };
-/** Opt-in status, stored as the tracking_status setting. */
+/**
+ * Re-reads `keys` from storage. Settings are loaded into memory once, when a tab starts, so a value
+ * another tab of this site wrote since then — the device ids it registered — is only in storage.
+ * A key storage doesn't hold keeps this tab's value.
+ */
+export declare function reloadSettings(keys: string[]): Promise<void>;
+/** The visitor's tracking status, stored in trackinfo as tracking_status. */
+export declare function storedTrackingStatus(): TrackingStatus | undefined;
+/** Opt-in status, stored in the trackinfo setting as tracking_status. */
 export declare const tracking_preference: {
     _tracking_status: string;
     all(): Dict;

package/dist/cjs/core/storage.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 constants = require('./constants.js');
@@ -30,8 +30,6 @@ function migrateLegacy(b) {
             errors: localStorage.getItem(db.LEGACY_KEYS.errors),
             logs: localStorage.getItem(db.LEGACY_KEYS.logs),
             consolelogs: localStorage.getItem(db.LEGACY_KEYS.consolelogs),
-            // read for completeness of the shape only: 1.x never wrote this key
-            heatmaps: null,
         };
     }
     catch (err) {
@@ -49,15 +47,17 @@ function migrateLegacy(b) {
             return null;
         }
     };
+    // 1.x's keys are logs and consolelogs; they are feedbacklogs and remotelogs now, and a
+    // feedback entry's type is feedbacklog or feedbackdiagnostics instead of log or diagnostics
     var queues = {
         engagements: db.asList(parse(raw.engagements)),
         errors: db.asList(parse(raw.errors)),
-        logs: db.asList(parse(raw.logs)),
-        consolelogs: db.asList(parse(raw.consolelogs)),
+        feedbacklogs: db.asList(parse(raw.logs)).map(db.renameFeedbackType),
+        remotelogs: db.asList(parse(raw.consolelogs)),
         // nothing to migrate: 1.x had no heatmaps
         heatmaps: [],
     };
-    queues.engagements.concat(queues.errors, queues.logs, queues.consolelogs).forEach(function (item) {
+    queues.engagements.concat(queues.errors, queues.feedbacklogs, queues.remotelogs).forEach(function (item) {
         if (!item.id)
             item.id = utils.getNewUUID();
     });
@@ -91,6 +91,7 @@ function storageReady() {
             }).then(function (loaded) {
                 // writes made before loading finished win over stored values
                 settings = Object.assign({}, loaded, settings);
+                moveRetiredSettings();
                 return b;
             });
         }).catch(function (err) {
@@ -161,21 +162,75 @@ const error_transactions = createQueue('errors'); // no i18n
  * These are not sent on their own: feedback/logs.ts renders them into the files that
  * feedback/add carries, and removes the ones a submission took with it.
  */
-const log_transactions = createQueue('logs'); // no i18n
+const feedbacklog_transactions = createQueue('feedbacklogs'); // no i18n
 /** Clicks and scrolls waiting for heatmap/add. */
 const heatmap_transactions = createQueue('heatmaps'); // no i18n
 /**
- * Remote log lines waiting for console/addlog. Stored rather than sent straight out because the
+ * Remote log lines waiting for log/add. Stored rather than sent straight out because the
  * endpoint takes one line per call and counts retries (`attempt`), so a line has to outlive a
  * failed send — and a reload.
  */
-const consolelog_transactions = createQueue('consolelogs'); // no i18n
+const remotelog_transactions = createQueue('remotelogs'); // no i18n
 /* ---------------- settings (sync reads, background writes) ---------------- */
+/** Writes `key`, or removes it from storage altogether when `value` is undefined. */
+function writeSetting(b, key) {
+    return settings[key] === undefined ? b.deleteSetting(key) : b.putSetting(key, settings[key]);
+}
 function setSetting(key, value) {
-    settings[key] = value === undefined ? undefined : utils.cloneObject(value);
-    withBackend('save ' + key, undefined, function (b) { return b.putSetting(key, settings[key]); }); // no i18n
+    if (value === undefined) {
+        delete settings[key];
+    }
+    else {
+        settings[key] = utils.cloneObject(value);
+    }
+    withBackend('save ' + key, undefined, function (b) { return writeSetting(b, key); }); // no i18n
+}
+/**
+ * Settings 2.0.0-beta kept as keys of their own, now kept inside device_info and trackinfo.
+ * Moved once, on the first load after an upgrade, before anything reads them: the uuid is the one
+ * the device is registered under, and the tracking status is the visitor's own choice, so losing
+ * either would register a new device or forget a consent. token was never read, and goes.
+ * appkey and appversion are read and removed by init(), which compares them with this visit's app.
+ */
+function moveRetiredSettings() {
+    var device = settings.device_info && typeof settings.device_info === 'object' ? settings.device_info : null; // no i18n
+    if (settings.uuid !== undefined || settings.hadsession !== undefined) {
+        device = Object.assign({}, device || {});
+        if (utils.isEmpty(device.uuid) && !utils.isEmpty(settings.uuid)) {
+            device.uuid = settings.uuid;
+        }
+        if (settings.hadsession === true) {
+            device.hadsession = true;
+        }
+        setSetting('device_info', device); // no i18n
+        setSetting('uuid', undefined); // no i18n
+        setSetting('hadsession', undefined); // no i18n
+    }
+    if (settings.tracking_status !== undefined) {
+        var track = Object.assign({}, settings.trackinfo && typeof settings.trackinfo === 'object' ? settings.trackinfo : {}); // no i18n
+        if (track.tracking_status === undefined) {
+            track.tracking_status = settings.tracking_status;
+        }
+        setSetting('trackinfo', track); // no i18n
+        setSetting('tracking_status', undefined); // no i18n
+    }
+    if (settings.token !== undefined) {
+        setSetting('token', undefined); // no i18n
+    }
 }
-/** Token, uuid, appversion, device_info, users, trackinfo. */
+/**
+ * Sets one key of the stored device_info, and of this tab's copy: the uuid the device is
+ * registered under, whether it has had a session. Its other keys stay as they are.
+ */
+function setDeviceInfoKey(key, value) {
+    var device = Object.assign({}, settings.device_info && typeof settings.device_info === 'object' ? settings.device_info : {}); // no i18n
+    device[key] = value;
+    if (state._ZAP._device_info && typeof state._ZAP._device_info === 'object') { // no i18n
+        state._ZAP._device_info[key] = value;
+    }
+    setSetting('device_info', device); // no i18n
+}
+/** device_info (uuid included), app_version_info, trackinfo (tracking_status included), users, user_info, and the rest. */
 const user_defaults = {
     all() {
         return utils.cloneObject(settings);
@@ -187,26 +242,63 @@ const user_defaults = {
     add(key, value) {
         setSetting(key, value);
     },
+    /** As add(), and resolves once the value is in storage, where other tabs can read it. */
+    save(key, value) {
+        if (value === undefined) {
+            delete settings[key];
+        }
+        else {
+            settings[key] = utils.cloneObject(value);
+        }
+        return withBackend('save ' + key, undefined, function (b) { return writeSetting(b, key); }); // no i18n
+    },
     clear() {
         settings = {};
         withBackend('clear settings', undefined, function (b) { return b.clearSettings(); }); // no i18n
     },
 };
-/** Opt-in status, stored as the tracking_status setting. */
+/**
+ * Re-reads `keys` from storage. Settings are loaded into memory once, when a tab starts, so a value
+ * another tab of this site wrote since then — the device ids it registered — is only in storage.
+ * A key storage doesn't hold keeps this tab's value.
+ */
+function reloadSettings(keys) {
+    return withBackend('reload settings', undefined, function (b) {
+        return b.loadSettings().then(function (loaded) {
+            keys.forEach(function (key) {
+                if (loaded[key] !== undefined) {
+                    settings[key] = loaded[key];
+                }
+            });
+        });
+    });
+}
+/** The visitor's tracking status, stored in trackinfo as tracking_status. */
+function storedTrackingStatus() {
+    var track = settings.trackinfo;
+    var status = track && typeof track === 'object' ? track.tracking_status : undefined; // no i18n
+    // a status only: getsdkconfig's own answer uses the same key for its per-module flags, and
+    // one stored by mistake must not read as a consent and stop all tracking
+    return status === constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII || status === constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII
+        || status === constants.AP_TRACKING_STATUS.NO_TRACKING ? status : undefined;
+}
+/** Opt-in status, stored in the trackinfo setting as tracking_status. */
 const tracking_preference = {
     _tracking_status: 'tracking_status', // no i18n
     all() {
         return user_defaults.all();
     },
     opt_in_status() {
-        return (settings[tracking_preference._tracking_status] || constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII);
+        return (storedTrackingStatus() || constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII);
     },
     update_status(tracking_status) {
         state._ZAP._devicestatus = tracking_status;
-        // Legacy order kept: this reads the status *before* the write below (setTrackingStatus recomputes it after).
-        state._ZAP._isanonrequired =
-            tracking_preference.opt_in_status() == constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII ? false : state._ZAP._isanonrequired;
-        setSetting(tracking_preference._tracking_status, tracking_status);
+        var track = Object.assign({}, settings.trackinfo && typeof settings.trackinfo === 'object' ? settings.trackinfo : {}); // no i18n
+        track.tracking_status = tracking_status;
+        if (state._ZAP._trackinfo && typeof state._ZAP._trackinfo === 'object') { // no i18n
+            state._ZAP._trackinfo.tracking_status = tracking_status;
+        }
+        setSetting('trackinfo', track); // no i18n
     },
 };
 function getKeyFromDeviceInfo(key) {
@@ -218,12 +310,15 @@ function getKeyFromDeviceInfo(key) {
     return null;
 }
 
-exports.consolelog_transactions = consolelog_transactions;
 exports.engagement_transactions = engagement_transactions;
 exports.error_transactions = error_transactions;
+exports.feedbacklog_transactions = feedbacklog_transactions;
 exports.getKeyFromDeviceInfo = getKeyFromDeviceInfo;
 exports.heatmap_transactions = heatmap_transactions;
-exports.log_transactions = log_transactions;
+exports.reloadSettings = reloadSettings;
+exports.remotelog_transactions = remotelog_transactions;
+exports.setDeviceInfoKey = setDeviceInfoKey;
 exports.storageReady = storageReady;
+exports.storedTrackingStatus = storedTrackingStatus;
 exports.tracking_preference = tracking_preference;
 exports.user_defaults = user_defaults;

package/dist/cjs/core/stylesheet.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ *
+ * Nothing happens when `css` is empty (running from source, as the tests do) or when the page
+ * already has the styles (the element is marked data-apptics="style"). Never throws.
+ */
+export declare function injectStylesheet(css: string): void;

package/dist/cjs/core/stylesheet.js

@@ -0,0 +1,29 @@
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
+'use strict';
+
+/**
+ * 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.
+ *
+ * Nothing happens when `css` is empty (running from source, as the tests do) or when the page
+ * already has the styles (the element is marked data-apptics="style"). Never throws.
+ */
+function injectStylesheet(css) {
+    try {
+        if (!css || typeof document === 'undefined') { // no i18n
+            return;
+        }
+        if (document.querySelector('[data-apptics="style"]')) { // no i18n
+            return;
+        }
+        var style = document.createElement('style'); // no i18n
+        style.setAttribute('data-apptics', 'style'); // no i18n
+        style.textContent = css;
+        (document.head || document.documentElement).appendChild(style);
+    }
+    catch (err) {
+        // the form still works unstyled; the app must not break over a stylesheet
+    }
+}
+
+exports.injectStylesheet = injectStylesheet;

package/dist/cjs/core/transport.d.ts

@@ -81,3 +81,5 @@ export declare function getMetaObj(): Dict;
  * and feedback (P11).
  */
 export declare function rejectIfNoDeviceIds(label: string): Promise<never> | null;
+/** Whether device/add has given this browser its deviceid. */
+export declare function hasDeviceId(): boolean;

package/dist/cjs/core/transport.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 constants = require('./constants.js');
@@ -141,19 +141,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=' + state._ZAP._isanonrequired + '&devicestatus=' + state._ZAP._devicestatus; // no i18n
+        returnVal = '?isanonrequired=false&devicestatus=' + state._ZAP._devicestatus; // no i18n
         if (!utils.isEmpty(state._ZAP._device_info.deviceid)) {
             returnVal += '&deviceid=' + encodeURIComponent(String(state._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 (utils.isEmpty(state._ZAP._device_info.deviceid)) {
             hooks.hooks.refreshDeviceInfo();
             // the device is missing, but appversionid and frameworkid are mandatory regardless:
@@ -174,15 +172,17 @@ function getParameters(path) {
         }
         return returnVal + mandatoryParams(returnVal);
     }
-    // add userid and groupid if opt_in_status is USAGE_TRACKING_WITH_PII
-    if (path != 'reguser' && identifiesDevice) { // no i18n
-        if (consent.opt_in_status() == constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII) {
-            if (state._ZAP._user_info.hasOwnProperty('userid') && !utils.isEmpty(state._ZAP._user_info.userid)) { // no i18n
-                returnVal += '&userid=' + encodeURIComponent(String(state._ZAP._user_info.userid)); // no i18n
-            }
-            if (state._ZAP._user_info.hasOwnProperty('groupid') && !utils.isEmpty(state._ZAP._user_info.groupid)) { // no i18n
-                returnVal += '&customergroupid=' + encodeURIComponent(String(state._ZAP._user_info.groupid)); // no i18n
-            }
+    // add userid and groupid if opt_in_status is USAGE_TRACKING_WITH_PII. getupdates doesn't declare
+    // 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 && consent.opt_in_status() == constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII) {
+        if (state._ZAP._user_info.hasOwnProperty('userid') && !utils.isEmpty(state._ZAP._user_info.userid)) { // no i18n
+            // getsdkconfig has no deviceid before it, so its userid starts the query
+            returnVal += (returnVal === '' ? '?' : '&') + 'userid=' + encodeURIComponent(String(state._ZAP._user_info.userid)); // no i18n
+        }
+        if (state._ZAP._user_info.hasOwnProperty('groupid') && !utils.isEmpty(state._ZAP._user_info.groupid)) { // no i18n
+            returnVal += (returnVal === '' ? '?' : '&') + 'customergroupid=' + encodeURIComponent(String(state._ZAP._user_info.groupid)); // no i18n
         }
     }
     returnVal += deviceNameParam(path, returnVal);
@@ -419,10 +419,21 @@ function getMetaObj() {
 function rejectIfNoDeviceIds(label) {
     if (utils.isEmpty(getHeaderParams('apid')) && utils.isEmpty(getHeaderParams('mapid'))) { // no i18n
         hooks.hooks.refreshDeviceInfo();
-        return Promise.reject(label + ': You must call apptics.init() first'); // no i18n
+        return Promise.reject(label + ': You must call Apptics.init() first'); // no i18n
+    }
+    // app/addversion has answered, device/add not yet (offline, or it failed): what is stored waits
+    // for the device it belongs to rather than going out without a deviceid. The refresh registers
+    // the device, joining a registration already in flight
+    if (!hasDeviceId()) {
+        hooks.hooks.refreshDeviceInfo();
+        return Promise.reject(label + ': the device is not registered yet, kept for the next send'); // no i18n
     }
     return null;
 }
+/** Whether device/add has given this browser its deviceid. */
+function hasDeviceId() {
+    return !utils.isEmpty(state._ZAP._device_info && state._ZAP._device_info.deviceid) || !utils.isEmpty(storage.getKeyFromDeviceInfo('deviceid')); // no i18n
+}
 
 exports.KEEPALIVE_BUDGET = KEEPALIVE_BUDGET;
 exports.REQUEST_TIMEOUT_MS = REQUEST_TIMEOUT_MS;
@@ -431,6 +442,7 @@ exports.getHeaderParams = getHeaderParams;
 exports.getMetaObj = getMetaObj;
 exports.getParameters = getParameters;
 exports.getUrlWithParams = getUrlWithParams;
+exports.hasDeviceId = hasDeviceId;
 exports.isPermanentRefusal = isPermanentRefusal;
 exports.makeRequest = makeRequest;
 exports.postKeepalive = postKeepalive;

package/dist/cjs/core/utils.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 constants = require('./constants.js');

package/dist/cjs/core/validate.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 logger = require('./logger.js');
@@ -220,7 +220,7 @@ function validateScreenName(str) {
     }
     // Define the regular expression pattern
     //^[a-zA-Z][\\w\\s]{1,100}$
-    const pattern = /^[\w\s.\-_&/:]{0,99}$/;
+    const pattern = /^[\w\s.\-_&/:*]{0,99}$/;
     // Test if the string matches the pattern
     return pattern.test(str);
 }

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

@@ -1,11 +1,15 @@
-/** Whether we already hold usable ids for the app and version running now. */
-export declare function hasAppVersion(): boolean;
 /**
- * Registers this build, or reuses the stored answer.
- *
- * Resolves true when the ids are in place, false when they are not — the caller stops there
- * rather than carrying on to calls that would be refused for missing them.
+ * 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>;
 /**
  * Puts the stored ids back on `_ZAP._device_info`.

package/dist/cjs/device/appversion.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 state = require('../core/state.js');
@@ -39,13 +39,34 @@ const REQUIRED_KEYS = ['aaid', 'portalid', 'projectid', 'apid', 'mapid', 'appver
 function missingKeys(data) {
     return REQUIRED_KEYS.filter(function (key) { return utils.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 = utils.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 === state._ZAP._defaultoptions.appversion
         && saved.identifier === state._ZAP._defaultoptions.identifier
-        && saved.serviceUrl === state._ZAP._defaultoptions.serviceUrl;
+        && saved.serviceUrl === state._ZAP._defaultoptions.serviceUrl
+        && saved.zakhash === keyFingerprint(state._ZAP._defaultoptions.zak);
 }
 /** Puts the ids where the rest of the SDK reads them from. */
 function apply(data) {
@@ -80,7 +101,16 @@ function apply(data) {
  * Resolves true when the ids are in place, false when they are not — the caller stops there
  * rather than carrying on to calls that would be refused for missing them.
  */
+/**
+ * Whether the last registration failed for want of a network (offline, a dropped connection, a
+ * timeout) rather than because the server answered no. Only the first is worth trying again.
+ */
+var failedForNetwork = false;
+function appVersionFailedForNetwork() {
+    return failedForNetwork;
+}
 function registerAppVersion() {
+    failedForNetwork = false;
     if (hasAppVersion()) {
         apply(stored());
         logger.Console.log(LABEL + ': reusing the ids stored for ' + state._ZAP._defaultoptions.appversion); // no i18n
@@ -117,6 +147,7 @@ function registerAppVersion() {
             appversion: state._ZAP._defaultoptions.appversion,
             identifier: state._ZAP._defaultoptions.identifier,
             serviceUrl: state._ZAP._defaultoptions.serviceUrl,
+            zakhash: keyFingerprint(state._ZAP._defaultoptions.zak),
         };
         RESULT_KEYS.forEach(function (key) {
             if (!utils.isEmpty(data[key])) {
@@ -128,6 +159,8 @@ function registerAppVersion() {
         return true;
     })
         .catch(function (err) {
+        // a server answer carries serverResult; a request that never got one does not
+        failedForNetwork = !(err && err.serverResult) || navigator.onLine === false;
         logger.warnAlways(LABEL + ': could not register this app version: ' + String(err && err.message ? err.message : err)); // no i18n
         return false;
     })
@@ -152,7 +185,9 @@ function clearAppVersion() {
     storage.user_defaults.add(STORE_KEY, undefined);
 }
 
+exports.appVersionFailedForNetwork = appVersionFailedForNetwork;
 exports.applyStoredAppVersion = applyStoredAppVersion;
 exports.clearAppVersion = clearAppVersion;
 exports.hasAppVersion = hasAppVersion;
+exports.keyFingerprint = keyFingerprint;
 exports.registerAppVersion = registerAppVersion;

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

@@ -1,6 +1,17 @@
 import type { DeviceInfo, Dict, ServerResult } from '../types.js';
 export declare function checkAndUpdateDeviceInfo(): void;
 export declare function addOrUpdateDeviceID(device_info: DeviceInfo, previous?: DeviceInfo): void;
+/**
+ * Sets up this browser's device at start-up: the uuid, the device info, and a registration when
+ * the browser has none.
+ *
+ * Settings are this tab's own copy, loaded when it started. On a browser with no device yet, two
+ * tabs started together would each register it and store two devices, so the first visit runs
+ * under a lock shared by every tab of the site: the tab that gets it re-reads storage, registers
+ * only when no other tab has, and keeps the lock until the new ids are stored. The next tab then
+ * finds them. Start-up goes on as soon as the device info is set, without waiting for the server.
+ */
+export declare function prepareDevice(): Promise<void>;
 /** True while the device has no server ids, so nothing can be sent yet. */
 export declare function needsDevice(): boolean;
 /**
@@ -17,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;