sn-signals 0.0.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2021
+
+Permission is hereby granted, free
+of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice
+(including the next paragraph) shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/index.js

@@ -0,0 +1,3 @@
+import GlideSignals from './src/signals';
+
+export default GlideSignals;

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "sn-signals",
+  "version": "0.0.11",
+  "private": false,
+  "description": "",
+  "license": "MIT",
+  "author": "hns-signal",
+  "main": "index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "mkdir": "node mkdir.js",
+    "build": "npm run mkdir && npx babel src --out-dir lib",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "devDependencies": {
+    "babel-cli": "6.26.0",
+    "babel-core": "6.26.0",
+    "babel-preset-env": "1.6.1",
+    "babel-plugin-transform-object-rest-spread": "6.26.0"
+  }
+}

package/src/queue.js

@@ -0,0 +1,47 @@
+const API_URL = '/api/now/analytics/events';
+const queueLimit = 100;
+const timeout = 3000;
+
+let eventQueue = [];
+let timer = null;
+
+const postAllEvents = () => {
+	eventQueue.forEach(function(event) {
+		postEvent(event);
+	});
+
+	eventQueue = [];
+	timer = null;
+}
+
+const postEvent = ({ eventAction, eventPriority, eventBody }) => {
+	const xmlhttp = new XMLHttpRequest();
+	const queryParams = `?sysparm_event_action=${eventAction}&sysparm_event_priority=${eventPriority}`;
+
+	xmlhttp.open('POST', API_URL + queryParams);
+	xmlhttp.setRequestHeader('Content-Type', 'application/json');
+
+	if (window.g_ck)
+		xmlhttp.setRequestHeader('X-UserToken', g_ck);
+
+	xmlhttp.send(JSON.stringify(eventBody));
+}
+
+const pushEvent = (event) => {
+	eventQueue.push(event);
+
+	if (eventQueue.length === queueLimit)
+		postAllEvents();
+	else {
+		// timer is already present we just need to add to the queue
+		// until it flushes itself
+		if (timer)
+			return;
+
+		timer = setTimeout(function() {
+			postAllEvents();
+		}, timeout);
+	}
+}
+
+export default pushEvent;

package/src/signals.js

@@ -0,0 +1,58 @@
+import { getUserInfo, fetchUserLocationAsync } from './user';
+import pushEvent from './queue';
+
+/**
+ * Glide Signals to track events and collect user analytics
+ *
+ * #trackEvent(action, priority, eventModel, delayInMs) allows to send a custom event to Glide Signals
+ */
+const GlideSignals = {
+    _location: {},
+    priority: {
+        INFO: 'INFO',
+        WARN: 'WARN',
+        ERROR: 'ERROR',
+    },
+
+    postContextProperty(propertyName, propertyVal) {
+        const xmlhttp = new XMLHttpRequest();
+        const uri = '/api/now/analytics/updateContext';
+
+        const body = {
+            sys_context_property_name: propertyName,
+            sys_context_property_value: propertyVal,
+        };
+        xmlhttp.open('POST', uri);
+        xmlhttp.setRequestHeader('Content-Type', 'application/json');
+
+        if (window.g_ck) xmlhttp.setRequestHeader('X-UserToken', g_ck);
+
+        xmlhttp.send(JSON.stringify(body));
+    },
+
+    trackEvent(eventAction, eventPriority, eventModel) {
+        const user = getUserInfo(this._location);
+        pushEvent({
+            eventAction,
+            eventPriority,
+            eventBody: {
+                ...eventModel,
+                ...user,
+            },
+        });
+    },
+
+    async init() {
+        try {
+            this._location = await fetchUserLocationAsync();
+            if (this._location.hasOwnProperty('latitude')) {
+                this.postContextProperty('latitude', this._location.latitude);
+            }
+            if (this._location.hasOwnProperty('longitude')) {
+                this.postContextProperty('longitude', this._location.longitude);
+            }
+        } catch (e) {}
+    },
+};
+
+export default GlideSignals;

package/src/user.js

@@ -0,0 +1,46 @@
+const ONE_MINUTE = 60000; // milliseconds
+
+const getUserInfo = location => ({
+    userSessionId: getUserSessionId(),
+    userLanguage: getUserLanguage(),
+    browserInfo: getUserBrowserInfo(),
+    latitude: location.hasOwnProperty('latitude') ? location.latitude : null,
+    longitude: location.hasOwnProperty('longitude') ? location.longitude : null,
+});
+
+const getUserSessionId = () => {
+    return window.NOW && window.NOW.session_id ? window.NOW.session_id : '';
+};
+
+const getUserLanguage = () => {
+    if (window.NOW && window.NOW.language && window.NOW.language != '')
+        return window.NOW.language;
+
+    return '';
+};
+
+const getUserBrowserInfo = () => {
+    return window.navigator.userAgent;
+};
+
+async function fetchUserLocationAsync() {
+    return new Promise((resolve, reject) => {
+        const onSuccess = pos => {
+            resolve({
+                latitude: pos.coords.latitude,
+                longitude: pos.coords.longitude,
+            });
+        };
+
+        const onError = () => {
+            reject({ latitude: null, longitude: null });
+        };
+
+        window.navigator.geolocation.getCurrentPosition(onSuccess, onError, {
+            enableHighAccuracy: true,
+            timeout: ONE_MINUTE,
+        });
+    });
+}
+
+export { getUserInfo, fetchUserLocationAsync };