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

package/dist/cjs/user/index.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('../core/constants.js');
@@ -25,7 +25,7 @@ function asUserProperties(jsonObj) {
         ? maybeBuilt
         : validate.userValidateJSON(jsonObj);
     built.message.forEach(function (problem) {
-        logger.logFailure(constants.AP_LOG_MODULE.PROPERTIES, 'AppticsSetUser: dropped ' + problem.keys.join(', ') + ' (error ' + problem.code + ')'); // no i18n
+        logger.logFailure(constants.AP_LOG_MODULE.PROPERTIES, 'AppticsUser.setUser: dropped ' + problem.keys.join(', ') + ' (error ' + problem.code + ')'); // no i18n
     });
     return built;
 }
@@ -37,7 +37,7 @@ function setUser(userid, groupid, jsonObj) {
         return;
     }
     if (utils.isEmpty(userid)) {
-        logger.logFailure(constants.AP_LOG_MODULE.PROPERTIES, 'AppticsSetUser: Invalid userid'); // no i18n
+        logger.logFailure(constants.AP_LOG_MODULE.PROPERTIES, 'AppticsUser.setUser: Invalid userid'); // no i18n
         return;
     }
     var user_info = {
@@ -68,8 +68,16 @@ function addOrUpdateUser(user_info) {
         users.push(user_info);
     }
     storage.user_defaults.add('users', users); // no i18n
+    // the user setUser registered, on its own as well: what this browser is tracking as now
+    storage.user_defaults.add('user_info', users[index !== -1 ? index : users.length - 1]); // no i18n
 }
 function getUserInfo() {
+    var stored = storage.user_defaults.item('user_info'); // no i18n
+    if (stored && typeof stored === 'object' && !utils.isEmpty(stored.userid)) { // no i18n
+        state._ZAP._user_info = stored;
+        return;
+    }
+    // registered before user_info was kept: the active one of the users list
     var users = storage.user_defaults.item('users') || []; // no i18n
     var activeuser = {};
     if (users.length > 0) {
@@ -96,11 +104,15 @@ function registerUserWithApptics(user_info) {
         var data = result.data || {};
         user_info.userid = data.userid;
         user_info.groupid = data.customergroupid;
-        consent.setTrackingStatus(constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII);
+        // stored only: user/register has told the server, and the device is registered already
+        consent.recordTrackingStatus(constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII);
         addOrUpdateUser(user_info);
         getUserInfo();
         // the user and their customer group are known now: remote config conditions on them re-apply
         hooks.hooks.remoteConfigUserChanged();
+        // getsdkconfig answers for the user (with every module off for one whose customer group
+        // is not tracked, customergrouptracking: false), so it is asked again for them now
+        hooks.hooks.askServerSettings();
         return data;
     });
 }
@@ -166,8 +178,6 @@ class UserBuilder {
         return validate.userValidateJSON(user);
     }
 }
-// Users module for user management
-const users = { UserBuilder: UserBuilder };
 
 exports.UserBuilder = UserBuilder;
 exports.addOrUpdateUser = addOrUpdateUser;
@@ -175,4 +185,3 @@ exports.getUser = getUser;
 exports.getUserInfo = getUserInfo;
 exports.registerUserWithApptics = registerUserWithApptics;
 exports.setUser = setUser;
-exports.users = users;

package/dist/esm/core/attempts.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 */
 import { RETRY_CAPABLE_PATHS } from './constants.js';
 import { user_defaults } from './storage.js';
 import { nowMs } from './utils.js';

package/dist/esm/core/batch.js

@@ -1,8 +1,8 @@
-/*! @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 */
 import { _ZAP, isExpired } from './state.js';
 import { Console, warnAlways } from './logger.js';
 import { isEmptyObj, sizeof } from './utils.js';
-import './constants.js';
+import './db.js';
 import { shouldTrackOrSendData } from './consent.js';
 import { attemptsExhausted, MAX_ATTEMPTS, resetAttempts } from './attempts.js';
 import { rejectIfDisabled, rejectIfNoDeviceIds, getMetaObj, postKeepalive, apiHeaders, postToApptics } from './transport.js';

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

@@ -1,5 +1,10 @@
+import { type EngagementType } from './constants.js';
 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;
@@ -8,8 +13,11 @@ export declare function shouldTrackOrSendData(): boolean;
  * and consent / server flags allow tracking.
  */
 export declare function canTrack(caller: string): boolean;
-/** canTrack plus the server's `engagementtracking` flag from getupdates (events, screens, sessions, api calls). */
-export declare function canTrackEngagement(caller: string): boolean;
+/**
+ * canTrack plus the server's flag for this kind of item: getsdkconfig's event (5), api (6),
+ * screen (10) and session (11) modules, each switched on its own.
+ */
+export declare function canTrackEngagement(caller: string, type: EngagementType): boolean;
 /**
  * canTrack plus the server's heatmap flag (getsdkconfig module 18).
  *
@@ -17,7 +25,13 @@ export declare function canTrackEngagement(caller: string): boolean;
  * well want events while declining to have every click's coordinates recorded.
  */
 export declare function canTrackHeatmap(caller: string): boolean;
-/** canTrack plus the server's `errortracking` flag from getupdates. */
+/** canTrack plus the server's js_error module (15) from getsdkconfig. */
 export declare function canTrackErrors(caller: string): boolean;
+/**
+ * Stores the visitor's tracking status without telling the server. True when it changed.
+ * user/register uses this alone: the server learns of the user from that call, so a device/add
+ * after it would only repeat a registration the device already has.
+ */
+export declare function recordTrackingStatus(trackingState: TrackingStatus): boolean;
 export declare function setTrackingStatus(trackingState: TrackingStatus): void;
 export declare function getTrackingStatus(): TrackingStatus;

package/dist/esm/core/consent.js

@@ -1,21 +1,23 @@
-/*! @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 */
 import { AP_TRACKING_STATUS } from './constants.js';
 import { _ZAP } from './state.js';
 import { Console } from './logger.js';
 import { isEmpty, isSuccess } from './utils.js';
 import { tracking_preference } from './storage.js';
-import { isDntOn, is_apptics_disabled } from './env.js';
+import { is_apptics_disabled, isDntOn } from './env.js';
 import { hooks } from './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 (_ZAP._ignoreDnt) {
         return false;
     }
     if (isDntOn()) {
-        Console.warn('hasDoNotTrackEnabled: DoNotTrack is enabled'); // no i18n
-        setTrackingStatus(AP_TRACKING_STATUS.NO_TRACKING);
-        Console.log('hasDoNotTrackEnabled: Setting tracking status to NO_TRACKING'); // no i18n
+        Console.warn('hasDoNotTrackEnabled: DoNotTrack is enabled, so nothing is tracked'); // no i18n
         return true;
     }
     return false;
@@ -41,7 +43,7 @@ function shouldTrackOrSendData() {
  */
 function canTrack(caller) {
     if (!_ZAP._token) {
-        Console.warn('apptics.' + caller + ': You must call apptics.init() first'); // no i18n
+        Console.warn('apptics.' + caller + ': You must call Apptics.init() first'); // no i18n
         return false;
     }
     if (is_apptics_disabled()) {
@@ -49,13 +51,16 @@ function canTrack(caller) {
     }
     return shouldTrackOrSendData();
 }
-/** canTrack plus the server's `engagementtracking` flag from getupdates (events, screens, sessions, api calls). */
-function canTrackEngagement(caller) {
+/**
+ * canTrack plus the server's flag for this kind of item: getsdkconfig's event (5), api (6),
+ * screen (10) and session (11) modules, each switched on its own.
+ */
+function canTrackEngagement(caller, type) {
     if (!canTrack(caller)) {
         return false;
     }
-    if (!_ZAP._engagementTracking) {
-        Console.log('apptics.' + caller + ': engagement tracking is turned off by the server'); // no i18n
+    if (!_ZAP._engagementTracking[type]) {
+        Console.log('apptics.' + caller + ': ' + type + ' tracking is turned off by the server'); // no i18n
         return false;
     }
     return true;
@@ -76,7 +81,7 @@ function canTrackHeatmap(caller) {
     }
     return true;
 }
-/** canTrack plus the server's `errortracking` flag from getupdates. */
+/** canTrack plus the server's js_error module (15) from getsdkconfig. */
 function canTrackErrors(caller) {
     if (!canTrack(caller)) {
         return false;
@@ -87,17 +92,27 @@ function canTrackErrors(caller) {
     }
     return true;
 }
+/**
+ * Stores the visitor's tracking status without telling the server. True when it changed.
+ * user/register uses this alone: the server learns of the user from that call, so a device/add
+ * after it would only repeat a registration the device already has.
+ */
+function recordTrackingStatus(trackingState) {
+    if (tracking_preference.opt_in_status() == trackingState) {
+        return false;
+    }
+    tracking_preference.update_status(trackingState);
+    _ZAP._devicestatus = tracking_preference.opt_in_status();
+    return true;
+}
 function setTrackingStatus(trackingState) {
     if (isEmpty(trackingState)) {
         Console.warn('setTrackingStatus: trackingStatus is Empty'); // no i18n
         return;
     }
-    if (tracking_preference.opt_in_status() == trackingState) {
+    if (!recordTrackingStatus(trackingState)) {
         return;
     }
-    tracking_preference.update_status(trackingState);
-    _ZAP._devicestatus = tracking_preference.opt_in_status();
-    _ZAP._isanonrequired = tracking_preference.opt_in_status() == AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII ? false : _ZAP._isanonrequired;
     if (tracking_preference.opt_in_status() != AP_TRACKING_STATUS.NO_TRACKING) {
         Console.log('setTrackingStatus: Updating device info with new tracking status'); // no i18n
         hooks.updateDevice(_ZAP._device_info).then(function (result) {
@@ -117,4 +132,4 @@ function getTrackingStatus() {
     return opt_in_status();
 }
 
-export { canTrack, canTrackEngagement, canTrackErrors, canTrackHeatmap, getTrackingStatus, hasDoNotTrackEnabled, opt_in_status, setTrackingStatus, shouldTrackOrSendData };
+export { canTrack, canTrackEngagement, canTrackErrors, canTrackHeatmap, getTrackingStatus, hasDoNotTrackEnabled, opt_in_status, recordTrackingStatus, setTrackingStatus, shouldTrackOrSendData };

package/dist/esm/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;
@@ -18,6 +34,8 @@ export declare const AP_CONSTANTS: Readonly<{
     readonly SUCCESS: "success";
     readonly BROWSER: "Browser";
 }>;
+/** The kinds of engagement item, each with its own getsdkconfig module: AP_CONSTANTS' type values. */
+export type EngagementType = 'event' | 'screen' | 'session' | 'api';
 export declare const DEFAULT_API_PATHS: Readonly<{
     readonly addversion: "app/addversion";
     readonly regdevice: "device/add";
@@ -63,9 +81,13 @@ export declare const SDK_MODULE: Readonly<{
      * authority. Where they disagree, getsdkconfig wins.
      */
     readonly REMOTE_CONFIG: "2";
+    readonly EVENT: "5";
+    readonly API: "6";
+    readonly SCREEN: "10";
     readonly SESSION: "11";
     readonly FEEDBACK: "12";
-    readonly CRASH: "13";
+    /** Uncaught and reported JavaScript errors: js_error. 13 (crash) and 14 (nonfatal) are the native SDKs'. */
+    readonly JS_ERROR: "15";
     readonly REMOTE_LOGGER: "17";
     readonly HEATMAP: "18";
 }>;
@@ -81,9 +103,10 @@ export declare const LOG_FILENAME_MAX = 100;
  */
 export declare const DEVICE_NAME_MAX = 100;
 /**
- * The `level` every line goes out with. Everything the remote logger carries is a failure inside
- * the SDK — logFailure is its only caller — so the level never varies. 3 is what the v2 reference
- * shows in its only example; the scale itself is not documented anywhere we can see.
+ * The `level` a remote log line goes out with when it has none of its own: 3, Info. Every line an
+ * app writes with AppticsLogger carries its level (1 verbose to 5 error, see LOG_LEVEL in
+ * remotelog/logger.ts). Only a line an older SDK stored, when the SDK logged its own failures
+ * there, has none; it is sent as Info rather than having the batch refused for a missing level.
  */
 export declare const REMOTE_LOG_LEVEL = 3;
 /**
@@ -93,31 +116,18 @@ export declare const REMOTE_LOG_LEVEL = 3;
  * enough that a tab left open overnight is not still sending every call to its debug twin.
  */
 export declare const DEBUG_IDLE_MS: number;
-/** Idle minutes that end a session. Lives on state, not in _config, but defaults here. */
+/** Minutes a tab can be inactive before its session ends. Lives on state, not in _config, but defaults here. */
 export declare const DEFAULT_INACTIVE_MINUTES = 30;
 /** Global defaults. `state._config` holds a mutable copy per init. */
 export declare const AP_CONFIG: Readonly<{
     endpoint: "/sdk/web/";
     method: "POST";
-    transport: "XHR";
-    track_link_timeout: 300;
-    cookie_expiration_days: 365;
-    storage_type: "localStorage";
-    enable_batch_requests: true;
     batch_size: 50;
     batch_flush_interval: 30000;
     getupdates_interval: 120000;
     batch_request_timeout: 7;
-    auto_starts_batch: true;
-    mode: 1;
-    default_group_name: "default";
-    default_optin_status: number;
-    enable_pageview_tracking: false;
-    save_referrer: true;
     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 +140,26 @@ 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.
+     * Record uncaught errors and unhandled promise rejections, from the window's `error` and
+     * `unhandledrejection` events. On by default; AppticsError.setErrorTracking() switches it later.
      */
-    show_logs: boolean;
+    track_error: boolean;
     /**
-     * Record sessions automatically. On by default; false is Android's
-     * automaticSessionsTrackingStatus = false: no sessions, while events and screens still are.
+     * Record clicks on elements tagged `apeventaction` (or `data-apeventaction`) as events. On by
+     * default; AppticsEvent.setClickTracking() switches it later.
      */
-    track_session: boolean;
+    track_click: boolean;
+    /**
+     * 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.
+     */
+    screen_routes: ScreenRouteRule[];
+    /**
+     * The feedback form's theme: 'light', 'dark', or 'auto' to follow the visitor's system setting.
+     * 'auto' by default.
+     */
+    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 +208,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 +234,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/esm/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.2 | (c) Zoho Corporation Private Limited | see LICENSE */
 const AP_TRACKING_STATUS = Object.freeze({
     USAGE_TRACKING_WITH_PII: 1,
     USAGE_TRACKING_WITHOUT_PII: 4,
@@ -83,9 +83,13 @@ const SDK_MODULE = Object.freeze({
      * authority. Where they disagree, getsdkconfig wins.
      */
     REMOTE_CONFIG: '2', // no i18n
+    EVENT: '5', // no i18n
+    API: '6', // no i18n
+    SCREEN: '10', // no i18n
     SESSION: '11', // no i18n
     FEEDBACK: '12', // no i18n
-    CRASH: '13', // no i18n
+    /** Uncaught and reported JavaScript errors: js_error. 13 (crash) and 14 (nonfatal) are the native SDKs'. */
+    JS_ERROR: '15', // no i18n
     REMOTE_LOGGER: '17', // no i18n
     HEATMAP: '18', // no i18n
 });
@@ -101,9 +105,10 @@ const LOG_FILENAME_MAX = 100;
  */
 const DEVICE_NAME_MAX = 100;
 /**
- * The `level` every line goes out with. Everything the remote logger carries is a failure inside
- * the SDK — logFailure is its only caller — so the level never varies. 3 is what the v2 reference
- * shows in its only example; the scale itself is not documented anywhere we can see.
+ * The `level` a remote log line goes out with when it has none of its own: 3, Info. Every line an
+ * app writes with AppticsLogger carries its level (1 verbose to 5 error, see LOG_LEVEL in
+ * remotelog/logger.ts). Only a line an older SDK stored, when the SDK logged its own failures
+ * there, has none; it is sent as Info rather than having the batch refused for a missing level.
  */
 const REMOTE_LOG_LEVEL = 3;
 /**
@@ -113,33 +118,19 @@ const REMOTE_LOG_LEVEL = 3;
  * enough that a tab left open overnight is not still sending every call to its debug twin.
  */
 const DEBUG_IDLE_MS = 60 * 60 * 1000;
-/** Idle minutes that end a session. Lives on state, not in _config, but defaults here. */
+/** Minutes a tab can be inactive before its session ends. Lives on state, not in _config, but defaults here. */
 const DEFAULT_INACTIVE_MINUTES = 30;
 /** Global defaults. `state._config` holds a mutable copy per init. */
 const AP_CONFIG = Object.freeze({
     // the version is per path (API_VERSIONS); this is only the part before it
     endpoint: '/sdk/web/', // no i18n
     method: 'POST', // no i18n
-    transport: 'XHR', // no i18n
-    track_link_timeout: 300,
-    cookie_expiration_days: 365,
-    storage_type: 'localStorage', // no i18n
-    enable_batch_requests: true,
     batch_size: 50,
     batch_flush_interval: 30000,
-    getupdates_interval: 120000, // 2 minutes in milliseconds
+    getupdates_interval: 120000, // 2 minutes in milliseconds, when getsdkconfig gives no next_check_after
     batch_request_timeout: 7,
-    auto_starts_batch: true,
-    mode: 1,
-    default_group_name: 'default', // no i18n
-    default_optin_status: AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII,
-    enable_pageview_tracking: false,
-    save_referrer: true,
     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
@@ -152,15 +143,26 @@ 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.
+     * Record uncaught errors and unhandled promise rejections, from the window's `error` and
+     * `unhandledrejection` events. On by default; AppticsError.setErrorTracking() switches it later.
      */
-    show_logs: false,
+    track_error: true,
     /**
-     * Record sessions automatically. On by default; false is Android's
-     * automaticSessionsTrackingStatus = false: no sessions, while events and screens still are.
+     * Record clicks on elements tagged `apeventaction` (or `data-apeventaction`) as events. On by
+     * default; AppticsEvent.setClickTracking() switches it later.
      */
-    track_session: true,
+    track_click: true,
+    /**
+     * 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.
+     */
+    screen_routes: [],
+    /**
+     * The feedback form's theme: 'light', 'dark', or 'auto' to follow the visitor's system setting.
+     * 'auto' by default.
+     */
+    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
@@ -206,7 +208,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
@@ -241,10 +253,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
@@ -274,4 +292,4 @@ const BLOCKED_WS = Object.freeze([
     'storebot-google', // no i18n
 ]);
 
-export { API_VERSIONS, AP_CONFIG, AP_CONSTANTS, AP_FEEDBACK_TYPE, AP_LOG_MODULE, AP_TRACKING_STATUS, BLOCKED_WS, CONFIG_ALIASES, CONSOLE_LOG_MAX_BODY, DEBUG_CAPABLE_PATHS, DEBUG_IDLE_MS, DEFAULT_API_PATHS, DEFAULT_INACTIVE_MINUTES, DEVICE_NAME_MAX, LOG_FILENAME_MAX, LOG_FUNCTION_MAX, PATHS_WITHOUT_ORG, REMOTE_LOG_LEVEL, REQUIRED_CONFIG, RETRY_CAPABLE_PATHS, SDK_MODULE };
+export { API_VERSIONS, AP_CONFIG, AP_CONSTANTS, AP_FEEDBACK_TYPE, AP_LOG_MODULE, AP_TRACKING_STATUS, BLOCKED_WS, CONFIG_KEYS, CONSOLE_LOG_MAX_BODY, DEBUG_CAPABLE_PATHS, DEBUG_IDLE_MS, DEFAULT_API_PATHS, DEFAULT_INACTIVE_MINUTES, DEVICE_NAME_MAX, LOG_FILENAME_MAX, LOG_FUNCTION_MAX, PATHS_WITHOUT_ORG, REMOTE_LOG_LEVEL, REQUIRED_CONFIG, RETIRED_CONFIG_NAMES, RETRY_CAPABLE_PATHS, SDK_MODULE };

package/dist/esm/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;