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

package/dist/cjs/core/callsite.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.1 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 /**
@@ -10,6 +10,22 @@
  * wrapped so a stack we cannot parse costs a line its call site and nothing more.
  */
 const NO_CALL_SITE = { filename: '', linenumber: 0, fn: '' };
+/**
+ * A call typed in the browser's developer console: there is no file, line or function to report,
+ * only the console's own placeholder for its input, so the line says plainly that it came from
+ * nowhere in the app. file_name and the function field both accept `-`.
+ */
+const CONSOLE_CALL_SITE = { filename: '-', linenumber: 0, fn: '-' };
+/**
+ * The frame of code run from the developer console, in each browser:
+ *   V8 (Chrome, Edge):  `    at <anonymous>:1:15`        (the file is <anonymous>)
+ *   Firefox:            `@debugger eval code:1:15`
+ *   Safari:             `global code` or `eval code`, with no location at all
+ * V8 names a string run through eval or new Function <anonymous> too; it is no file either.
+ */
+const CONSOLE_FILE_V8 = '<anonymous>'; // no i18n
+const CONSOLE_FIREFOX = /debugger eval code/; // no i18n
+const CONSOLE_SAFARI = /^(global|eval) code(@|$)/; // no i18n
 /** logSDK declares max-len="100" on filename. */
 const FILENAME_MAX = 100;
 /**
@@ -63,14 +79,19 @@ function callSiteFromStack(stack, skip) {
     var lines = stack.split('\n');
     var seen = 0;
     for (var i = 0; i < lines.length; i++) {
-        var frame = parseFrame(lines[i] || '');
+        var raw = (lines[i] || '').trim(); // no i18n
+        var frame = parseFrame(raw);
         if (frame === null) {
+            // Safari's console frame has no location, so it is never a frame parseFrame reads
+            if (seen === skip && CONSOLE_SAFARI.test(raw)) {
+                return CONSOLE_CALL_SITE;
+            }
             continue;
         }
         if (seen++ < skip) {
             continue;
         }
-        return frame;
+        return frame.filename === CONSOLE_FILE_V8 || CONSOLE_FIREFOX.test(raw) ? CONSOLE_CALL_SITE : frame;
     }
     return NO_CALL_SITE;
 }
@@ -88,6 +109,7 @@ function callSite(skip) {
     }
 }
 
+exports.CONSOLE_CALL_SITE = CONSOLE_CALL_SITE;
 exports.NO_CALL_SITE = NO_CALL_SITE;
 exports.callSite = callSite;
 exports.callSiteFromStack = callSiteFromStack;

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

@@ -1,5 +1,9 @@
 import type { TrackingStatus } from '../types.js';
-/** DNT counts only when not ignored; when it counts, tracking switches to NO_TRACKING. */
+/**
+ * DNT counts only when not ignored; while it counts, tracking is NO_TRACKING (opt_in_status).
+ * Decided on every visit and never stored: storing it made one visit with DNT on look like the
+ * visitor's own choice, so tracking stayed off after DNT was turned off or ignore_do_not_track set.
+ */
 export declare function hasDoNotTrackEnabled(): boolean;
 export declare function opt_in_status(): TrackingStatus;
 export declare function shouldTrackOrSendData(): boolean;

package/dist/cjs/core/consent.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.1 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 var constants = require('./constants.js');
@@ -9,15 +9,17 @@ var storage = require('./storage.js');
 var env = require('./env.js');
 var hooks = require('./hooks.js');
 
-/** DNT counts only when not ignored; when it counts, tracking switches to NO_TRACKING. */
+/**
+ * DNT counts only when not ignored; while it counts, tracking is NO_TRACKING (opt_in_status).
+ * Decided on every visit and never stored: storing it made one visit with DNT on look like the
+ * visitor's own choice, so tracking stayed off after DNT was turned off or ignore_do_not_track set.
+ */
 function hasDoNotTrackEnabled() {
     if (state._ZAP._ignoreDnt) {
         return false;
     }
     if (env.isDntOn()) {
-        logger.Console.warn('hasDoNotTrackEnabled: DoNotTrack is enabled'); // no i18n
-        setTrackingStatus(constants.AP_TRACKING_STATUS.NO_TRACKING);
-        logger.Console.log('hasDoNotTrackEnabled: Setting tracking status to NO_TRACKING'); // no i18n
+        logger.Console.warn('hasDoNotTrackEnabled: DoNotTrack is enabled, so nothing is tracked'); // no i18n
         return true;
     }
     return false;
@@ -43,7 +45,7 @@ function shouldTrackOrSendData() {
  */
 function canTrack(caller) {
     if (!state._ZAP._token) {
-        logger.Console.warn('apptics.' + caller + ': You must call apptics.init() first'); // no i18n
+        logger.Console.warn('apptics.' + caller + ': You must call Apptics.init() first'); // no i18n
         return false;
     }
     if (env.is_apptics_disabled()) {

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

@@ -1,3 +1,19 @@
+/**
+ * A screen_routes entry as init() keeps it, ready to match: a route pattern, or an exact path or a
+ * regular expression with the name it records.
+ */
+export type ScreenRouteRule = {
+    kind: 'pattern';
+    pattern: string;
+} | {
+    kind: 'equals';
+    path: string;
+    name: string;
+} | {
+    kind: 'regex';
+    regex: RegExp;
+    name: string;
+};
 export declare const AP_TRACKING_STATUS: Readonly<{
     readonly USAGE_TRACKING_WITH_PII: 1;
     readonly USAGE_TRACKING_WITHOUT_PII: 4;
@@ -117,7 +133,6 @@ export declare const AP_CONFIG: Readonly<{
     debug: boolean;
     track_by_default: true;
     ignore_do_not_track: boolean;
-    remote_log: boolean;
     /**
      * Wrap XHR and fetch to record the app's API calls without it calling startTrackApi(). Off by
      * default: the hostnames and paths of every request an app makes is a wider grant than events
@@ -130,15 +145,16 @@ export declare const AP_CONFIG: Readonly<{
      */
     track_screen: boolean;
     /**
-     * Print each app logger line to the browser console as well, as Android's showLogs prints to
-     * Logcat. Off by default; console_log is the SDK's own activity, this is the app's lines.
+     * How automatic screen tracking names a path, as init() keeps the config's screen_routes: route
+     * patterns (`/users/{id}/orders`, each id recorded as a star), exact paths and regular
+     * expressions with a name. Tried in order; a path none matches keeps its own name.
      */
-    show_logs: boolean;
+    screen_routes: ScreenRouteRule[];
     /**
-     * Record sessions automatically. On by default; false is Android's
-     * automaticSessionsTrackingStatus = false: no sessions, while events and screens still are.
+     * The feedback form's theme: 'light', 'dark', or 'auto' to follow the visitor's system setting.
+     * 'auto' by default.
      */
-    track_session: boolean;
+    feedback_theme: "light" | "dark" | "auto";
     /**
      * How long a visit must last before its session is stored, in milliseconds. A shorter visit with
      * nothing tracked in it is dropped: a bounce or a crawler is not a session. Anything tracked
@@ -187,7 +203,13 @@ export type ApConfig = {
  * What init() must be given. Everything else the SDK needs — aaid, the portal and project ids that
  * go in every url — comes back from app/addversion, which these four are enough to call.
  */
-export declare const REQUIRED_CONFIG: readonly ["serviceUrl", "zak", "identifier", "appversion"];
+export declare const REQUIRED_CONFIG: readonly ["base_url", "auth_key", "app_domain", "appversion"];
+/**
+ * The init() keys and the names the SDK keeps them under inside (and in app_version_info, which
+ * already-visited browsers have stored): base_url is the host, auth_key the `zak` header, and
+ * app_domain the app's identifier.
+ */
+export declare const CONFIG_KEYS: Readonly<Record<string, string>>;
 /**
  * Paths with a `debug/` twin. The debug endpoints take the same body and answer with a request id
  * and a link to the server-side logs for that request, which is how a payload is traced end to
@@ -207,6 +229,9 @@ export declare const RETRY_CAPABLE_PATHS: Readonly<Record<string, boolean>>;
  * called before those ids are known, so it cannot carry them.
  */
 export declare const PATHS_WITHOUT_ORG: Readonly<Record<string, boolean>>;
-/** Console-snippet names accepted for the canonical keys above. */
-export declare const CONFIG_ALIASES: Readonly<Record<string, string>>;
+/**
+ * Earlier names of the init() keys: 2.0.0-beta's serviceUrl, zak and identifier, and the 1.x
+ * console snippet's base_domain and token. Still read, with a warning naming the key to use.
+ */
+export declare const RETIRED_CONFIG_NAMES: Readonly<Record<string, string>>;
 export declare const BLOCKED_WS: readonly string[];

package/dist/cjs/core/constants.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.1 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 const AP_TRACKING_STATUS = Object.freeze({
@@ -140,8 +140,6 @@ const AP_CONFIG = Object.freeze({
     debug: false,
     track_by_default: true,
     ignore_do_not_track: false,
-    // the SDK's own failure reports to the Remote Logger page: off unless the app passes remote_log: true
-    remote_log: false,
     /**
      * Wrap XHR and fetch to record the app's API calls without it calling startTrackApi(). Off by
      * default: the hostnames and paths of every request an app makes is a wider grant than events
@@ -154,15 +152,16 @@ const AP_CONFIG = Object.freeze({
      */
     track_screen: true,
     /**
-     * Print each app logger line to the browser console as well, as Android's showLogs prints to
-     * Logcat. Off by default; console_log is the SDK's own activity, this is the app's lines.
+     * How automatic screen tracking names a path, as init() keeps the config's screen_routes: route
+     * patterns (`/users/{id}/orders`, each id recorded as a star), exact paths and regular
+     * expressions with a name. Tried in order; a path none matches keeps its own name.
      */
-    show_logs: false,
+    screen_routes: [],
     /**
-     * Record sessions automatically. On by default; false is Android's
-     * automaticSessionsTrackingStatus = false: no sessions, while events and screens still are.
+     * The feedback form's theme: 'light', 'dark', or 'auto' to follow the visitor's system setting.
+     * 'auto' by default.
      */
-    track_session: true,
+    feedback_theme: 'auto',
     /**
      * How long a visit must last before its session is stored, in milliseconds. A shorter visit with
      * nothing tracked in it is dropped: a bounce or a crawler is not a session. Anything tracked
@@ -208,7 +207,17 @@ const AP_CONFIG = Object.freeze({
  * What init() must be given. Everything else the SDK needs — aaid, the portal and project ids that
  * go in every url — comes back from app/addversion, which these four are enough to call.
  */
-const REQUIRED_CONFIG = Object.freeze(['serviceUrl', 'zak', 'identifier', 'appversion']); // no i18n
+const REQUIRED_CONFIG = Object.freeze(['base_url', 'auth_key', 'app_domain', 'appversion']); // no i18n
+/**
+ * The init() keys and the names the SDK keeps them under inside (and in app_version_info, which
+ * already-visited browsers have stored): base_url is the host, auth_key the `zak` header, and
+ * app_domain the app's identifier.
+ */
+const CONFIG_KEYS = Object.freeze({
+    base_url: 'serviceUrl', // no i18n
+    auth_key: 'zak', // no i18n
+    app_domain: 'identifier', // no i18n
+});
 /**
  * Paths with a `debug/` twin. The debug endpoints take the same body and answer with a request id
  * and a link to the server-side logs for that request, which is how a payload is traced end to
@@ -243,10 +252,16 @@ const RETRY_CAPABLE_PATHS = Object.freeze({
 const PATHS_WITHOUT_ORG = Object.freeze({
     addversion: true, // no i18n
 });
-/** Console-snippet names accepted for the canonical keys above. */
-const CONFIG_ALIASES = Object.freeze({
-    serviceUrl: 'base_domain', // no i18n
-    zak: 'token', // no i18n
+/**
+ * Earlier names of the init() keys: 2.0.0-beta's serviceUrl, zak and identifier, and the 1.x
+ * console snippet's base_domain and token. Still read, with a warning naming the key to use.
+ */
+const RETIRED_CONFIG_NAMES = Object.freeze({
+    serviceUrl: 'base_url', // no i18n
+    base_domain: 'base_url', // no i18n
+    zak: 'auth_key', // no i18n
+    token: 'auth_key', // no i18n
+    identifier: 'app_domain', // no i18n
 });
 // crawlers reference
 // https://developers.google.com/search/docs/advanced/crawling/overview-google-crawlers
@@ -283,7 +298,7 @@ exports.AP_FEEDBACK_TYPE = AP_FEEDBACK_TYPE;
 exports.AP_LOG_MODULE = AP_LOG_MODULE;
 exports.AP_TRACKING_STATUS = AP_TRACKING_STATUS;
 exports.BLOCKED_WS = BLOCKED_WS;
-exports.CONFIG_ALIASES = CONFIG_ALIASES;
+exports.CONFIG_KEYS = CONFIG_KEYS;
 exports.CONSOLE_LOG_MAX_BODY = CONSOLE_LOG_MAX_BODY;
 exports.DEBUG_CAPABLE_PATHS = DEBUG_CAPABLE_PATHS;
 exports.DEBUG_IDLE_MS = DEBUG_IDLE_MS;
@@ -295,5 +310,6 @@ exports.LOG_FUNCTION_MAX = LOG_FUNCTION_MAX;
 exports.PATHS_WITHOUT_ORG = PATHS_WITHOUT_ORG;
 exports.REMOTE_LOG_LEVEL = REMOTE_LOG_LEVEL;
 exports.REQUIRED_CONFIG = REQUIRED_CONFIG;
+exports.RETIRED_CONFIG_NAMES = RETIRED_CONFIG_NAMES;
 exports.RETRY_CAPABLE_PATHS = RETRY_CAPABLE_PATHS;
 exports.SDK_MODULE = SDK_MODULE;

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

@@ -1,10 +1,12 @@
 import type { Dict, QueueItem } from '../types.js';
-export type QueueName = 'engagements' | 'errors' | 'logs' | 'consolelogs' | 'heatmaps';
+export type QueueName = 'engagements' | 'errors' | 'feedbacklogs' | 'remotelogs' | 'heatmaps';
 /** One storage implementation. storage.ts talks only to this interface. */
 export interface Backend {
     readonly kind: 'indexeddb' | 'localstorage';
     loadSettings(): Promise<Dict>;
     putSetting(key: string, value: unknown): Promise<void>;
+    /** Removes the key itself, so it is no longer in storage at all. */
+    deleteSetting(key: string): Promise<void>;
     clearSettings(): Promise<void>;
     /** Items in insertion order. */
     queueAll(store: QueueName): Promise<QueueItem[]>;
@@ -16,16 +18,22 @@ export interface Backend {
     importAll?(settings: Dict, queues: Record<QueueName, QueueItem[]>): Promise<void>;
 }
 export declare const DB_NAME = "apptics";
-export declare const DB_VERSION = 3;
-/** 1.x localStorage keys; also the layout of the localStorage backend. */
+export declare const DB_VERSION = 4;
+/** The types a feedback entry is stored under: an addFeedbackLog() line, an addDiagnosticsInfo() entry. */
+export declare const FEEDBACK_LOG = "feedbacklog";
+export declare const FEEDBACK_DIAGNOSTICS = "feedbackdiagnostics";
+/** A feedback entry from 1.x or 2.0.0-beta, with the type it is stored under now. */
+export declare function renameFeedbackType(item: QueueItem): QueueItem;
+/** 1.x localStorage keys, read once to bring 1.x data into IndexedDB (see migrateLegacy). */
 export declare const LEGACY_KEYS: Readonly<{
     readonly settings: "apptics-device-info";
     readonly engagements: "apptics-engagements-transactions";
     readonly errors: "apptics-errors-transactions";
     readonly logs: "apptics-log-transactions";
     readonly consolelogs: "apptics-consolelog-transactions";
-    readonly heatmaps: "apptics-heatmap-transactions";
 }>;
+/** The localStorage backend's layout, for a browser where IndexedDB will not open. */
+export declare const LOCAL_KEYS: Readonly<Record<'settings' | QueueName, string>>;
 /** Shape guards shared by both backends and the 1.x migration. */
 export declare function asList(value: unknown): QueueItem[];
 export declare function asDict(value: unknown): Dict;

package/dist/cjs/core/db.js

@@ -1,26 +1,73 @@
-/*! @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.1 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 var logger = require('./logger.js');
 var utils = require('./utils.js');
 
 const DB_NAME = 'apptics'; // no i18n
-// 3 added the heatmaps store. The upgrade only creates stores that are missing, so an existing
-// database keeps everything already queued in it.
-const DB_VERSION = 3;
+// 3 added the heatmaps store. 4 renamed: each record's order key `seq` to `queue`, the logs store
+// to feedbacklogs and consolelogs to remotelogs. Every upgrade keeps what is already queued.
+const DB_VERSION = 4;
 const OPEN_TIMEOUT_MS = 3000;
-const QUEUES = ['engagements', 'errors', 'logs', 'consolelogs', 'heatmaps']; // no i18n
-/** 1.x localStorage keys; also the layout of the localStorage backend. */
+const QUEUES = ['engagements', 'errors', 'feedbacklogs', 'remotelogs', 'heatmaps']; // no i18n
+/** The field, and the index on it, that keeps a queue's records in the order they were added. */
+const QUEUE_KEY = 'queue'; // no i18n
+/** Version 3's names, which the version 4 upgrade moves to the ones above. */
+const OLD_QUEUE_KEY = 'seq'; // no i18n
+const RENAMED_STORES = [['logs', 'feedbacklogs'], ['consolelogs', 'remotelogs']]; // no i18n
+/** The types a feedback entry is stored under: an addFeedbackLog() line, an addDiagnosticsInfo() entry. */
+const FEEDBACK_LOG = 'feedbacklog'; // no i18n
+const FEEDBACK_DIAGNOSTICS = 'feedbackdiagnostics'; // no i18n
+const OLD_FEEDBACK_TYPES = Object.freeze({
+    log: FEEDBACK_LOG, // no i18n
+    diagnostics: FEEDBACK_DIAGNOSTICS, // no i18n
+});
+/** A feedback entry from 1.x or 2.0.0-beta, with the type it is stored under now. */
+function renameFeedbackType(item) {
+    var renamed = item && typeof item.type === 'string' ? OLD_FEEDBACK_TYPES[item.type] : undefined; // no i18n
+    return renamed ? { ...item, type: renamed } : item;
+}
+/** 1.x localStorage keys, read once to bring 1.x data into IndexedDB (see migrateLegacy). */
 const LEGACY_KEYS = Object.freeze({
     settings: 'apptics-device-info', // no i18n
     engagements: 'apptics-engagements-transactions', // no i18n
     errors: 'apptics-errors-transactions', // no i18n
     logs: 'apptics-log-transactions', // no i18n
     consolelogs: 'apptics-consolelog-transactions', // no i18n
-    // not a 1.x key: heatmaps did not exist then. It is here because this map is also the
-    // localStorage backend's layout, so the store needs a name there too
+});
+/** The localStorage backend's layout, for a browser where IndexedDB will not open. */
+const LOCAL_KEYS = Object.freeze({
+    settings: LEGACY_KEYS.settings,
+    engagements: LEGACY_KEYS.engagements,
+    errors: LEGACY_KEYS.errors,
+    feedbacklogs: 'apptics-feedbacklog-transactions', // no i18n
+    remotelogs: 'apptics-remotelog-transactions', // no i18n
     heatmaps: 'apptics-heatmap-transactions', // no i18n
 });
+/**
+ * The localStorage backend once kept these two under the 1.x keys. Moved to the new ones on first
+ * use, feedback types renamed on the way, unless something is already there.
+ */
+function moveRenamedLocalKeys() {
+    [[LEGACY_KEYS.logs, LOCAL_KEYS.feedbacklogs], [LEGACY_KEYS.consolelogs, LOCAL_KEYS.remotelogs]].forEach(function (pair) {
+        try {
+            var from = pair[0];
+            var to = pair[1];
+            var old = localStorage.getItem(from);
+            if (old === null) {
+                return;
+            }
+            if (localStorage.getItem(to) === null) {
+                var items = asList(JSON.parse(old));
+                localStorage.setItem(to, JSON.stringify(to === LOCAL_KEYS.feedbacklogs ? items.map(renameFeedbackType) : items));
+            }
+            localStorage.removeItem(from);
+        }
+        catch (err) {
+            // left where it is; the next load tries again
+        }
+    });
+}
 /** Shape guards shared by both backends and the 1.x migration. */
 function asList(value) {
     return Array.isArray(value) ? value : [];
@@ -48,26 +95,33 @@ function writeJSON(key, value) {
     }
 }
 function createLocalStorageBackend() {
+    moveRenamedLocalKeys();
     return {
         kind: 'localstorage', // no i18n
         loadSettings() {
-            return Promise.resolve(asDict(readJSON(LEGACY_KEYS.settings)));
+            return Promise.resolve(asDict(readJSON(LOCAL_KEYS.settings)));
         },
         putSetting(key, value) {
-            const all = asDict(readJSON(LEGACY_KEYS.settings));
+            const all = asDict(readJSON(LOCAL_KEYS.settings));
             all[key] = value;
-            writeJSON(LEGACY_KEYS.settings, all);
+            writeJSON(LOCAL_KEYS.settings, all);
+            return Promise.resolve();
+        },
+        deleteSetting(key) {
+            const all = asDict(readJSON(LOCAL_KEYS.settings));
+            delete all[key];
+            writeJSON(LOCAL_KEYS.settings, all);
             return Promise.resolve();
         },
         clearSettings() {
-            writeJSON(LEGACY_KEYS.settings, {});
+            writeJSON(LOCAL_KEYS.settings, {});
             return Promise.resolve();
         },
         queueAll(store) {
-            return Promise.resolve(asList(readJSON(LEGACY_KEYS[store])));
+            return Promise.resolve(asList(readJSON(LOCAL_KEYS[store])));
         },
         queuePut(store, items) {
-            const list = asList(readJSON(LEGACY_KEYS[store]));
+            const list = asList(readJSON(LOCAL_KEYS[store]));
             items.forEach(function (item) {
                 const index = list.findIndex(function (existing) { return existing.id === item.id; });
                 if (index === -1) {
@@ -77,32 +131,32 @@ function createLocalStorageBackend() {
                     list[index] = item;
                 }
             });
-            writeJSON(LEGACY_KEYS[store], list);
+            writeJSON(LOCAL_KEYS[store], list);
             return Promise.resolve();
         },
         queueDelete(store, ids) {
-            const remaining = asList(readJSON(LEGACY_KEYS[store])).filter(function (item) {
+            const remaining = asList(readJSON(LOCAL_KEYS[store])).filter(function (item) {
                 return ids.indexOf(item.id) === -1;
             });
-            writeJSON(LEGACY_KEYS[store], remaining);
+            writeJSON(LOCAL_KEYS[store], remaining);
             return Promise.resolve();
         },
         queueClear(store) {
-            writeJSON(LEGACY_KEYS[store], []);
+            writeJSON(LOCAL_KEYS[store], []);
             return Promise.resolve();
         },
     };
 }
-let lastSeq = 0;
+let lastQueue = 0;
 /**
  * Strictly increasing, and time-based so tabs interleave in roughly the right order.
  * Counting up from the last value rather than a counter that wraps keeps insertion order
  * even when a chatty caller adds more than a thousand items inside one millisecond.
  */
-function nextSeq() {
+function nextQueue() {
     const base = utils.nowMs() * 1000;
-    lastSeq = base > lastSeq ? base : lastSeq + 1;
-    return lastSeq;
+    lastQueue = base > lastQueue ? base : lastQueue + 1;
+    return lastQueue;
 }
 function request(req) {
     return new Promise(function (resolve, reject) {
@@ -117,7 +171,21 @@ function completed(tx) {
         tx.onabort = function () { reject(tx.error); };
     });
 }
-/** Puts `item` unless it exists (keepExisting) or replaces it keeping its seq. Runs inside `store`'s transaction. */
+/**
+ * The record's `type` for an item with none of its own: heatmap records carry no type, since
+ * their payload is the item itself and the server takes no extra field. Never undefined.
+ */
+const STORE_TYPES = Object.freeze({
+    engagements: 'engagement', // no i18n
+    errors: 'error', // no i18n
+    feedbacklogs: FEEDBACK_LOG,
+    remotelogs: 'remotelog', // no i18n
+    heatmaps: 'heatmap', // no i18n
+});
+function recordType(storeName, item) {
+    return item && typeof item.type === 'string' && item.type !== '' ? item.type : (STORE_TYPES[storeName] || storeName); // no i18n
+}
+/** Puts `item` unless it exists (keepExisting) or replaces it keeping its place. Runs inside `store`'s transaction. */
 function putRecord(store, item, keepExisting) {
     const id = String(item.id);
     const lookup = store.get(id);
@@ -126,7 +194,7 @@ function putRecord(store, item, keepExisting) {
         if (existing && keepExisting) {
             return;
         }
-        store.put({ id: id, seq: existing ? existing.seq : nextSeq(), type: item.type, item: item });
+        store.put({ id: id, queue: existing ? existing.queue : nextQueue(), type: recordType(store.name, item), item: item });
     };
 }
 /** Our stores, as created by onupgradeneeded. */
@@ -187,15 +255,7 @@ function openOnce(factory, timeoutMs) {
             return;
         }
         req.onupgradeneeded = function () {
-            const db = req.result;
-            if (!db.objectStoreNames.contains('settings')) { // no i18n
-                db.createObjectStore('settings'); // no i18n
-            }
-            QUEUES.forEach(function (name) {
-                if (!db.objectStoreNames.contains(name)) {
-                    db.createObjectStore(name, { keyPath: 'id' }).createIndex('seq', 'seq'); // no i18n
-                }
-            });
+            upgrade(req.result, req.transaction);
         };
         req.onsuccess = function () {
             if (settled) {
@@ -226,6 +286,70 @@ function openOnce(factory, timeoutMs) {
         };
     });
 }
+/**
+ * Creates what is missing and moves version 3's data to version 4's names, inside the upgrade's
+ * own transaction: either the whole upgrade lands, or the database stays at the old version with
+ * everything still in it.
+ */
+function upgrade(db, tx) {
+    if (!db.objectStoreNames.contains('settings')) { // no i18n
+        db.createObjectStore('settings'); // no i18n
+    }
+    QUEUES.forEach(function (name) {
+        if (!db.objectStoreNames.contains(name)) {
+            db.createObjectStore(name, { keyPath: 'id' }).createIndex(QUEUE_KEY, QUEUE_KEY); // no i18n
+        }
+    });
+    // kept stores: the order key is renamed on every record, and the index with it
+    QUEUES.forEach(function (name) {
+        const store = tx.objectStore(name);
+        if (!store.indexNames.contains(OLD_QUEUE_KEY)) {
+            return;
+        }
+        store.deleteIndex(OLD_QUEUE_KEY);
+        if (!store.indexNames.contains(QUEUE_KEY)) {
+            store.createIndex(QUEUE_KEY, QUEUE_KEY);
+        }
+        eachRecord(store, function (record, cursor) {
+            cursor.update(renamedRecord(record, false, name));
+        });
+    });
+    // renamed stores: every record moves to its new store, then the old store goes
+    RENAMED_STORES.forEach(function (pair) {
+        const from = pair[0];
+        const to = pair[1];
+        if (!db.objectStoreNames.contains(from)) {
+            return;
+        }
+        const source = tx.objectStore(from);
+        const target = tx.objectStore(to);
+        eachRecord(source, function (record) {
+            target.put(renamedRecord(record, to === 'feedbacklogs', to)); // no i18n
+        }, function () {
+            db.deleteObjectStore(from);
+        });
+    });
+}
+/** Calls `each` for every record of `store`, then `done`, inside the transaction `store` is in. */
+function eachRecord(store, each, done) {
+    const req = store.openCursor();
+    req.onsuccess = function () {
+        const cursor = req.result;
+        if (!cursor) {
+            if (done)
+                done();
+            return;
+        }
+        each(cursor.value, cursor);
+        cursor.continue();
+    };
+}
+/** A version 3 record under version 4's names: `queue` for `seq`, and the feedback types renamed. */
+function renamedRecord(record, feedback, storeName) {
+    const queue = typeof record[QUEUE_KEY] === 'number' ? record[QUEUE_KEY] : (typeof record[OLD_QUEUE_KEY] === 'number' ? record[OLD_QUEUE_KEY] : nextQueue()); // no i18n
+    const item = (feedback ? renameFeedbackType(record.item) : record.item);
+    return { id: String(record.id), queue: queue, type: recordType(storeName, item), item: item };
+}
 function createIndexedDBBackend(db) {
     return {
         kind: 'indexeddb', // no i18n
@@ -244,13 +368,18 @@ function createIndexedDBBackend(db) {
             tx.objectStore('settings').put(value, key); // no i18n
             return completed(tx);
         },
+        deleteSetting(key) {
+            const tx = db.transaction('settings', 'readwrite'); // no i18n
+            tx.objectStore('settings').delete(key); // no i18n
+            return completed(tx);
+        },
         clearSettings() {
             const tx = db.transaction('settings', 'readwrite'); // no i18n
             tx.objectStore('settings').clear(); // no i18n
             return completed(tx);
         },
         queueAll(store) {
-            const index = db.transaction(store, 'readonly').objectStore(store).index('seq'); // no i18n
+            const index = db.transaction(store, 'readonly').objectStore(store).index(QUEUE_KEY);
             return request(index.getAll()).then(function (records) {
                 return records.map(function (record) { return record.item; });
             });
@@ -325,10 +454,14 @@ function openBackend() {
 
 exports.DB_NAME = DB_NAME;
 exports.DB_VERSION = DB_VERSION;
+exports.FEEDBACK_DIAGNOSTICS = FEEDBACK_DIAGNOSTICS;
+exports.FEEDBACK_LOG = FEEDBACK_LOG;
 exports.LEGACY_KEYS = LEGACY_KEYS;
+exports.LOCAL_KEYS = LOCAL_KEYS;
 exports.asDict = asDict;
 exports.asList = asList;
 exports.createIndexedDBBackend = createIndexedDBBackend;
 exports.createLocalStorageBackend = createLocalStorageBackend;
 exports.openBackend = openBackend;
 exports.openIndexedDB = openIndexedDB;
+exports.renameFeedbackType = renameFeedbackType;

package/dist/cjs/core/debug.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.1 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 var constants = require('./constants.js');

package/dist/cjs/core/env.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.1 | (c) Zoho Corporation Private Limited | see LICENSE */
 'use strict';
 
 var constants = require('./constants.js');

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

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