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

package/dist/esm/index.js

@@ -0,0 +1,150 @@
+/*! @zoho_apptics/apptics-js-sdk v2.0.0-beta.1 | (c) Zoho Corporation Private Limited | see LICENSE */
+import { AP_TRACKING_STATUS } from './core/constants.js';
+import { forward, guard } from './core/guard.js';
+import { reset, ready, init } from './lifecycle.js';
+import { enableApiTracking } from './engagement/auto-api.js';
+import { endTrackApiAt, outScreenAt, inScreenAt, startTrackApi, trackEvent } from './engagement/track.js';
+import { DefinedEvents } from './engagement/defined-events.js';
+import { nowMs, getNewUUID } from './core/utils.js';
+import { validateScreenName } from './core/validate.js';
+import { ApiTrackingBuilder, configureApiTracking } from './engagement/api-rules.js';
+import { trackGlobalErrorHandler, trackError } from './errors/track.js';
+import { UserBuilder, getUser, setUser } from './user/index.js';
+import { getTrackingStatus, setTrackingStatus } from './core/consent.js';
+import { flush } from './scheduler.js';
+import { trackHeatmap } from './heatmap/track.js';
+import './heatmap/send.js';
+import { scheduleAutoInit } from './auto-init.js';
+import { disableDebug, enableDebug } from './core/debug.js';
+
+/*
+ * Every public call below is a function of its own, with the parameter names the console shows
+ * on hover, forwarding to its guard()ed implementation (see forward).
+ */
+const initGuarded = guard('Apptics.init', init); // no i18n
+const readyGuarded = guard('Apptics.ready', ready); // no i18n
+const flushGuarded = guard('Apptics.flush', flush); // no i18n
+const resetGuarded = guard('Apptics.reset', reset); // no i18n
+/**
+ * Debug mode, on or off; works before init(), and wins over `debug` in init(). On, engagement,
+ * exception and log go to their `debug/` twins and the answers carry a request id and a link into
+ * the server's own logs. It switches itself off after an hour with nothing tracked, so a forgotten
+ * tab stops tracing on its own.
+ */
+const enableDebugGuarded = guard('Apptics.enableDebug', enableDebug); // no i18n
+const disableDebugGuarded = guard('Apptics.disableDebug', disableDebug); // no i18n
+/** Android's Apptics: starting the SDK, and what applies to all of it. */
+const Apptics = {
+    /** Starts the SDK. The config object is required; the console snippet supplies it via auto-init. */
+    init: function init(config) { return forward(initGuarded, arguments); },
+    /** Resolves true once the SDK is running, false if it can't start. */
+    ready: function ready() { return forward(readyGuarded, arguments); },
+    /** Sends stored engagements, errors and heatmap records now. */
+    flush: function flush() { return forward(flushGuarded, arguments); },
+    /** Clears stored identity, queued data and remote config values, then starts again. */
+    reset: function reset() { return forward(resetGuarded, arguments); },
+    enableDebug: function enableDebug() { return forward(enableDebugGuarded, arguments); },
+    disableDebug: function disableDebug() { return forward(disableDebugGuarded, arguments); },
+};
+/**
+ * Android's AppticsEvents: `addEvent(name, group?, properties?)`, or
+ * `addEvent(AppticsEvent.DefinedEvents.X, properties?)`.
+ */
+const addEventGuarded = guard('AppticsEvent.addEvent', trackEvent); // no i18n
+const AppticsEvent = {
+    /** Apptics' defined events, as Android's DefinedEvents, to log with addEvent. */
+    DefinedEvents: DefinedEvents,
+    addEvent: function addEvent(eventName, groupName, properties) {
+        return forward(addEventGuarded, arguments);
+    },
+};
+const inScreenGuarded = guard('AppticsScreen.inScreen', inScreenAt); // no i18n
+const outScreenGuarded = guard('AppticsScreen.outScreen', outScreenAt); // no i18n
+/** Android's AppticsScreenTracker: inScreen(name) returns the view's id, outScreen(id) ends it. */
+const AppticsScreen = {
+    /**
+     * Records a screen view and returns its id. The view ends at the next screen, when the page is
+     * hidden or its session ends, or when the id is handed to outScreen. '' for an invalid name.
+     */
+    inScreen: function inScreen(screenName, properties) {
+        if (!validateScreenName(screenName)) {
+            // inScreenAt reports it; the caller still needs an answer now
+            inScreenGuarded(screenName, properties, '', nowMs()); // no i18n
+            return ''; // no i18n
+        }
+        // the id and the start now, so both are right even when start-up is still running
+        var id = getNewUUID();
+        inScreenGuarded(screenName, properties, id, nowMs());
+        return id;
+    },
+    /** Ends the screen view inScreen began, before the next screen would. */
+    outScreen: function outScreen(id) {
+        outScreenGuarded(id, nowMs());
+    },
+};
+const endTrackApiGuarded = guard('AppticsApi.endTrackApi', endTrackApiAt); // no i18n
+const startTrackApiGuarded = guard('AppticsApi.startTrackApi', startTrackApi); // no i18n
+const configureGuarded = guard('AppticsApi.configure', configureApiTracking); // no i18n
+const enableApiTrackingGuarded = guard('AppticsApi.enableApiTracking', enableApiTracking); // no i18n
+/** Android's AppticsApiTracker: startTrackApi / endTrackApi, and configure for the rules. */
+const AppticsApi = {
+    /** Begins timing one call: returns the id endTrackApi takes. */
+    startTrackApi: function startTrackApi(url, method) { return forward(startTrackApiGuarded, arguments); },
+    /** Finishes a call startTrackApi began and records it. */
+    endTrackApi: function endTrackApi(id, responseCode, responseMessage) {
+        // the end time now, not when a call made during start-up is replayed
+        endTrackApiGuarded(id, responseCode, responseMessage, nowMs());
+    },
+    /** Builds the rules configure takes: `new AppticsApi.ApiTrackingBuilder()…build()`. */
+    ApiTrackingBuilder: ApiTrackingBuilder,
+    /** The rules API tracking records by, from ApiTrackingBuilder. Works before Apptics.init(). */
+    configure: function configure(config) { return forward(configureGuarded, arguments); },
+    /** Turns automatic API tracking on or off; the `track_api` config flag is the usual way to set it. */
+    enableApiTracking: function enableApiTracking(enabled) { return forward(enableApiTrackingGuarded, arguments); },
+};
+const trackErrorGuarded = guard('AppticsError.trackError', trackError); // no i18n
+const trackGlobalErrorHandlerGuarded = guard('AppticsError.trackGlobalErrorHandler', trackGlobalErrorHandler); // no i18n
+/** Errors: the ones the app caught, and the switch for the uncaught ones tracked on their own. */
+const AppticsError = {
+    /** Reports an error the app caught, or an `error` / `unhandledrejection` event. */
+    trackError: function trackError(error, properties) { return forward(trackErrorGuarded, arguments); },
+    /** Turns the automatic tracking of uncaught errors and unhandled rejections on or off. */
+    trackGlobalErrorHandler: function trackGlobalErrorHandler(enabled) { return forward(trackGlobalErrorHandlerGuarded, arguments); },
+};
+const setUserGuarded = guard('AppticsUser.setUser', setUser); // no i18n
+const getUserGuarded = guard('AppticsUser.getUser', getUser); // no i18n
+/** Android's AppticsUser: the signed-in user, and the builder for their properties. */
+const AppticsUser = {
+    /** Registers the signed-in user; properties may be a plain object or UserBuilder.build(). */
+    setUser: function setUser(userid, groupid, properties) { return forward(setUserGuarded, arguments); },
+    /** The registered user, or {} when there is none. */
+    getUser: function getUser() { return forward(getUserGuarded, arguments); },
+    UserBuilder: UserBuilder,
+};
+const trackHeatmapGuarded = guard('AppticsHeatmap.trackHeatmap', trackHeatmap); // no i18n
+/** Heatmap capture: AppticsHeatmap.trackHeatmap() starts or stops recording clicks and scrolls. */
+const AppticsHeatmap = {
+    trackHeatmap: function trackHeatmap(on) { return forward(trackHeatmapGuarded, arguments); },
+};
+const setTrackingStatusGuarded = guard('AppticsSettings.setTrackingStatus', setTrackingStatus); // no i18n
+const getTrackingStatusGuarded = guard('AppticsSettings.getTrackingStatus', getTrackingStatus); // no i18n
+/** Android's AppticsSettings: what the SDK may track for this visitor. */
+const AppticsSettings = {
+    /** The states setTrackingStatus takes: USAGE_TRACKING_WITH_PII, USAGE_TRACKING_WITHOUT_PII, NO_TRACKING. */
+    AP_TRACKING_STATUS: AP_TRACKING_STATUS,
+    setTrackingStatus: function setTrackingStatus(status) { return forward(setTrackingStatusGuarded, arguments); },
+    getTrackingStatus: function getTrackingStatus() { return forward(getTrackingStatusGuarded, arguments); },
+};
+const apptics = {
+    Apptics,
+    AppticsEvent,
+    AppticsScreen,
+    AppticsApi,
+    AppticsError,
+    AppticsUser,
+    AppticsSettings,
+    AppticsHeatmap,
+};
+scheduleAutoInit(Apptics);
+
+export { Apptics, AppticsApi, AppticsError, AppticsEvent, AppticsHeatmap, AppticsScreen, AppticsSettings, AppticsUser, apptics as default };

package/dist/esm/lifecycle.d.ts

@@ -0,0 +1,21 @@
+import { type ScreenRouteRule } from './core/constants.js';
+import type { AppticsConfig } from './types.js';
+/**
+ * Starts the SDK. The config object is required: pass it directly, or let the console snippet
+ * supply it (auto-init reads window.appticssettings._defaultoptions and calls init with it).
+ * Returns true when the config has base_url, auth_key, app_domain and appversion and start-up has
+ * begun (see ready()), false when it was already running, the config is missing or incomplete, or
+ * there is no browser. Start-up calls app/addversion with those four, which answers with aaid, the
+ * portal and project ids and the rest; then device/add registers the browser, as in 1.x.
+ */
+export declare function init(config: AppticsConfig): boolean;
+/**
+ * screen_routes as init() keeps it: each entry checked, an exact path cleaned up, a regex given as
+ * a string compiled. An entry that cannot be used is left out, and said, rather than matching
+ * something its author did not mean.
+ */
+export declare function screenRouteRules(routes: unknown): ScreenRouteRule[];
+/** Resolves true once start-up has finished, false if init() refused or storage is unusable. */
+export declare function ready(): Promise<boolean>;
+/** Clears stored identity and queues, then starts again from the snippet. */
+export declare function reset(): void;