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

package/dist/cjs/remotelog/send.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');
@@ -42,7 +42,7 @@ function entryFor(item) {
     var entry = {
         sessionstarttime: state._ZAP._current_session.starttime || item.happenedat || utils.nowMs(),
         logtime: item.happenedat || utils.nowMs(),
-        // an app's line carries the level it was logged at; the SDK's own failures carry none
+        // an app's line carries the level it was logged at; only a line an older SDK stored has none
         level: Number(item.level) || constants.REMOTE_LOG_LEVEL,
         logmessage: String(item.exceptionlog).slice(0, constants.CONSOLE_LOG_MAX_BODY),
         function: String(item.module || 'SDK').slice(0, constants.LOG_FUNCTION_MAX), // no i18n
@@ -87,7 +87,7 @@ function trim(items) {
     if (keepFrom === 0) {
         return items;
     }
-    storage.consolelog_transactions.remove(items.slice(0, keepFrom));
+    storage.remotelog_transactions.remove(items.slice(0, keepFrom));
     return items.slice(keepFrom);
 }
 /**
@@ -95,21 +95,21 @@ function trim(items) {
  * retrying it could only fail the same way and would hold every later line behind it.
  */
 function sendStoredLogs() {
-    if (sending || !gate.remoteLogSendable() || navigator.onLine === false) {
+    if (sending || !gate.remoteLoggerReachable() || navigator.onLine === false) {
         return Promise.resolve();
     }
     sending = true;
-    return storage.consolelog_transactions.all().then(function (stored) {
+    return storage.remotelog_transactions.all().then(function (stored) {
         var batch = trim(stored).slice(0, MAX_PER_BATCH);
         if (batch.length === 0) {
             return undefined;
         }
         return transport.postToApptics('consolelog', bodyFor(batch), transport.apiHeaders(), LABEL).then(function () {
-            return storage.consolelog_transactions.remove(batch);
+            return storage.remotelog_transactions.remove(batch);
         }, function (err) {
             if (transport.isPermanentRefusal(err)) {
                 logger.warnAlways('apptics: the server refused these log lines, so they were dropped: ' + String(err && err.message)); // no i18n
-                return storage.consolelog_transactions.remove(batch);
+                return storage.remotelog_transactions.remove(batch);
             }
             logger.Console.log(LABEL + ': ' + String(err)); // no i18n
             return undefined;
@@ -126,20 +126,20 @@ function sendStoredLogs() {
  * stay stored until the server has confirmed them.
  */
 function forgetStoredLogs() {
-    if (!gate.remoteLogSendable()) {
+    if (!gate.remoteLoggerReachable()) {
         return Promise.resolve();
     }
-    return storage.consolelog_transactions.all().then(function (stored) {
+    return storage.remotelog_transactions.all().then(function (stored) {
         if (stored.length === 0) {
             return undefined;
         }
         var batch = stored.slice(0, MAX_PER_BATCH);
         // removed once the server has them; lines whose answer never comes go on the next visit
         transport.postKeepalive('consolelog', bodyFor(batch), transport.apiHeaders(), LABEL).then(function () {
-            return storage.consolelog_transactions.remove(batch);
+            return storage.remotelog_transactions.remove(batch);
         }, function (err) {
             if (transport.isPermanentRefusal(err)) {
-                return storage.consolelog_transactions.remove(batch);
+                return storage.remotelog_transactions.remove(batch);
             }
             logger.Console.log(LABEL + ': ' + String(err)); // no i18n
             return undefined;

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

@@ -0,0 +1,12 @@
+/**
+ * The app logger, shipped as its own entry point:
+ *   import { AppticsLogger } from '@zoho_apptics/apptics-js-sdk/remote-logger';
+ *
+ * AppticsLogger: verbose / debug / info / warn / error(message, props?), shown on the
+ * console's Remote Logger page. A line is recorded as it is written, with no switch to turn on.
+ * Apps that don't import it don't ship it.
+ */
+import { AppticsLogger } from '../remotelog/logger.js';
+export { AppticsLogger };
+export type { AppticsLogger as AppticsLoggerApi } from '../remotelog/logger.js';
+export default AppticsLogger;

package/dist/cjs/remotelogger/index.js

@@ -0,0 +1,18 @@
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.2 | (c) Zoho Corporation Private Limited | see LICENSE */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var logger = require('../remotelog/logger.js');
+
+/**
+ * The app logger, shipped as its own entry point:
+ *   import { AppticsLogger } from '@zoho_apptics/apptics-js-sdk/remote-logger';
+ *
+ * AppticsLogger: verbose / debug / info / warn / error(message, props?), shown on the
+ * console's Remote Logger page. A line is recorded as it is written, with no switch to turn on.
+ * Apps that don't import it don't ship it.
+ */
+
+exports.AppticsLogger = logger.AppticsLogger;
+exports.default = logger.AppticsLogger;

package/dist/cjs/scheduler.d.ts

@@ -3,6 +3,8 @@
  * response (page hide), so they survive the page going away.
  */
 export declare function flush(forget?: boolean): Promise<void>;
-/** Starts the flush and getupdates intervals once; later calls do nothing until stopTimers(). */
+/** Apptics.flush(): flush(), at most once every CALLED_FLUSH_GAP_MS. A call sooner sends nothing. */
+export declare function calledFlush(): Promise<void>;
+/** Starts the flush interval once; later calls do nothing until stopTimers(). */
 export declare function startTimers(): void;
 export declare function stopTimers(): void;

package/dist/cjs/scheduler.js

@@ -1,9 +1,9 @@
-/*! @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');
-var utils = require('./core/utils.js');
 var logger = require('./core/logger.js');
+var utils = require('./core/utils.js');
 var consent = require('./core/consent.js');
 var batch = require('./core/batch.js');
 var send = require('./engagement/send.js');
@@ -25,13 +25,30 @@ function flush(forget) {
     return send.sendEngagementData(forget).then(function () {
         return send$1.sendErrorData(forget);
     }).then(function () {
-        // no-op unless the heatmap entry was imported, which is what sets the hook
+        // the hook heatmap/send.ts sets
         return hooks.hooks.sendHeatmaps(forget);
     });
 }
+/**
+ * How often Apptics.flush() sends when it is called by hand, from the console or the app's own
+ * code: once every 15 seconds, however often it is called. The SDK's own sends (the flush
+ * interval, page hide and close, back online) call flush() directly and are not held to it.
+ */
+const CALLED_FLUSH_GAP_MS = 15 * 1000;
+/** When Apptics.flush() last sent; 0 until it has. */
+var calledFlushAt = 0;
+/** Apptics.flush(): flush(), at most once every CALLED_FLUSH_GAP_MS. A call sooner sends nothing. */
+function calledFlush() {
+    var now = utils.nowMs();
+    if (calledFlushAt > 0 && now - calledFlushAt < CALLED_FLUSH_GAP_MS) {
+        logger.Console.log('Apptics.flush: sent ' + (now - calledFlushAt) + ' ms ago; it sends at most once every ' + CALLED_FLUSH_GAP_MS + ' ms, and the timer sends the rest'); // no i18n
+        return Promise.resolve();
+    }
+    calledFlushAt = now;
+    return flush();
+}
 var sendingInterval = null;
-var getUpdatesInterval = null;
-/** Starts the flush and getupdates intervals once; later calls do nothing until stopTimers(). */
+/** Starts the flush interval once; later calls do nothing until stopTimers(). */
 function startTimers() {
     if (sendingInterval === null) {
         sendingInterval = setInterval(function () {
@@ -48,31 +65,17 @@ function startTimers() {
             });
         }, state.getConfig('batch_flush_interval')); // no i18n
     }
-    if (getUpdatesInterval === null) {
-        // the interval is the floor, not the schedule: getsdkconfig answers with next_check_after,
-        // and asking again before then is a call the server has already told us it will not answer
-        // differently. The timer still ticks so a server that sends no hint behaves as before.
-        getUpdatesInterval = setInterval(function () {
-            if (state._ZAP._nextConfigCheck > 0 && utils.nowMs() < state._ZAP._nextConfigCheck) {
-                return;
-            }
-            logger.Console.log('scheduleToGetUpdatesFromServer: asking the server for its config'); // no i18n
-            index.getUpdatesFromServer().catch(function (err) {
-                logger.Console.log(err);
-            });
-        }, state.getConfig('getupdates_interval')); // no i18n
-    }
 }
 function stopTimers() {
     if (sendingInterval !== null)
         clearInterval(sendingInterval);
-    if (getUpdatesInterval !== null)
-        clearInterval(getUpdatesInterval);
     sendingInterval = null;
-    getUpdatesInterval = null;
     batch.clearDefer();
+    index.stopServerSettingChecks();
+    calledFlushAt = 0;
 }
 
+exports.calledFlush = calledFlush;
 exports.flush = flush;
 exports.startTimers = startTimers;
 exports.stopTimers = stopTimers;

package/dist/cjs/types.d.ts

@@ -1,8 +1,15 @@
 import type { AP_FEEDBACK_TYPE, AP_TRACKING_STATUS } from './core/constants.js';
 import type { UserBuilder } from './user/index.js';
 import type { ApiTrackingBuilder, ApiTrackingConfig } from './engagement/api-rules.js';
-import type { DefinedEvent } from './engagement/defined-events.js';
-import type { AppticsLogger } from './remotelog/logger.js';
+import type { DefinedEvent, DefinedEvents } from './engagement/defined-events.js';
+/** One entry of screen_routes: a route pattern, or an exact path or a regular expression with the name to record. */
+export type ScreenRoute = string | {
+    equals: string;
+    name: string;
+} | {
+    regex: RegExp | string;
+    name: string;
+};
 /** Loose record for legacy payloads and server JSON that are built and sent as-is. */
 export type Dict = Record<string, any>;
 /** An item in the engagement or error queue. */
@@ -30,14 +37,14 @@ export interface ServerResult<T = Dict> {
 export type TrackingStatus = (typeof AP_TRACKING_STATUS)[keyof typeof AP_TRACKING_STATUS];
 export type FeedbackType = (typeof AP_FEEDBACK_TYPE)[keyof typeof AP_FEEDBACK_TYPE];
 export type Properties = Record<string, unknown>;
-/** The config init() requires. The console snippet provides the same shape as window.appticssettings._defaultoptions. */
+/** The config init() requires. */
 export interface AppticsConfig {
-    /** Apptics host every request goes to, e.g. https://apptics.localzoho.com (a trailing slash is ignored). */
-    serviceUrl: string;
-    /** The app's token, sent as the `zak` header on app/addversion and device registration. */
-    zak: string;
-    /** App identifier, e.g. com.zoho.web.zylker. */
-    identifier: string;
+    /** Apptics host every request goes to, e.g. https://apptics.zoho.com (a trailing slash is ignored). Was `serviceUrl`. */
+    base_url: string;
+    /** The app's key from the console, sent as the `zak` header on app/addversion and device registration. Was `zak`. */
+    auth_key: string;
+    /** The app's domain as registered in the console, e.g. com.zoho.web.zylker. Was `identifier`. */
+    app_domain: string;
     /**
      * Your app's version or build number, e.g. '2.4.0' or 512. Required: everything the SDK reports
      * is only meaningful against the build it came from, so there is no default. Changing it
@@ -54,12 +61,10 @@ export interface AppticsConfig {
     zsoid?: string;
     /** @deprecated ignored: app/addversion answers with the project id */
     projectID?: string;
-    /** @deprecated console-snippet name for serviceUrl */
+    /** @deprecated 1.x console-snippet name for base_url: still read, with a warning */
     base_domain?: string;
-    /** @deprecated console-snippet name for zak */
+    /** @deprecated 1.x console-snippet name for auth_key: still read, with a warning */
     token?: string;
-    /** Data centre key for Quartz screen recording: US, EU, IN, AU, CN, CA, JP, SA, AE, Local, or '-' to disable. */
-    DC?: string;
     /**
      * Debug mode: send engagement, exception and log payloads to their `debug/` twins, which answer
      * with a request id and a link to the server's own logs, for following in the Apptics web
@@ -69,17 +74,10 @@ export interface AppticsConfig {
     /** Log the SDK's own activity to the browser console. Off by default. */
     console_log?: boolean;
     ignore_do_not_track?: boolean;
-    /**
-     * Send the SDK's own failures to console/addlog, so they can be read from the Apptics console.
-     * This carries no app data: one line per failure, tagged with the SDK module it happened in.
-     */
-    remote_log?: boolean;
-    quartz_workspace_key?: string;
-    quartz_department_key?: string;
     /**
      * Record the app's API calls automatically, by wrapping XHR and fetch. Off by default. The SDK's
      * own requests are never recorded. Which hosts and endpoints are recorded, and under what path,
-     * is set with configureApiTracking(new ApiTrackingBuilder()...build()).
+     * is set with AppticsApi.configure(new AppticsApi.ApiTrackingBuilder()...build()).
      */
     track_api?: boolean;
     /**
@@ -90,24 +88,48 @@ export interface AppticsConfig {
      */
     track_screen?: boolean;
     /**
-     * Print each `logger` line to the browser console too, at its level, 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 automatically. On by default; set this
+     * false to record only the errors the app hands to AppticsError.trackError(). Switched later with
+     * AppticsError.setErrorTracking().
+     */
+    track_error?: boolean;
+    /**
+     * Record clicks on elements tagged `apeventaction` (or `data-apeventaction`) as events, in the
+     * group of the nearest `apgroupaction` around them. On by default; switched later with
+     * AppticsEvent.setClickTracking().
      */
-    show_logs?: boolean;
+    track_click?: boolean;
     /**
-     * Record sessions automatically. On by default; `false` records no sessions, while events,
-     * screens and the rest still are — Android's `automaticSessionsTrackingStatus = false`.
+     * How automatic screen tracking names a path, tried in order; the first that matches wins, and a
+     * path none matches keeps its own name. Each entry is one of:
+     * - a route pattern, `'/users/{id}/orders'`: `{name}`, `:name` and `*` each match one segment,
+     *   recorded as a star, so `/users/42/orders` and `/users/43/orders` are one screen;
+     * - `{ equals: '/', name: 'Home' }`: that path exactly;
+     * - `{ regex: /^\/orders\/\d+$/, name: 'Order detail' }`: any path the regular expression matches.
+     * Paths are matched without their query string.
      */
-    track_session?: boolean;
+    screen_routes?: ScreenRoute[];
+    /**
+     * The feedback form's theme: 'light', 'dark', or 'auto' (the default) to follow the visitor's
+     * system setting. The colors are CSS variables on the form (`--zasdk-primary-color` and the rest
+     * of the `--zasdk-*` set), which a page may override.
+     */
+    feedback_theme?: 'light' | 'dark' | 'auto';
     /** How often queued data is sent, in milliseconds. Default 30000, at least 1000. */
     batch_flush_interval?: number;
-    /** How often the server's tracking flags are fetched, in milliseconds. Default 120000, at least 10000. */
+    /**
+     * How long to wait before reading the server's tracking settings again, in milliseconds, when its
+     * answer gives no time for the next check (next_check_after). Default 120000, at least 10000.
+     */
     getupdates_interval?: number;
     /** Most items in one batch. Default 50, between 1 and 500. */
     batch_size?: number;
     /** Days an unsent item is kept before it is dropped. Default 7, between 1 and 30. */
     batch_request_timeout?: number;
-    /** Idle minutes that end a session. Default 30, between 1 and 1440. */
+    /**
+     * Minutes a tab can be inactive (hidden, minimised, in the background) before its session ends,
+     * at the moment the user left. Default 30, between 1 and 1440.
+     */
     inactiveduration?: number;
     /**
      * How long a visit must last before its session is recorded, in milliseconds. Default 5000, at
@@ -116,8 +138,8 @@ export interface AppticsConfig {
      */
     min_session_duration?: number;
     /**
-     * Record where people click and how far they scroll. Off by default, and it does nothing unless
-     * the app also imports '@zoho_apptics/apptics-js-sdk/heatmap'.
+     * Record where people click and how far they scroll. Off by default;
+     * AppticsHeatmap.setHeatmapTracking() switches it later.
      */
     track_heatmap?: boolean;
     /** Most heatmap records one visit may produce. Default 500; capture pauses past it. */
@@ -140,6 +162,26 @@ export interface UserValidationResult {
         keys: string[];
     }>;
 }
+/**
+ * Screen recording in the feedback form, as getsdkconfig's `quartz` block sets it up:
+ *   { quartz_enabled, quartz_workspace, quartz_department, quartz_domain, quartz_cdn_url }
+ * The app passes none of it; the console's settings for the app decide.
+ */
+export interface QuartzSettings {
+    enabled: boolean;
+    /** quartz_workspace: the workspace the recording is filed under. */
+    workspace: string;
+    /** quartz_department: the department within it. */
+    department: string;
+    /** quartz_domain, e.g. zoho.com: recordings go to https://quartz.<domain>. */
+    domain: string;
+    /**
+     * quartz_cdn_url: the Quartz script, loaded by the SDK when the form needs it. When the answer
+     * has none, the SDK uses Zoho's CDN for the serviceUrl (static.localzohocdn.com for localzoho,
+     * static.zohocdn.com otherwise).
+     */
+    cdnUrl: string;
+}
 export interface QuartzApi {
     startRecording(details: {
         workspaceLinkName: string;
@@ -151,8 +193,9 @@ export interface QuartzApi {
         quartzBranding: boolean;
     }): void;
     clearFeedback(): void;
-    endRecording(): void;
-    setVideoContent(element: Element | null): void;
+    /** Resolves once the recording has ended and is stored; Quartz's own build returns a Promise. */
+    endRecording(): Promise<unknown> | void;
+    setVideoContent(element: Element | null): Promise<unknown> | void;
     submitRecording(details: {
         email: string;
         subject: string;
@@ -216,97 +259,172 @@ export interface HeatmapRecord {
     is_rage_click: 0 | 1;
     is_dead_click: 0 | 1;
 }
-/** What `AppticsTrackError` accepts: a window `error` / `unhandledrejection` event or the same shape. */
+/** What `AppticsError.trackError` accepts: a window `error` / `unhandledrejection` event or the same shape. */
 export type ErrorLike = Event | {
     type?: string;
     error?: unknown;
     reason?: unknown;
 };
+/** What sendFeedback() sends. Every key is optional. */
+export interface SendFeedbackOptions {
+    /** AppticsFeedback.AP_FEEDBACK_TYPE: BUG (0), FEEDBACK (1, the default), HELP (2), REPORT (3). */
+    type?: FeedbackType;
+    /** The feedback's text. */
+    message?: string;
+    /** Files to attach: at most 5, 10 MB in all. */
+    attachments?: FileList | File[] | null;
+    /** Log files of the app's own to send along. */
+    logFiles?: FileList | File[] | null;
+    /** The addDiagnosticsInfo() entries: unset sends them when there are any, false never does. */
+    includeDiagnostics?: boolean;
+    /** The addFeedbackLog() lines: unset sends them when there are any, false never does. */
+    includeLog?: boolean;
+    /** Sends it from nobody. Unset, it is from the active user AppticsUser.setUser registered. */
+    isAnonymous?: boolean;
+}
+/** What feedbackFormOpen() fills the form in with. Every key is optional. */
+export interface FeedbackOpenOptions {
+    /** The tab the form opens on: AppticsFeedback.AP_FEEDBACK_TYPE.BUG, FEEDBACK, HELP or REPORT. */
+    type?: FeedbackType;
+    /** Text already in the description. */
+    message?: string;
+    /** Starts the logs toggle on. */
+    includeLog?: boolean;
+    /** Starts the diagnostics toggle on. */
+    includeDiagnostics?: boolean;
+    /** Files already attached: at most 5, 10 MB in all. */
+    attachments?: FileList | File[] | null;
+    /** Log files of the app's own already attached. */
+    logFiles?: FileList | File[] | null;
+    /** Starts the user picker on Anonymous, even with a user registered. */
+    isAnonymous?: boolean;
+}
 /** The optional feedback modal, from '@zoho_apptics/apptics-js-sdk/feedback'. */
 export interface AppticsFeedbackApi {
     /**
      * Sends feedback without the form. Resolves once it is sent; rejects when it wasn't: the SDK
      * has not started (no init()), the browser is offline, or the server refused it.
      */
-    sendFeedback(type?: FeedbackType, message?: string, attachments?: FileList | File[] | null, logFiles?: FileList | File[] | null, 
-    /** dyninfo.txt (diagnostics entries + device info): unset sends it when diagnostics are waiting. */
-    includeDyninfo?: boolean, 
-    /** Stored addFeedbackLog() lines: unset sends them when there are any, false never does. */
-    includeLog?: boolean): Promise<void>;
+    sendFeedback(options?: SendFeedbackOptions): Promise<void>;
+    /** Opens the form, filled in with `options` when they are given. */
+    feedbackFormOpen(options?: FeedbackOpenOptions): void;
+    feedbackFormClose(): void;
+    /** The feedback types: BUG, FEEDBACK, HELP, REPORT. */
+    AP_FEEDBACK_TYPE: typeof AP_FEEDBACK_TYPE;
+    /** Records a timestamped line, sent as feedbacklog.txt with the next feedback submission. */
+    addFeedbackLog(message: string): void;
+    /** Records a diagnostics key/value under `heading`, sent inside dyninfo.txt with the next feedback. */
+    addDiagnosticsInfo(heading: string, key: string, value: unknown): void;
     /**
-     * Opens the form. Every argument is optional: `type` and `message` pre-fill it, the include
-     * flags start the log and diagnostics toggles on, and `isAnonymous` starts the user picker on
-     * Anonymous even when a user is registered.
+     * The form's theme from now on, restyling one open now: 'light', 'dark', or 'auto' to follow
+     * the visitor's system setting. For a page with its own theme switch, called as it changes.
      */
-    feedbackOpen(type?: FeedbackType, message?: string, includeLog?: boolean, includeDyninfo?: boolean, attachments?: FileList | File[] | null, logFiles?: FileList | File[] | null, isAnonymous?: boolean): void;
-    feedbackClose(): void;
+    setFeedbackTheme(theme: 'light' | 'dark' | 'auto'): void;
 }
-export interface AppticsApi {
-    /** Android's Apptics. */
+export interface AppticsSdk {
+    /** Android's Apptics: starting the SDK, and what applies to all of it. */
     Apptics: {
-        /** Starts the SDK. The config object is required; the console snippet supplies it via auto-init. */
+        /** Starts the SDK with the app's config object, which is required. */
         init(config: AppticsConfig): boolean;
+        /** Resolves true once start-up (storage load, device, session) has finished; false if it can't start. */
+        ready(): Promise<boolean>;
+        /**
+         * Sends stored engagements, errors and heatmap records now; resolves once they have gone out.
+         * At most once every 15 seconds: a call sooner than that sends nothing and resolves at once,
+         * and what is queued goes with the next timed send.
+         */
+        flush(): Promise<void>;
+        /** Clears stored identity, queued data and remote config values, then starts again. */
+        reset(): void;
+        /**
+         * Turns debug mode on, before or after Apptics.init(). Engagement, exception and log then go to
+         * their `debug/` twins, whose answers carry a request id and a link into the server's own logs. It
+         * switches itself off after an hour with nothing tracked.
+         */
+        enableDebug(): void;
+        /** Turns debug mode off, before or after Apptics.init(); wins over `debug` in init(). */
+        disableDebug(): void;
     };
     /** Android's AppticsEvents. */
-    AppticsEvents: {
-        /** An event. An invalid name or group is not logged; a group left out is `default`. */
-        addEvent(eventName: string, groupName?: string, properties?: Properties): void;
-        /** A defined event (DefinedEvents.AP_USER_LOGIN, …), which brings its own group. */
+    AppticsEvent: {
+        /** Apptics' defined events, as Android's DefinedEvents, to log with addEvent. */
+        DefinedEvents: typeof DefinedEvents;
+        /** An event. The group is required: an event without one, or with an invalid name or group, is not logged, and the console says why. */
+        addEvent(eventName: string, groupName: string, properties?: Properties): void;
+        /** A defined event (AppticsEvent.DefinedEvents.AP_USER_LOGIN, …), which brings its own group. */
         addEvent(definedEvent: DefinedEvent, properties?: Properties): void;
+        /**
+         * Turns click tracking from markup (`apeventaction`) on or off after Apptics.init(); `enabled`
+         * defaults to true. The `track_click` config flag sets it at start-up.
+         */
+        setClickTracking(enabled?: boolean): void;
     };
-    /** Apptics' defined events, as Android's DefinedEvents. */
-    DefinedEvents: Readonly<Record<string, DefinedEvent>>;
     /** Android's AppticsScreenTracker. */
-    AppticsScreenTracker: {
+    AppticsScreen: {
         /** Records a screen view and returns its id, for outScreen; '' for an invalid name. */
         inScreen(screenName: string, properties?: Properties): string;
         /** Ends the screen view inScreen began, before the next screen would. */
         outScreen(id: string): void;
+        /**
+         * Turns automatic screen tracking on or off after Apptics.init(); `enabled` defaults to true.
+         * The `track_screen` config flag sets it at start-up. inScreen() records either way.
+         */
+        setScreenTracking(enabled?: boolean): void;
     };
     /** Android's AppticsApiTracker. */
-    AppticsApiTracker: {
+    AppticsApi: {
+        /** Builds the rules configure takes: `new AppticsApi.ApiTrackingBuilder()…build()`. */
+        ApiTrackingBuilder: typeof ApiTrackingBuilder;
         /** Begins timing one call; returns the id endTrackApi takes. */
         startTrackApi(url: string, method?: string): string;
         /** Finishes the call startTrackApi began, and records it. */
         endTrackApi(id: string, responseCode: number, responseMessage?: string): void;
         /** The rules API tracking records by, from ApiTrackingBuilder. Works before Apptics.init(). */
         configure(config: ApiTrackingConfig | ApiTrackingBuilder): void;
+        /**
+         * Turns automatic API tracking on or off after Apptics.init(); `enabled` defaults to true.
+         * The `track_api` config flag sets it at start-up.
+         */
+        setApiTracking(enabled?: boolean): void;
+        /** @deprecated renamed setApiTracking; this name still works, with a console warning */
+        enableApiTracking(enabled?: boolean): void;
     };
-    ApiTrackingBuilder: typeof ApiTrackingBuilder;
-    /** Android's AppticsLogger: off until enable(), then v / d / i / w / e(tag, message). */
-    AppticsLogger: AppticsLogger;
-    /** Resolves true once start-up (storage load, device, session) has finished; false if it can't start. */
-    ready(): Promise<boolean>;
-    /**
-     * Turns debug mode on, before or after Apptics.init(). Engagement, exception and log then go to
-     * their `debug/` twins, whose answers carry a request id and a link into the server's own logs. It
-     * switches itself off after an hour with nothing tracked.
-     */
-    enableDebug(): void;
-    /** Turns debug mode off, before or after Apptics.init(); wins over `debug` in init(). */
-    disableDebug(): void;
-    /**
-     * Turns automatic API tracking on or off after Apptics.init(). Equivalent to the `track_api`
-     * config flag, which is the usual way to set it.
-     */
-    enableApiTracking(enabled?: boolean): void;
-    /** Reports an error the app caught, or an `error` / `unhandledrejection` event. */
-    AppticsTrackError(error: ErrorLike, properties?: Properties): void;
-    enableGlobalErrorHandler(enabled?: boolean): void;
-    /** Properties may be a plain object, or the result of UserBuilder.build(). */
-    AppticsSetUser(userid: string, groupid?: string, properties?: Properties | UserValidationResult): void;
-    getUser(): UserInfo;
-    users: {
+    /** Errors the app caught, and the switch for tracking uncaught ones. */
+    AppticsError: {
+        /** Reports an error the app caught, or an `error` / `unhandledrejection` event. */
+        trackError(error: ErrorLike, properties?: Properties): void;
+        /**
+         * Turns the automatic tracking of uncaught errors and unhandled rejections on or off after
+         * Apptics.init(); `enabled` defaults to true. The `track_error` config flag sets it at start-up.
+         */
+        setErrorTracking(enabled?: boolean): void;
+        /** @deprecated renamed setErrorTracking; this name still works, with a console warning */
+        trackGlobalErrorHandler(enabled?: boolean): void;
+    };
+    /** Android's AppticsUser. */
+    AppticsUser: {
+        /** Registers the signed-in user. Properties may be a plain object, or the result of UserBuilder.build(). */
+        setUser(userid: string, groupid?: string, properties?: Properties | UserValidationResult): void;
+        /** The registered user, or {} when there is none. */
+        getUser(): UserInfo;
+        /** Builds the user's properties for setUser. */
         UserBuilder: typeof UserBuilder;
     };
-    setTrackingStatus(status: TrackingStatus): void;
-    getTrackingStatus(): TrackingStatus;
-    flush(): void;
-    /** Records a timestamped line, sent as feedbacklog.txt with the next feedback submission. */
-    addFeedbackLog(message: string): void;
-    /** Records a diagnostics key/value under `heading`, sent inside dyninfo.txt with the next feedback. */
-    addDiagnosticsInfo(heading: string, key: string, value?: unknown): void;
-    reset(): void;
-    AP_TRACKING_STATUS: typeof AP_TRACKING_STATUS;
-    AP_FEEDBACK_TYPE: typeof AP_FEEDBACK_TYPE;
+    /** Click and scroll capture for the console's heatmaps. */
+    AppticsHeatmap: {
+        /**
+         * Starts or stops recording clicks and scrolls; `enabled` defaults to true. The
+         * `track_heatmap` config flag sets it at start-up.
+         */
+        setHeatmapTracking(enabled?: boolean): void;
+        /** @deprecated renamed setHeatmapTracking; this name still works, with a console warning */
+        trackHeatmap(on?: boolean): void;
+    };
+    /** Android's AppticsSettings: what the SDK may track for this visitor. */
+    AppticsSettings: {
+        /** The states setTrackingStatus takes. */
+        AP_TRACKING_STATUS: typeof AP_TRACKING_STATUS;
+        setTrackingStatus(status: TrackingStatus): void;
+        getTrackingStatus(): TrackingStatus;
+    };
 }