@zoho_apptics/apptics-js-sdk 1.0.1 → 2.0.0-beta

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

@@ -0,0 +1,69 @@
+import { type ApConfig } from './constants.js';
+import type { DeviceInfo, Dict, TrackingStatus, UserInfo } from '../types.js';
+/** Runtime state shared by every module (the former `_ZAP` object). */
+export interface State {
+    _initialised: boolean;
+    /** Start-up finished (storage loaded, session open, timers running). */
+    _ready: boolean;
+    /** Public calls made after init() and before _ready, replayed in order. */
+    _pending: Array<() => void>;
+    _readyPromise: Promise<boolean> | null;
+    _regDeviceSending: boolean;
+    _regDeviceResolve: Array<(value: any) => void>;
+    _regDeviceReject: Array<(reason: any) => void>;
+    _sending: boolean;
+    _deferSendTimer: ReturnType<typeof setTimeout> | null;
+    _config: ApConfig;
+    _defaultoptions: Dict;
+    inactiveduration: number;
+    _token: string;
+    _frameworkID: number;
+    _platform: string;
+    _isanonrequired: boolean;
+    _devicestatus: TrackingStatus;
+    _uuid: string;
+    _apid: string;
+    _mapid: string;
+    _device_info: DeviceInfo;
+    _user_info: UserInfo;
+    _current_screen: Dict;
+    _current_session: Dict;
+    _properties: Dict;
+    _ignoreDnt: boolean;
+    _isGlobalErrorTracking: boolean;
+    _shouldTrack: boolean;
+    _engagementTracking: boolean;
+    _errorTracking: boolean;
+    /** getsdkconfig module 18. Heatmap has its own flag in v2; before that it rode engagement. */
+    _heatmapTracking: boolean;
+    /** getsdkconfig module 17. */
+    _remoteLoggerEnabled: boolean;
+    /** getsdkconfig's module flag for remote config, which is the authority on whether it runs. */
+    _remoteConfigEnabled: boolean;
+    /** What the last getupdates answer said, used only to stop asking about a module it reported off. */
+    _remoteConfigReported: boolean;
+    /** getsdkconfig module 12. */
+    _feedbackEnabled: boolean;
+    _quartzEnabled: boolean;
+    /** Epoch ms getsdkconfig asked us to wait until before asking again. 0 means no answer yet. */
+    _nextConfigCheck: number;
+    /**
+     * When debug mode switches itself off, as a timestamp; 0 while it is not running.
+     * Every tracked item pushes it back, so it only arrives after a genuinely idle hour.
+     */
+    _debugUntil: number;
+    _trackinfo: Dict;
+}
+export declare const _ZAP: State;
+/** Restores every field to its default. The object identity is kept, since modules hold a reference to it. */
+export declare function resetState(): void;
+export declare function getConfig<K extends keyof ApConfig>(key: K): ApConfig[K];
+/** The oldest timestamp still worth keeping: now minus batch_request_timeout days. */
+export declare function oldestKeptTime(): number;
+/**
+ * True for an item too old (or dated far enough in the future to be nonsense) to be worth
+ * sending. Queues use it to drop such items on the way in, and the sender uses it to drop the
+ * ones already stored. A minute of slack absorbs clock differences between tabs and machines,
+ * so an item a few milliseconds ahead of this clock is still kept.
+ */
+export declare function isExpired(time: unknown): boolean;

package/dist/cjs/core/state.js

@@ -0,0 +1,78 @@
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta | (c) Zoho Corporation Private Limited | see LICENSE */
+'use strict';
+
+var constants = require('./constants.js');
+var utils = require('./utils.js');
+var frameworkId = require('./framework-id.js');
+
+function initialState() {
+    return {
+        _initialised: false,
+        _ready: false,
+        _pending: [],
+        _readyPromise: null,
+        _regDeviceSending: false,
+        _regDeviceResolve: [],
+        _regDeviceReject: [],
+        _sending: false,
+        _deferSendTimer: null,
+        _config: { ...constants.AP_CONFIG },
+        _defaultoptions: {},
+        inactiveduration: constants.DEFAULT_INACTIVE_MINUTES,
+        _token: '', // no i18n
+        // issued by Apptics at pack time; see scripts/register-version.mjs
+        _frameworkID: frameworkId.FRAMEWORK_ID,
+        _platform: constants.AP_CONSTANTS.BROWSER,
+        _isanonrequired: true,
+        _devicestatus: constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII,
+        _uuid: '', // no i18n
+        _apid: '', // no i18n
+        _mapid: '', // no i18n
+        _device_info: {},
+        _user_info: {},
+        _current_screen: {},
+        _current_session: {},
+        _properties: {},
+        _ignoreDnt: false,
+        _isGlobalErrorTracking: true,
+        _shouldTrack: true,
+        _engagementTracking: true,
+        _heatmapTracking: true,
+        _remoteLoggerEnabled: true,
+        _remoteConfigEnabled: true,
+        _remoteConfigReported: true,
+        _feedbackEnabled: true,
+        _nextConfigCheck: 0,
+        _debugUntil: 0,
+        _errorTracking: true,
+        _quartzEnabled: true,
+        _trackinfo: {},
+    };
+}
+const _ZAP = initialState();
+function getConfig(key) {
+    return _ZAP._config[key];
+}
+/** The oldest timestamp still worth keeping: now minus batch_request_timeout days. */
+function oldestKeptTime() {
+    return utils.nowMs() - getConfig('batch_request_timeout') * 24 * 60 * 60 * 1000; // no i18n
+}
+/** How far ahead of this clock a timestamp may be before it counts as nonsense. */
+const CLOCK_SKEW_MS = 60 * 1000;
+/**
+ * True for an item too old (or dated far enough in the future to be nonsense) to be worth
+ * sending. Queues use it to drop such items on the way in, and the sender uses it to drop the
+ * ones already stored. A minute of slack absorbs clock differences between tabs and machines,
+ * so an item a few milliseconds ahead of this clock is still kept.
+ */
+function isExpired(time) {
+    if (typeof time !== 'number' || !isFinite(time)) {
+        return false; // no usable timestamp: leave it to the caller's own rules
+    }
+    return time < oldestKeptTime() || time > utils.nowMs() + CLOCK_SKEW_MS;
+}
+
+exports._ZAP = _ZAP;
+exports.getConfig = getConfig;
+exports.isExpired = isExpired;
+exports.oldestKeptTime = oldestKeptTime;

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

@@ -0,0 +1,46 @@
+import { type Backend, type QueueName } from './db.js';
+import type { Dict, QueueItem, TrackingStatus } from '../types.js';
+/** Opens storage, migrates 1.x data and loads settings into memory. Shared by all callers. */
+export declare function storageReady(): Promise<Backend | null>;
+export interface Queue {
+    readonly name: QueueName;
+    all(): Promise<QueueItem[]>;
+    payload(): Promise<QueueItem[]>;
+    add(item: QueueItem): Promise<void>;
+    update(item: QueueItem): Promise<void>;
+    remove(items?: QueueItem[]): Promise<void>;
+    clear(): Promise<void>;
+}
+/** Sessions, screens, events and api calls waiting to be sent. */
+export declare const engagement_transactions: Queue;
+/** Errors waiting to be sent. */
+export declare const error_transactions: Queue;
+/**
+ * Feedback log lines and diagnostics entries, from addFeedbackLog() and addDiagnosticsInfo().
+ * These are not sent on their own: feedback/logs.ts renders them into the files that
+ * feedback/add carries, and removes the ones a submission took with it.
+ */
+export declare const log_transactions: Queue;
+/** Clicks and scrolls waiting for heatmap/add. */
+export declare const heatmap_transactions: Queue;
+/**
+ * Remote log lines waiting for console/addlog. Stored rather than sent straight out because the
+ * endpoint takes one line per call and counts retries (`attempt`), so a line has to outlive a
+ * failed send — and a reload.
+ */
+export declare const consolelog_transactions: Queue;
+/** Token, uuid, appversion, device_info, users, trackinfo. */
+export declare const user_defaults: {
+    all(): Dict;
+    item(key: string): any;
+    add(key: string, value: unknown): void;
+    clear(): void;
+};
+/** Opt-in status, stored as the tracking_status setting. */
+export declare const tracking_preference: {
+    _tracking_status: string;
+    all(): Dict;
+    opt_in_status(): TrackingStatus;
+    update_status(tracking_status: TrackingStatus): void;
+};
+export declare function getKeyFromDeviceInfo(key: string): any;

package/dist/cjs/core/storage.js

@@ -0,0 +1,229 @@
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta | (c) Zoho Corporation Private Limited | see LICENSE */
+'use strict';
+
+var constants = require('./constants.js');
+var state = require('./state.js');
+var logger = require('./logger.js');
+var utils = require('./utils.js');
+var db = require('./db.js');
+
+var readyPromise = null;
+var settings = {};
+/** Runs `op` once storage is ready, in call order. Never rejects. */
+function withBackend(label, fallback, op) {
+    return storageReady().then(function (b) {
+        return b ? op(b) : fallback;
+    }).catch(function (err) {
+        logger.Console.warn('apptics: storage ' + label + ' failed: ' + String(err)); // no i18n
+        return fallback;
+    });
+}
+function migrateLegacy(b) {
+    if (b.kind !== 'indexeddb' || !b.importAll) { // no i18n
+        return Promise.resolve();
+    }
+    var raw;
+    try {
+        raw = {
+            settings: localStorage.getItem(db.LEGACY_KEYS.settings),
+            engagements: localStorage.getItem(db.LEGACY_KEYS.engagements),
+            errors: localStorage.getItem(db.LEGACY_KEYS.errors),
+            logs: localStorage.getItem(db.LEGACY_KEYS.logs),
+            consolelogs: localStorage.getItem(db.LEGACY_KEYS.consolelogs),
+            // read for completeness of the shape only: 1.x never wrote this key
+            heatmaps: null,
+        };
+    }
+    catch (err) {
+        return Promise.resolve();
+    }
+    if (raw.settings === null && raw.engagements === null && raw.errors === null && raw.logs === null
+        && raw.consolelogs === null) {
+        return Promise.resolve();
+    }
+    var parse = function (text) {
+        try {
+            return text === null ? null : JSON.parse(text);
+        }
+        catch (err) {
+            return null;
+        }
+    };
+    var queues = {
+        engagements: db.asList(parse(raw.engagements)),
+        errors: db.asList(parse(raw.errors)),
+        logs: db.asList(parse(raw.logs)),
+        consolelogs: db.asList(parse(raw.consolelogs)),
+        // nothing to migrate: 1.x had no heatmaps
+        heatmaps: [],
+    };
+    queues.engagements.concat(queues.errors, queues.logs, queues.consolelogs).forEach(function (item) {
+        if (!item.id)
+            item.id = utils.getNewUUID();
+    });
+    var importAll = b.importAll.bind(b);
+    // Promise.resolve().then(...) turns a synchronous throw inside importAll into a rejection
+    return Promise.resolve().then(function () {
+        return importAll(db.asDict(parse(raw.settings)), queues);
+    }).then(function () {
+        Object.values(db.LEGACY_KEYS).forEach(function (key) {
+            try {
+                localStorage.removeItem(key);
+            }
+            catch (err) {
+                // keys stay; the import is idempotent
+            }
+        });
+        logger.Console.log('apptics: moved 1.x data from localStorage to IndexedDB'); // no i18n
+    }).catch(function (err) {
+        logger.Console.warn('apptics: 1.x data migration failed, will retry next load: ' + String(err)); // no i18n
+    });
+}
+/** Opens storage, migrates 1.x data and loads settings into memory. Shared by all callers. */
+function storageReady() {
+    if (!readyPromise) {
+        readyPromise = db.openBackend().then(function (b) {
+            if (!b) {
+                return null;
+            }
+            return migrateLegacy(b).then(function () {
+                return b.loadSettings();
+            }).then(function (loaded) {
+                // writes made before loading finished win over stored values
+                settings = Object.assign({}, loaded, settings);
+                return b;
+            });
+        }).catch(function (err) {
+            logger.Console.warn('apptics: storage unavailable: ' + String(err)); // no i18n
+            return null;
+        });
+    }
+    return readyPromise;
+}
+/** When an item happened: engagements carry starttime, errors and logs happenedat. */
+function itemTime(item) {
+    return item.starttime !== undefined ? item.starttime : item.happenedat;
+}
+/** First batch_size items, capped at 1 MB. */
+function takeBatch(items) {
+    const targetSize = 1024 * 1024; // 1 MB in bytes
+    let dataSize = 0;
+    const result = [];
+    for (const item of items.slice(0, state.getConfig('batch_size'))) { // no i18n
+        const size = utils.sizeof(JSON.stringify(item));
+        if (dataSize + size > targetSize) {
+            break;
+        }
+        result.push(item);
+        dataSize += size;
+    }
+    return result;
+}
+function createQueue(name) {
+    const queue = {
+        name: name,
+        all() {
+            return withBackend('read ' + name, [], function (b) { return b.queueAll(name); }); // no i18n
+        },
+        payload() {
+            return queue.all().then(takeBatch);
+        },
+        add(item) {
+            if (!item.id) {
+                item.id = utils.getNewUUID();
+            }
+            // a week-old item would only be dropped at send time, so don't store it at all
+            if (state.isExpired(itemTime(item))) {
+                logger.Console.warn('apptics: dropping a ' + name + ' item older than ' + state.getConfig('batch_request_timeout') + ' days'); // no i18n
+                return Promise.resolve();
+            }
+            return withBackend('add ' + name, undefined, function (b) { return b.queuePut(name, [item]); }); // no i18n
+        },
+        update(item) {
+            return withBackend('update ' + name, undefined, function (b) { return b.queuePut(name, [item]); }); // no i18n
+        },
+        remove(itemsToRemove) {
+            const ids = (itemsToRemove || []).map(function (item) { return String(item.id); });
+            return withBackend('remove ' + name, undefined, function (b) { return b.queueDelete(name, ids); }); // no i18n
+        },
+        clear() {
+            return withBackend('clear ' + name, undefined, function (b) { return b.queueClear(name); }); // no i18n
+        },
+    };
+    return queue;
+}
+/** Sessions, screens, events and api calls waiting to be sent. */
+const engagement_transactions = createQueue('engagements'); // no i18n
+/** Errors waiting to be sent. */
+const error_transactions = createQueue('errors'); // no i18n
+/**
+ * Feedback log lines and diagnostics entries, from addFeedbackLog() and addDiagnosticsInfo().
+ * These are not sent on their own: feedback/logs.ts renders them into the files that
+ * feedback/add carries, and removes the ones a submission took with it.
+ */
+const log_transactions = createQueue('logs'); // no i18n
+/** Clicks and scrolls waiting for heatmap/add. */
+const heatmap_transactions = createQueue('heatmaps'); // no i18n
+/**
+ * Remote log lines waiting for console/addlog. Stored rather than sent straight out because the
+ * endpoint takes one line per call and counts retries (`attempt`), so a line has to outlive a
+ * failed send — and a reload.
+ */
+const consolelog_transactions = createQueue('consolelogs'); // no i18n
+/* ---------------- settings (sync reads, background writes) ---------------- */
+function setSetting(key, value) {
+    settings[key] = value === undefined ? undefined : utils.cloneObject(value);
+    withBackend('save ' + key, undefined, function (b) { return b.putSetting(key, settings[key]); }); // no i18n
+}
+/** Token, uuid, appversion, device_info, users, trackinfo. */
+const user_defaults = {
+    all() {
+        return utils.cloneObject(settings);
+    },
+    item(key) {
+        const value = settings[key];
+        return value === undefined ? undefined : utils.cloneObject(value);
+    },
+    add(key, value) {
+        setSetting(key, value);
+    },
+    clear() {
+        settings = {};
+        withBackend('clear settings', undefined, function (b) { return b.clearSettings(); }); // no i18n
+    },
+};
+/** Opt-in status, stored as the tracking_status setting. */
+const tracking_preference = {
+    _tracking_status: 'tracking_status', // no i18n
+    all() {
+        return user_defaults.all();
+    },
+    opt_in_status() {
+        return (settings[tracking_preference._tracking_status] || constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITHOUT_PII);
+    },
+    update_status(tracking_status) {
+        state._ZAP._devicestatus = tracking_status;
+        // Legacy order kept: this reads the status *before* the write below (setTrackingStatus recomputes it after).
+        state._ZAP._isanonrequired =
+            tracking_preference.opt_in_status() == constants.AP_TRACKING_STATUS.USAGE_TRACKING_WITH_PII ? false : state._ZAP._isanonrequired;
+        setSetting(tracking_preference._tracking_status, tracking_status);
+    },
+};
+function getKeyFromDeviceInfo(key) {
+    var current_device_info = settings['device_info']; // no i18n
+    if (current_device_info !== undefined && current_device_info !== null && current_device_info !== '' &&
+        current_device_info[key] !== undefined && current_device_info[key] !== null && current_device_info[key] !== '') {
+        return utils.cloneObject(current_device_info[key]);
+    }
+    return null;
+}
+
+exports.consolelog_transactions = consolelog_transactions;
+exports.engagement_transactions = engagement_transactions;
+exports.error_transactions = error_transactions;
+exports.getKeyFromDeviceInfo = getKeyFromDeviceInfo;
+exports.heatmap_transactions = heatmap_transactions;
+exports.log_transactions = log_transactions;
+exports.storageReady = storageReady;
+exports.tracking_preference = tracking_preference;
+exports.user_defaults = user_defaults;

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

@@ -0,0 +1,83 @@
+import { DEFAULT_API_PATHS } from './constants.js';
+import type { Dict, ServerResult } from '../types.js';
+export type ApiPath = keyof typeof DEFAULT_API_PATHS;
+export type RequestHeaders = Record<string, string>;
+export type RequestBody = XMLHttpRequestBodyInit | null;
+/**
+ * How long a request may take before it counts as failed. Without a limit a request the network
+ * never answers keeps its caller waiting for good, and with it the queue it was sending.
+ */
+export declare const REQUEST_TIMEOUT_MS = 30000;
+export declare function makeRequest(url: string, method: string, payload: RequestBody, headers?: RequestHeaders): Promise<string>;
+export declare function getHeaderParams(key: string): string;
+export declare function getParameters(path: ApiPath): string;
+/**
+ * `extra` appends params the path needs per call rather than per state, which console/addlog does
+ * (happenedtime and module change with every line). Values are encoded; the keys are our own.
+ */
+export declare function getUrlWithParams(path: ApiPath, extra?: Dict): string;
+/** Whether this path should go to its debug twin. */
+export declare function usesDebugApi(path: ApiPath): boolean;
+/**
+ * Headers for every call made after device registration.
+ *
+ * apid and mapid are the only two, because they are the only two every url allows: the v2
+ * endpoints declare Access-Control-Allow-Headers as exactly "apid,mapid", and a browser drops
+ * any header outside that list at the preflight. Asking for the debug twin is done with the url
+ * alone, which needs no permission to send.
+ */
+export declare function apiHeaders(): RequestHeaders;
+/**
+ * A rejection that carries the server's own answer, so a caller can tell *why* it failed.
+ * Without this the reason is flattened into a string and a permanent refusal is indistinguishable
+ * from a dropped connection.
+ */
+export interface ServerRejection extends Error {
+    serverResult?: ServerResult;
+}
+/**
+ * Whether a rejection is the server saying "never": the batch is malformed and keeping it would
+ * block every later batch behind it, for good. Anything else — a 5xx, a timeout, no network — is
+ * worth retrying and must not be treated this way.
+ */
+export declare function isPermanentRefusal(err: unknown): boolean;
+/**
+ * Sends one request. Resolves with the parsed response when it reports success; otherwise
+ * rejects with an Error carrying the server's answer. Requests are independent of each other:
+ * nothing orders one behind another.
+ */
+export declare function postToApptics(path: ApiPath, payload: RequestBody, headers: RequestHeaders, label: string, extra?: Dict): Promise<ServerResult>;
+/**
+ * The most a page may have in flight as keepalive bodies at once. Browsers refuse a keepalive
+ * request once the bodies still in flight would pass 64 KiB; this stays under that with room for
+ * the url and headers.
+ */
+export declare const KEEPALIVE_BUDGET: number;
+/**
+ * Sends as the page goes away, where a normal XHR would be cancelled with the document.
+ *
+ * `keepalive` is what lets the request outlive the page. fetch is used rather than sendBeacon
+ * because sendBeacon cannot carry the apid and mapid headers these urls require.
+ *
+ * The request leaves before this returns, so a caller never has to wait on it to send the next
+ * thing. The promise settles when the answer arrives, if the page is still there to see it: a
+ * caller removes what it sent only then. Data whose answer never comes stays stored and goes
+ * again on the next visit as attempt 2, which `attempt` and `firstattempttime` let the server
+ * recognise as a copy rather than store twice.
+ *
+ * A body that would take the page past the keepalive budget is not sent at all: the browser would
+ * refuse it, and it is better kept for the next visit than lost.
+ */
+export declare function postKeepalive(path: ApiPath, payload: RequestBody, headers: RequestHeaders, label: string, extra?: Dict): Promise<ServerResult>;
+/** A labelled rejection for crawlers (the SDK does nothing for them), otherwise null. */
+export declare function rejectIfDisabled(label: string): Promise<never> | null;
+/** A labelled rejection when the browser is offline, otherwise null. */
+export declare function rejectIfOffline(label: string): Promise<never> | null;
+/** Device ids sent alongside every payload. */
+export declare function getMetaObj(): Dict;
+/**
+ * Calls made after registration need apid/mapid. Without them this asks device.ts to
+ * refresh device info (which registers) and returns a labelled rejection; otherwise null. Shared by sender, user
+ * and feedback (P11).
+ */
+export declare function rejectIfNoDeviceIds(label: string): Promise<never> | null;