@aicore/core-analytics-client-lib 1.0.5 → 1.0.6

package/README.md

@@ -20,41 +20,29 @@ events for [Core-Analytics-Server](https://github.com/aicore/Core-Analytics-Serv
 # Usage
 
 ## Load the Library
-Embed the script in your HTML file : 
+Embed the script in your HTML file and replace `your_analytics_account_ID` and `appName`
+in the `initAnalyticsSession` call below: 
 ```html
-<script src="https://unpkg.com/@aicore/core-analytics-client-lib/src/analytics.js"></script>
+<!-- Global window.analytics object - core.ai analytics services -->
+<script async src="https://unpkg.com/@aicore/core-analytics-client-lib/src/analytics.js"
+        onload="analyticsLibLoaded()"></script>
+<script>
+    if(!window.analytics){ window.analytics = {
+        _initData : [], loadStartTime: new Date().getTime(),
+        event: function (){window.analytics._initData.push(arguments);}
+    };}
+    function analyticsLibLoaded() {
+        initAnalyticsSession('your_analytics_account_ID', 'appName');
+        analytics.event("core-analytics", "client-lib", "loadTime", 1, (new Date().getTime())-analytics.loadStartTime);
+    }
+</script>
 ```
 This will create a global `analytics` variable which can be used to access the analytics APIs. 
 
-## Initialize the analytics session.
-Call `analytics.initSession()` after loading the library. It takes the following parameters:
-
-* `accountID`: Your analytics account id as configured in the server or core.ai analytics
-* `appName`: The app name to log the events against. Eg: "phoenixCode"
-* `postIntervalSeconds` (_Optional_): This defines the interval between sending analytics events to the server. Default is 10 minutes
-* `granularitySec` (_Optional_): The smallest time period under which the events can be distinguished. Multiple
-events happening during this time period is aggregated to a count. The default granularity is 3 Seconds, which means
-that any events that happen within 3 seconds cannot be distinguished in ordering.
-* `analyticsURL` (_Optional_): Provide your own analytics server address if you self-hosted the server
-* `debug` (_Optional_):  set to true if you want to see detailed debug logs.
-
-### usageExample
-```javascript
-// Init with default values.
-analytics.initSession("accountID", "appName");
-
-// Example for custom initSession where the analytics aggregated data 
-// is posted to custom server https://localhost:3000 every 600 secs
-// with a granularity(resolution) of 5 seconds.
-analytics.initSession("accountID", "appName", "https://localhost:3000", 600, 5);
-
-// To initSession in debug mode set debug arg in init to true:
-analytics.initSession("accountID", "appName", "https://localhost:3000", 600, 5, true);
-```
 
 ## Raising analytics events
-Once `initSession` is called, we can now start logging analytics events by calling `analytics.event` API.
-The API registers an analytics event. The events will be aggregated and send to the analytics server periodically.
+We can now start logging analytics events by calling `analytics.event` API.
+The events will be aggregated and send to the analytics server periodically.
 
 ```javascript
 // analyticsEvent(eventType, eventCategory, subCategory, eventCount, eventValue);
@@ -79,9 +67,46 @@ analytics.event("platform", "CPU", "coreCountsAndFrequencyMhz", 8, 2300);
 * `eventCategory` - A string, required
 * `subCategory` - A string, required
 * `eventCount` (_Optional_) : A non-negative number indicating the number of times the event (or an event with a
-particular value if a value is specified) happened. defaults to 1.
+  particular value if a value is specified) happened. defaults to 1.
 * `eventValue` (_Optional_) : A number value associated with the event. defaults to 0
 
+
+## Advanced Usages
+ If you want to modify how analytics library collects and sends information, it is recommended to do so
+with analytics server [accountConfig](https://github.com/aicore/Core-Analytics-Server#accountconfig-configuration).
+
+Alternatively for one off development time uses, the behavior of the library can be configured
+during the `initAnalyticsSession` call. `initAnalyticsSession()` takes the following parameters:
+
+* `accountID`: Your analytics account id as configured in the server or core.ai analytics
+* `appName`: The app name to log the events against. Eg: "phoenixCode"
+* `postIntervalSeconds` (_Optional_): This defines the interval between sending analytics events to the server. Default is 10 minutes
+* `granularitySec` (_Optional_): The smallest time period under which the events can be distinguished. Multiple
+events happening during this time period is aggregated to a count. The default granularity is 3 Seconds, which means
+that any events that happen within 3 seconds cannot be distinguished in ordering.
+* `analyticsURL` (_Optional_): Provide your own analytics server address if you self-hosted the server
+* `debug` (_Optional_):  set to true if you want to see detailed debug logs.
+
+### usageExample
+```javascript
+// Init with default values and server controlled config. use the following `analyticsLibLoaded` function
+function analyticsLibLoaded() {
+    initAnalyticsSession('your_analytics_account_ID', 'appName');
+    analytics.event("core-analytics", "client-lib", "loadTime", 1, (new Date().getTime())-analytics.loadStartTime);
+}
+
+//Replace initAnalyticsSession in analyticsLibLoaded function for the below use cases.
+
+// Example for custom initSession where the analytics aggregated data 
+// is posted to custom server https://localhost:3000 every 600 secs
+// with a granularity(resolution) of 5 seconds.
+initAnalyticsSession("accountID", "appName", "https://localhost:3000", 600, 5);
+
+// To initSession in debug mode set debug arg in init to true. In debug mode, details logs
+// about analytics library events will be emitted.
+initAnalyticsSession("accountID", "appName", "https://localhost:3000", 600, 5, true);
+```
+
 # Contribute to core-analytics-client-lib
 
 ## Building

package/dist/analytics.min.js

@@ -1,4 +1,4 @@
-var analytics={};function init(){let r,s,e,t,l,u,c,f,n;const v=3,a=30,y=600,o="aicore.analytics.userID",i=1e4;let d=null;var m="undefined"==typeof window;let g="https://analytics.core.ai",p,h,w=0,C=!1,I=!1;function b(...e){I&&console.log(...e)}if(m)throw new Error("Node environment is not currently supported");function S(){return{schemaVersion:1,accountID:r,appName:s,uuid:e,sessionID:t,unixTimestampUTC:+new Date,numEventsTotal:0,events:{}}}function E(){if(!d)throw new Error("Please call initSession before using any analytics event")}function T(){e=function(){let e=localStorage.getItem(o);return e||(e=crypto.randomUUID(),localStorage.setItem(o,e)),e}(),t=function(){let e=sessionStorage.getItem(o);return e||(e=Math.random().toString(36).substr(2,10),sessionStorage.setItem(o,e)),e}()}function D(e){e.backoffCount=(e.backoffCount||0)+1,b(`Failed to call core analytics server. Will retry in ${a*e.backoffCount}s: `),setTimeout(()=>{N(e)},1e3*a*e.backoffCount)}function N(t){var e;C||(t||(t=d,w=0,$(),d=S()),0!==t.numEventsTotal&&((e=JSON.stringify(t)).length>i&&console.warn(`Analytics event generated is very large at greater than ${e.length}B. This 
-        typically means that you may be sending too many value events? .`),b("Sending Analytics data of length: ",e.length,"B"),window.fetch(f,{method:"POST",headers:{"Content-Type":"application/json"},body:e}).then(e=>{200!==e.status&&(400!==e.status?D(t):console.error("Analytics client: Bad Request, this is most likely a problem with the library, update to latest version."))}).catch(e=>{e=[e],I&&console.error(...e),D(t)})))}function $(e){p&&(clearInterval(p),p=null),e||(p=setInterval(()=>{w+=u},1e3*u))}function k(e){$(e),h&&(clearInterval(h),h=null),e||(h=setInterval(N,1e3*l))}async function A(e,t){(n=await new Promise((n,a)=>{var e=c+(`/getAppConfig?accountID=${r}&appName=`+s);window.fetch(e).then(async e=>{switch(e.status){case 200:var t=await e.json();return void n(t);case 400:a("Bad Request, check library version compatible?",e);break;default:a("analytics client: Could not update from remote config. Continuing with defaults.",e)}}).catch(e=>{a("analytics client: Could not update from remote config. Continuing with defaults.",e)})}))!=={}&&(l=e||n.postIntervalSecondsInit||y,u=t||n.granularitySecInit||v,c=n.analyticsURLInit||c||g,k(C=!0===n.disabled),b(`Init analytics Config from remote. disabled: ${C}
-        postIntervalSeconds:${l}, granularitySec: ${u} ,URL: `+c),C&&console.warn(`Core Analytics is disabled from the server for app: ${r}:`+s))}analytics.initSession=function(e,t,n,a,o,i){if(!e||!t)throw new Error("accountID and appName must exist for init");c=n?n.replace(/\/$/,""):g,r=e,s=t,I=i||!1,l=a||y,u=o||v,f=c+"/ingest",T(),d=S(),k(),A(a,o)},analytics.getCurrentAnalyticsEvent=function(){return E(),JSON.parse(JSON.stringify(d))},analytics.event=function(n,a,o,i=1,r=0){if(!C){var s=n,l=a,u=o,c=i,f=r;if(E(),!s||!l||!u)throw new Error("missing eventType or category or subCategory");if("number"!=typeof c||c<0)throw new Error("invalid count");if("number"!=typeof f)throw new Error("invalid value");{s=n;l=a;u=o;let e=d.events;e[s]=e[s]||{},e[s][l]=e[s][l]||{},e[s][l][u]=e[s][l][u]||{time:[],valueCount:[]}}let t=d.events;c=t[n][a][o].time;if((0<c.length?c[c.length-1]:null)===w){f=t[n][a][o].valueCount.length-1;{var s=f,l=n,u=a,c=o,f=i,v=r;let t=d.events;var e="number"==typeof t[l][u][c].valueCount[s];if(e&&0===v)t[l][u][c].valueCount[s]+=f;else if(e&&0!==v){let e={};e[v]=f,e[0]=t[l][u][c].valueCount[s],t[l][u][c].valueCount[s]=e}else if(!e){let e=t[l][u][c].valueCount[s];e[v]=(e[v]||0)+f}d.numEventsTotal+=1}}else{if(t[n][a][o].time.push(w),0===r)t[n][a][o].valueCount.push(i);else{let e={};e[r]=i,t[n][a][o].valueCount.push(e)}d.numEventsTotal+=1}}},analytics.getAppConfig=function(){return{accountID:r,appName:s,disabled:C,uuid:e,sessionID:t,postIntervalSeconds:l,granularitySec:u,analyticsURL:c,serverConfig:n}}}init();
+function initAnalyticsSession(e,t,n,a,o,i){let r,s,l,u,c,f,v,y,d={};const m=30,p="aicore.analytics.userID",g=1e4;let h=null;var w,C="undefined"==typeof window;let b="https://analytics.core.ai",I,S,D=0,E=!1,T=!1;function A(...e){T&&console.log(...e)}if(C)throw new Error("Node environment is not currently supported");function N(){return{schemaVersion:1,accountID:r,appName:s,uuid:l,sessionID:u,unixTimestampUTC:+new Date,numEventsTotal:0,events:{}}}function $(){if(!h)throw new Error("Please call initSession before using any analytics event")}function k(e){e.backoffCount=(e.backoffCount||0)+1,A(`Failed to call core analytics server. Will retry in ${m*e.backoffCount}s: `),setTimeout(()=>{U(e)},1e3*m*e.backoffCount)}function U(t){var e;E||(t||(t=h,D=0,R(),h=N()),0!==t.numEventsTotal&&((e=JSON.stringify(t)).length>g&&console.warn(`Analytics event generated is very large at greater than ${e.length}B. This 
+        typically means that you may be sending too many value events? .`),A("Sending Analytics data of length: ",e.length,"B"),window.fetch(y,{method:"POST",headers:{"Content-Type":"application/json"},body:e}).then(e=>{200!==e.status&&(400!==e.status?k(t):console.error("Analytics client: Bad Request, this is most likely a problem with the library, update to latest version."))}).catch(e=>{e=[e],T&&console.error(...e),k(t)})))}function R(e){I&&(clearInterval(I),I=null),e||(I=setInterval(()=>{D+=f},1e3*f))}function _(e){R(e),S&&(clearInterval(S),S=null),e||(S=setInterval(U,1e3*c))}function B(n,a,o,i=1,r=0){if(!E){var s=n,l=a,u=o,c=i,f=r;if($(),!s||!l||!u)throw new Error("missing eventType or category or subCategory");if("number"!=typeof c||c<0)throw new Error("invalid count, count should be a positive number");if("number"!=typeof f)throw new Error("invalid value, value should be a number");{s=n;l=a;u=o;let e=h.events;e[s]=e[s]||{},e[s][l]=e[s][l]||{},e[s][l][u]=e[s][l][u]||{time:[],valueCount:[]}}let t=h.events;c=t[n][a][o].time;if((0<c.length?c[c.length-1]:null)===D){f=t[n][a][o].valueCount.length-1;{var s=f,l=n,u=a,c=o,f=i,v=r;let t=h.events;var e="number"==typeof t[l][u][c].valueCount[s];if(e&&0===v)t[l][u][c].valueCount[s]+=f;else if(e&&0!==v){let e={};e[v]=f,e[0]=t[l][u][c].valueCount[s],t[l][u][c].valueCount[s]=e}else if(!e){let e=t[l][u][c].valueCount[s];e[v]=(e[v]||0)+f}h.numEventsTotal+=1}}else{if(t[n][a][o].time.push(D),0===r)t[n][a][o].valueCount.push(i);else{let e={};e[r]=i,t[n][a][o].valueCount.push(e)}h.numEventsTotal+=1}}}if(!e||!t)throw new Error("accountID and appName must exist for init");v=n?n.replace(/\/$/,""):b,r=e,s=t,T=i||!1,c=a||600,f=o||3,y=v+"/ingest",l=function(){let e=localStorage.getItem(p);return e||(e=crypto.randomUUID(),localStorage.setItem(p,e)),e}(),u=function(){let e=sessionStorage.getItem(p);return e||(e=Math.random().toString(36).substr(2,10),sessionStorage.setItem(p,e)),e}(),h=N(),_(),async function(e,t){(d=await new Promise((n,a)=>{var e=v+(`/getAppConfig?accountID=${r}&appName=`+s);window.fetch(e).then(async e=>{switch(e.status){case 200:var t=await e.json();return void n(t);case 400:a("Bad Request, check library version compatible?",e);break;default:a("analytics client: Could not update from remote config. Continuing with defaults.",e)}}).catch(e=>{a("analytics client: Could not update from remote config. Continuing with defaults.",e)})}))!=={}&&(c=e||d.postIntervalSecondsInit||600,f=t||d.granularitySecInit||3,v=d.analyticsURLInit||v||b,_(E=!0===d.disabled),A(`Init analytics Config from remote. disabled: ${E}
+        postIntervalSeconds:${c}, granularitySec: ${f} ,URL: `+v),E&&console.warn(`Core Analytics is disabled from the server for app: ${r}:`+s))}(a,o);for(w of analytics._initData)B(...w);analytics._initData=[],analytics._getCurrentAnalyticsEvent=function(){return $(),JSON.parse(JSON.stringify(h))},analytics._getAppConfig=function(){return{accountID:r,appName:s,disabled:E,uuid:l,sessionID:u,postIntervalSeconds:c,granularitySec:f,analyticsURL:v,serverConfig:d}},analytics.event=B}window.analytics||(window.analytics={_initData:[]});
 //# sourceMappingURL=analytics.min.js.map

package/dist/analytics.min.js.map

@@ -1 +1 @@
-{"version":3,"sourceRoot":"src/analytics.js","sources":["src/analytics.js"],"names":["analytics","init","let","accountID","appName","userID","sessionID","postIntervalSeconds","granularitySec","analyticsURL","postURL","serverConfig","DEFAULT_GRANULARITY_IN_SECONDS","DEFAULT_RETRY_TIME_IN_SECONDS","DEFAULT_POST_INTERVAL_SECONDS","USERID_LOCAL_STORAGE_KEY","POST_LARGE_DATA_THRESHOLD_BYTES","currentAnalyticsEvent","IS_NODE_ENV","window","DEFAULT_BASE_URL","granularityTimer","postTimer","currentQuantisedTime","disabled","debugMode","debugLog","args","console","log","Error","_createAnalyticsEvent","schemaVersion","uuid","unixTimestampUTC","Date","numEventsTotal","events","_validateCurrentState","_setupIDs","localUserID","localStorage","getItem","crypto","randomUUID","setItem","_getOrCreateUserID","localSessionID","sessionStorage","Math","random","toString","substr","_getOrCreateSessionID","_retryPost","eventToSend","backoffCount","setTimeout","_postCurrentAnalyticsEvent","textToSend","_resetGranularityTimer","JSON","stringify","length","warn","fetch","method","headers","Content-Type","body","then","res","status","error","catch","debugError","disable","clearInterval","setInterval","_setupTimers","async","_initFromRemoteConfig","postIntervalSecondsInit","granularitySecInit","Promise","resolve","reject","configURL","serverResponse","json","err","initSession","accountIDInit","appNameInit","analyticsURLInit","debug","replace","getCurrentAnalyticsEvent","parse","event","eventType","eventCategory","subCategory","eventCount","eventValue","_validateEvent","category","count","value","_ensureAnalyticsEventExists","time","valueCount","timeArray","modificationIndex","_updateExistingAnalyticsEvent","index","newValue","storedValueIsCount","newValueCount","storedValueObject","push","getAppConfig"],"mappings":"AAKA,IAAIA,UAAY,GAEhB,SAASC,OACLC,IAAIC,EAAWC,EAASC,EAAQC,EAAWC,EAAqBC,EAAgBC,EAAcC,EAASC,EACvG,MAAMC,EAAiC,EACjCC,EAAgC,GAChCC,EAAgC,IAChCC,EAA2B,0BAC3BC,EAAkC,IACxCd,IAAIe,EAAwB,KAC5B,IAAMC,EAAiC,oBAAXC,OAC5BjB,IAAIkB,EAAmB,4BAEnBC,EACAC,EACAC,EAAuB,EACvBC,GAAW,EACXC,GAAY,EAEhB,SAASC,KAAYC,GACbF,GAGJG,QAAQC,OAAOF,GAWnB,GAAGT,EACC,MAAM,IAAIY,MAAM,+CAGpB,SAASC,IACL,MAAO,CACHC,cAAe,EACf7B,UAAWA,EACXC,QAASA,EACT6B,KAAM5B,EACNC,UAAWA,EACX4B,kBAAmB,IAAIC,KACvBC,eAAgB,EAChBC,OAAQ,IAIhB,SAASC,IACL,IAAIrB,EACA,MAAM,IAAIa,MAAM,4DA4BxB,SAASS,IACLlC,EAnBJ,WACIH,IAAIsC,EAAcC,aAAaC,QAAQ3B,GAKvC,OAJIyB,IACAA,EAAcG,OAAOC,aACrBH,aAAaI,QAAQ9B,EAA0ByB,IAE5CA,EAaEM,GACTxC,EAXJ,WACIJ,IAAI6C,EAAiBC,eAAeN,QAAQ3B,GAK5C,OAJIgC,IACAA,EAAiBE,KAAKC,SAASC,SAAS,IAAIC,OAAO,EAAG,IACtDJ,eAAeH,QAAQ9B,EAA0BgC,IAE9CA,EAKKM,GAGhB,SAASC,EAAWC,GAChBA,EAAYC,cAAgBD,EAAYC,cAAgB,GAAK,EAC7D9B,yDACIb,EAAgC0C,EAAYC,mBAChDC,WAAW,KACPC,EAA2BH,IACI,IAAhC1C,EAAuC0C,EAAYC,cAG1D,SAASE,EAA2BH,GAChC,IAYII,EAZDnC,IAGC+B,IACAA,EAActC,EACdM,EAAuB,EACvBqC,IACA3C,EAAwBc,KAEM,IAA/BwB,EAAYnB,kBAGXuB,EAAaE,KAAKC,UAAUP,IAClBQ,OAAS/C,GACnBY,QAAQoC,gEAAgEL,EAAWI;2EAGvFrC,EAAS,qCAAsCiC,EAAWI,OAAQ,KAClE5C,OAAO8C,MAAMvD,EAAS,CAClBwD,OAAQ,OACRC,QAAS,CAACC,eAAgB,oBAC1BC,KAAMV,IACPW,KAAKC,IACc,MAAfA,EAAIC,SAGW,MAAfD,EAAIC,OACHlB,EAAWC,GAEX3B,QAAQ6C,MAAM,+GAGnBC,MAAMH,IAtGU5C,EAuGfgD,CAAWJ,GAtGX9C,GAGJG,QAAQ6C,SAAS9C,GAoGb2B,EAAWC,OAInB,SAASK,EAAuBgB,GACzBvD,IACCwD,cAAcxD,GACdA,EAAmB,MAEpBuD,IAGHvD,EAAmByD,YAAY,KAC3BvD,GAA8Cf,GAChC,IAAfA,IAGP,SAASuE,EAAaH,GAClBhB,EAAuBgB,GACpBtD,IACCuD,cAAcvD,GACdA,EAAY,MAEbsD,IAGHtD,EAAYwD,YAAYpB,EAAgD,IAApBnD,IAoCxDyE,eAAeC,EAAsBC,EAAyBC,IAC1DxE,QAjCO,IAAIyE,QAAQ,CAACC,EAASC,KACzBpF,IAAIqF,EAAY9E,8BAA0CN,aAAqBC,GAC/Ee,OAAO8C,MAAMsB,GAAWjB,KAAWC,MAAAA,IAC/B,OAAQA,EAAIC,QACZ,KAAK,IACDtE,IAAIsF,QAAuBjB,EAAIkB,OAE/B,YADAJ,EAAQG,GAEZ,KAAK,IACDF,EAAO,iDAAkDf,GACzD,MACJ,QACIe,EAAO,mFAAoFf,MAEhGG,MAAMgB,IACLJ,EAAO,mFAAoFI,UAmB/E,KAEhBnF,EAAsB2E,GAClBvE,EAAsC,yBAAKG,EAC/CN,EAAiB2E,GAAsBxE,EAAiC,oBAAKC,EAE7EH,EAAeE,EAA+B,kBAAKF,GAAgBW,EAEnE2D,EADAvD,GAAwC,IAA7Bb,EAAuB,UAElCe,kDAAyDF;8BACvCjB,sBAAwCC,WAAwBC,GAC/Ee,GACCI,QAAQoC,4DAA4D7D,KAAaC,IAgH7FJ,UAAU2F,YA3FV,SAAqBC,EAAeC,EAAaC,EAAkBZ,EAAyBC,EAAoBY,GAC5G,IAAIH,IAAkBC,EAClB,MAAM,IAAI/D,MAAM,6CAEpBrB,EAAeqF,EAAsCA,EAnB1CE,QAAQ,MAAO,IAmB+C5E,EACzEjB,EAAYyF,EACZxF,EAAUyF,EACVpE,EAAYsE,IAAS,EACrBxF,EAAsB2E,GAA2BpE,EACjDN,EAAiB2E,GAAsBvE,EACvCF,EAAUD,EAAe,UACzB8B,IACAtB,EAAwBc,IACxBgD,IACAE,EAAsBC,EAAyBC,IA8EnDnF,UAAUiG,yBAtQV,WAGI,OAFA3D,IAEOuB,KAAKqC,MAAMrC,KAAKC,UAAU7C,KAoQrCjB,UAAUmG,MA3BV,SAAeC,EAAWC,EAAeC,EAAaC,EAAW,EAAGC,EAAW,GAC3E,IAAGhF,EAAH,CAGAiF,IA3CoBL,EA2CLA,EA3CgBM,EA2CLL,EA3CeC,EA2CAA,EA3CaK,EA2CAJ,EA3COK,EA2CKJ,EAzClE,GADAlE,KACI8D,IAAcM,IAAaJ,EAC3B,MAAM,IAAIxE,MAAM,gDAEpB,GAAoB,iBAAX,GAAuB6E,EAAO,EACnC,MAAM,IAAI7E,MAAM,iBAEpB,GAAoB,iBAAX,EACL,MAAM,IAAIA,MAAM,iBAmCpB+E,CAtDiCT,EAsDLA,EAtDgBM,EAsDLL,EAtDeC,EAsDAA,EArDtDpG,IAAImC,EAASpB,EAAsBoB,OACnCA,EAAO+D,GAAa/D,EAAO+D,IAAc,GACzC/D,EAAO+D,GAAWM,GAAYrE,EAAO+D,GAAWM,IAAa,GAC7DrE,EAAO+D,GAAWM,GAAUJ,GAAejE,EAAO+D,GAAWM,GAAUJ,IAAgB,CACnFQ,KAAM,GACNC,WAAY,IAiDhB7G,IAAImC,EAASpB,EAAsBoB,OAC/B2E,EAAY3E,EAAO+D,GAAWC,GAAeC,GAAmB,KAEpE,IADgC,EAAjBU,EAAUjD,OAAUiD,EAAUA,EAAUjD,OAAO,GAAK,QACnDxC,EAAhB,CAYI0F,EAAoB5E,EAAO+D,GAAWC,GAAeC,GAAyB,WAAEvC,OAAQ,EAC5FmD,CAAAA,IAhDmCC,EAgDLF,EAhDYb,EAgDOA,EAhDIM,EAgDOL,EAhDGC,EAgDYA,EAhDCK,EAgDYJ,EAhDLa,EAgDiBZ,EA/CpGtG,IAAImC,EAASpB,EAAsBoB,OACnC,IAAMgF,EAA+F,iBAAnEhF,EAAO+D,GAAWM,GAAUJ,GAAyB,WAAEa,GACzF,GAAGE,GAAmC,IAAbD,EACrB/E,EAAO+D,GAAWM,GAAUJ,GAAyB,WAAEa,IAAUR,OAC9D,GAAGU,GAAmC,IAAbD,EAAe,CAC3ClH,IAAIoH,EAAgB,GACpBA,EAAcF,GAAYT,EAC1BW,EAAc,GAAKjF,EAAO+D,GAAWM,GAAUJ,GAAyB,WAAEa,GAC1E9E,EAAO+D,GAAWM,GAAUJ,GAAyB,WAAEa,GAASG,OAC7D,IAAID,EAAmB,CAC1BnH,IAAIqH,EAAoBlF,EAAO+D,GAAWM,GAAUJ,GAAyB,WAAEa,GAC/EI,EAAkBH,IAAaG,EAAkBH,IAAa,GAAKT,EAEvE1F,EAAsBmB,gBAAkB,OAqBxC,CAEI,GADAC,EAAO+D,GAAWC,GAAeC,GAAmB,KAAEkB,KAAKjG,GAC3C,IAAbiF,EACCnE,EAAO+D,GAAWC,GAAeC,GAAyB,WAAEkB,KAAKjB,OAC9D,CACHrG,IAAI6G,EAAa,GACjBA,EAAWP,GAAcD,EACzBlE,EAAO+D,GAAWC,GAAeC,GAAyB,WAAEkB,KAAKT,GAErE9F,EAAsBmB,gBAAkB,KAUhDpC,UAAUyH,aAzIV,WACI,MAAO,CACHtH,UAAAA,EAAWC,QAAAA,EAASoB,SAAAA,EACpBS,KAAM5B,EAAQC,UAAAA,EACdC,oBAAAA,EAAqBC,eAAAA,EAAgBC,aAAAA,EAAcE,aAAAA,IAwI/DV"}
+{"version":3,"sourceRoot":"src/analytics.js","sources":["src/analytics.js"],"names":["initAnalyticsSession","accountIDInit","appNameInit","analyticsURLInit","postIntervalSecondsInit","granularitySecInit","debug","let","accountID","appName","userID","sessionID","postIntervalSeconds","granularitySec","analyticsURL","postURL","serverConfig","DEFAULT_RETRY_TIME_IN_SECONDS","USERID_LOCAL_STORAGE_KEY","POST_LARGE_DATA_THRESHOLD_BYTES","currentAnalyticsEvent","eventData","IS_NODE_ENV","window","DEFAULT_BASE_URL","granularityTimer","postTimer","currentQuantisedTime","disabled","debugMode","debugLog","args","console","log","Error","_createAnalyticsEvent","schemaVersion","uuid","unixTimestampUTC","Date","numEventsTotal","events","_validateCurrentState","_retryPost","eventToSend","backoffCount","setTimeout","_postCurrentAnalyticsEvent","textToSend","_resetGranularityTimer","JSON","stringify","length","warn","fetch","method","headers","Content-Type","body","then","res","status","error","catch","debugError","disable","clearInterval","setInterval","_setupTimers","event","eventType","eventCategory","subCategory","eventCount","eventValue","_validateEvent","category","count","value","_ensureAnalyticsEventExists","time","valueCount","timeArray","modificationIndex","_updateExistingAnalyticsEvent","index","newValue","storedValueIsCount","newValueCount","storedValueObject","push","replace","localUserID","localStorage","getItem","crypto","randomUUID","setItem","_getOrCreateUserID","localSessionID","sessionStorage","Math","random","toString","substr","_getOrCreateSessionID","async","postIntervalSecondsInitial","granularitySecInitial","Promise","resolve","reject","configURL","serverResponse","json","err","_initFromRemoteConfig","analytics","_initData","_getCurrentAnalyticsEvent","parse","_getAppConfig"],"mappings":"AAwBA,SAASA,qBAAqBC,EAAeC,EAAaC,EACtDC,EAAyBC,EAAoBC,GAC7CC,IAAIC,EAAWC,EAASC,EAAQC,EAAWC,EACvCC,EAAgBC,EAAcC,EAASC,EAAa,GACxD,MACMC,EAAgC,GAEhCC,EAA2B,0BAC3BC,EAAkC,IACxCZ,IAAIa,EAAwB,KAC5B,IA2SQC,EA3SFC,EAAiC,oBAAXC,OAC5BhB,IAAIiB,EAAmB,4BAEnBC,EACAC,EACAC,EAAuB,EACvBC,GAAW,EACXC,GAAY,EAEhB,SAASC,KAAYC,GACbF,GAGJG,QAAQC,OAAOF,GAWnB,GAAGT,EACC,MAAM,IAAIY,MAAM,+CAGpB,SAASC,IACL,MAAO,CACHC,cAAe,EACf5B,UAAWA,EACXC,QAASA,EACT4B,KAAM3B,EACNC,UAAWA,EACX2B,kBAAmB,IAAIC,KACvBC,eAAgB,EAChBC,OAAQ,IAIhB,SAASC,IACL,IAAItB,EACA,MAAM,IAAIc,MAAM,4DAiCxB,SAASS,EAAWC,GAChBA,EAAYC,cAAgBD,EAAYC,cAAgB,GAAK,EAC7Df,yDACIb,EAAgC2B,EAAYC,mBAChDC,WAAW,KACPC,EAA2BH,IACI,IAAhC3B,EAAuC2B,EAAYC,cAG1D,SAASE,EAA2BH,GAChC,IAYII,EAZDpB,IAGCgB,IACAA,EAAcxB,EACdO,EAAuB,EACvBsB,IACA7B,EAAwBe,KAEM,IAA/BS,EAAYJ,kBAGXQ,EAAaE,KAAKC,UAAUP,IAClBQ,OAASjC,GACnBa,QAAQqB,gEAAgEL,EAAWI;2EAGvFtB,EAAS,qCAAsCkB,EAAWI,OAAQ,KAClE7B,OAAO+B,MAAMvC,EAAS,CAClBwC,OAAQ,OACRC,QAAS,CAACC,eAAgB,oBAC1BC,KAAMV,IACPW,KAAKC,IACc,MAAfA,EAAIC,SAGW,MAAfD,EAAIC,OACHlB,EAAWC,GAEXZ,QAAQ8B,MAAM,+GAGnBC,MAAMH,IAtGU7B,EAuGfiC,CAAWJ,GAtGX/B,GAGJG,QAAQ8B,SAAS/B,GAoGbY,EAAWC,OAInB,SAASK,EAAuBgB,GACzBxC,IACCyC,cAAczC,GACdA,EAAmB,MAEpBwC,IAGHxC,EAAmB0C,YAAY,KAC3BxC,GAA8Cd,GAChC,IAAfA,IAGP,SAASuD,EAAaH,GAClBhB,EAAuBgB,GACpBvC,IACCwC,cAAcxC,GACdA,EAAY,MAEbuC,IAGHvC,EAAYyC,YAAYpB,EAAgD,IAApBnC,IA4GxD,SAASyD,EAAMC,EAAWC,EAAeC,EAAaC,EAAW,EAAGC,EAAW,GAC3E,IAAG9C,EAAH,CAGA+C,IA3CoBL,EA2CLA,EA3CgBM,EA2CLL,EA3CeC,EA2CAA,EA3CaK,EA2CAJ,EA3COK,EA2CKJ,EAzClE,GADAhC,KACI4B,IAAcM,IAAaJ,EAC3B,MAAM,IAAItC,MAAM,gDAEpB,GAAoB,iBAAX,GAAuB2C,EAAO,EACnC,MAAM,IAAI3C,MAAM,oDAEpB,GAAoB,iBAAX,EACL,MAAM,IAAIA,MAAM,2CAmCpB6C,CAtDiCT,EAsDLA,EAtDgBM,EAsDLL,EAtDeC,EAsDAA,EArDtDjE,IAAIkC,EAASrB,EAAsBqB,OACnCA,EAAO6B,GAAa7B,EAAO6B,IAAc,GACzC7B,EAAO6B,GAAWM,GAAYnC,EAAO6B,GAAWM,IAAa,GAC7DnC,EAAO6B,GAAWM,GAAUJ,GAAe/B,EAAO6B,GAAWM,GAAUJ,IAAgB,CACnFQ,KAAM,GACNC,WAAY,IAiDhB1E,IAAIkC,EAASrB,EAAsBqB,OAC/ByC,EAAYzC,EAAO6B,GAAWC,GAAeC,GAAmB,KAEpE,IADgC,EAAjBU,EAAU9B,OAAU8B,EAAUA,EAAU9B,OAAO,GAAK,QACnDzB,EAAhB,CAYIwD,EAAoB1C,EAAO6B,GAAWC,GAAeC,GAAyB,WAAEpB,OAAQ,EAC5FgC,CAAAA,IAhDmCC,EAgDLF,EAhDYb,EAgDOA,EAhDIM,EAgDOL,EAhDGC,EAgDYA,EAhDCK,EAgDYJ,EAhDLa,EAgDiBZ,EA/CpGnE,IAAIkC,EAASrB,EAAsBqB,OACnC,IAAM8C,EAA+F,iBAAnE9C,EAAO6B,GAAWM,GAAUJ,GAAyB,WAAEa,GACzF,GAAGE,GAAmC,IAAbD,EACrB7C,EAAO6B,GAAWM,GAAUJ,GAAyB,WAAEa,IAAUR,OAC9D,GAAGU,GAAmC,IAAbD,EAAe,CAC3C/E,IAAIiF,EAAgB,GACpBA,EAAcF,GAAYT,EAC1BW,EAAc,GAAK/C,EAAO6B,GAAWM,GAAUJ,GAAyB,WAAEa,GAC1E5C,EAAO6B,GAAWM,GAAUJ,GAAyB,WAAEa,GAASG,OAC7D,IAAID,EAAmB,CAC1BhF,IAAIkF,EAAoBhD,EAAO6B,GAAWM,GAAUJ,GAAyB,WAAEa,GAC/EI,EAAkBH,IAAaG,EAAkBH,IAAa,GAAKT,EAEvEzD,EAAsBoB,gBAAkB,OAqBxC,CAEI,GADAC,EAAO6B,GAAWC,GAAeC,GAAmB,KAAEkB,KAAK/D,GAC3C,IAAb+C,EACCjC,EAAO6B,GAAWC,GAAeC,GAAyB,WAAEkB,KAAKjB,OAC9D,CACHlE,IAAI0E,EAAa,GACjBA,EAAWP,GAAcD,EACzBhC,EAAO6B,GAAWC,GAAeC,GAAyB,WAAEkB,KAAKT,GAErE7D,EAAsBoB,gBAAkB,IAQhD,IAAIvC,IAAkBC,EAClB,MAAM,IAAIgC,MAAM,6CAEpBpB,EAAeX,EAAsCA,EAjFtCwF,QAAQ,MAAO,IAiF2CnE,EACzEhB,EAAYP,EACZQ,EAAUP,EACV2B,EAAYvB,IAAS,EACrBM,EAAsBR,GAnSgB,IAoStCS,EAAiBR,GAtSsB,EAuSvCU,EAAUD,EAAe,UAzNrBJ,EAnBJ,WACIH,IAAIqF,EAAcC,aAAaC,QAAQ5E,GAKvC,OAJI0E,IACAA,EAAcG,OAAOC,aACrBH,aAAaI,QAAQ/E,EAA0B0E,IAE5CA,EAaEM,GACTvF,EAXJ,WACIJ,IAAI4F,EAAiBC,eAAeN,QAAQ5E,GAK5C,OAJIiF,IACAA,EAAiBE,KAAKC,SAASC,SAAS,IAAIC,OAAO,EAAG,IACtDJ,eAAeH,QAAQ/E,EAA0BiF,IAE9CA,EAKKM,GA0NhBrF,EAAwBe,IACxBiC,IA9GAsC,eAAqCC,EAA4BC,IAC7D5F,QAjCO,IAAI6F,QAAQ,CAACC,EAASC,KACzBxG,IAAIyG,EAAYlG,8BAA0CN,aAAqBC,GAC/Ec,OAAO+B,MAAM0D,GAAWrD,KAAWC,MAAAA,IAC/B,OAAQA,EAAIC,QACZ,KAAK,IACDtD,IAAI0G,QAAuBrD,EAAIsD,OAE/B,YADAJ,EAAQG,GAEZ,KAAK,IACDF,EAAO,iDAAkDnD,GACzD,MACJ,QACImD,EAAO,mFAAoFnD,MAEhGG,MAAMoD,IACLJ,EAAO,mFAAoFI,UAmB/E,KAEhBvG,EAAsB+F,GAClB3F,EAAsC,yBA/LZ,IAgM9BH,EAAiB+F,GAAyB5F,EAAiC,oBAlM5C,EAoM/BF,EAAeE,EAA+B,kBAAKF,GAAgBU,EAEnE4C,EADAxC,GAAwC,IAA7BZ,EAAuB,UAElCc,kDAAyDF;8BACvChB,sBAAwCC,WAAwBC,GAC/Ec,GACCI,QAAQqB,4DAA4D7C,KAAaC,IAiG7F2G,CAAsBhH,EAAyBC,GAM/C,IAAQgB,KAAagG,UAAUC,UAC3BjD,KAAShD,GAEbgG,UAAUC,UAAY,GAGtBD,UAAUE,0BAlQV,WAGI,OAFA7E,IAEOQ,KAAKsE,MAAMtE,KAAKC,UAAU/B,KAgQrCiG,UAAUI,cApIV,WACI,MAAO,CACHjH,UAAAA,EAAWC,QAAAA,EAASmB,SAAAA,EACpBS,KAAM3B,EAAQC,UAAAA,EACdC,oBAAAA,EAAqBC,eAAAA,EAAgBC,aAAAA,EAAcE,aAAAA,IAmI3DqG,UAAUhD,MAAQA,EAjVlB9C,OAAO8F,YACP9F,OAAO8F,UAAY,CACfC,UAAW"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicore/core-analytics-client-lib",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Analytics client library for https://github.com/aicore/Core-Analytics-Server",
   "main": "dist/analytics.min.js",
   "type": "module",

package/src/analytics.js

@@ -1,12 +1,31 @@
 // GNU AGPL-3.0 License Copyright (c) 2021 - present core.ai . All rights reserved.
 
 // jshint ignore: start
-/*global localStorage, sessionStorage, crypto*/
+/*global localStorage, sessionStorage, crypto, analytics*/
 
-var analytics = {};
 
-function init() {
-    let accountID, appName, userID, sessionID, postIntervalSeconds, granularitySec, analyticsURL, postURL, serverConfig;
+if(!window.analytics){
+    window.analytics = {
+        _initData: []
+    };
+}
+
+/**
+ * Initialize the analytics session
+ * @param accountIDInit Your analytics account id as configured in the server or core.ai analytics
+ * @param appNameInit The app name to log the events against.
+ * @param analyticsURLInit Optional: Provide your own analytics server address if you self-hosted the server
+ * @param postIntervalSecondsInit Optional: This defines the interval between sending analytics events to the server.
+ * Default is 10 minutes
+ * @param granularitySecInit Optional: The smallest time period under which the events can be distinguished. Multiple
+ * events happening during this time period is aggregated to a count. The default granularity is 3 Seconds, which means
+ * that any events that happen within 3 seconds cannot be distinguished in ordering.
+ * @param debug set to true if you want to see detailed debug logs.
+ */
+function initAnalyticsSession(accountIDInit, appNameInit, analyticsURLInit,
+    postIntervalSecondsInit, granularitySecInit, debug) {
+    let accountID, appName, userID, sessionID, postIntervalSeconds,
+        granularitySec, analyticsURL, postURL, serverConfig={};
     const DEFAULT_GRANULARITY_IN_SECONDS = 3;
     const DEFAULT_RETRY_TIME_IN_SECONDS = 30;
     const DEFAULT_POST_INTERVAL_SECONDS = 600; // 10 minutes
@@ -60,7 +79,7 @@ function init() {
         }
     }
 
-    function getCurrentAnalyticsEvent() {
+    function _getCurrentAnalyticsEvent() {
         _validateCurrentState();
         // return a clone
         return JSON.parse(JSON.stringify(currentAnalyticsEvent));
@@ -187,7 +206,7 @@ function init() {
      * Returns the analytics config for the app
      * @returns {Object}
      */
-    function getAppConfig() {
+    function _getAppConfig() {
         return {
             accountID, appName, disabled,
             uuid: userID, sessionID,
@@ -195,13 +214,13 @@ function init() {
         };
     }
 
-    async function _initFromRemoteConfig(postIntervalSecondsInit, granularitySecInit) {
+    async function _initFromRemoteConfig(postIntervalSecondsInitial, granularitySecInitial) {
         serverConfig = await _getServerConfig();
         if(serverConfig !== {}){
             // User init overrides takes precedence over server overrides
-            postIntervalSeconds = postIntervalSecondsInit ||
+            postIntervalSeconds = postIntervalSecondsInitial ||
                 serverConfig["postIntervalSecondsInit"] || DEFAULT_POST_INTERVAL_SECONDS;
-            granularitySec = granularitySecInit || serverConfig["granularitySecInit"] || DEFAULT_GRANULARITY_IN_SECONDS;
+            granularitySec = granularitySecInitial || serverConfig["granularitySecInit"] || DEFAULT_GRANULARITY_IN_SECONDS;
             // For URLs, the server suggested URL takes precedence over user init values
             analyticsURL = serverConfig["analyticsURLInit"] || analyticsURL || DEFAULT_BASE_URL;
             disabled = serverConfig["disabled"] === true;
@@ -218,35 +237,6 @@ function init() {
         return url.replace(/\/$/, "");
     }
 
-    /**
-     * Initialize the analytics session
-     * @param accountIDInit Your analytics account id as configured in the server or core.ai analytics
-     * @param appNameInit The app name to log the events against.
-     * @param analyticsURLInit Optional: Provide your own analytics server address if you self-hosted the server
-     * @param postIntervalSecondsInit Optional: This defines the interval between sending analytics events to the server.
-     * Default is 10 minutes
-     * @param granularitySecInit Optional: The smallest time period under which the events can be distinguished. Multiple
-     * events happening during this time period is aggregated to a count. The default granularity is 3 Seconds, which means
-     * that any events that happen within 3 seconds cannot be distinguished in ordering.
-     * @param debug set to true if you want to see detailed debug logs.
-     */
-    function initSession(accountIDInit, appNameInit, analyticsURLInit, postIntervalSecondsInit, granularitySecInit, debug) {
-        if(!accountIDInit || !appNameInit){
-            throw new Error("accountID and appName must exist for init");
-        }
-        analyticsURL = analyticsURLInit? _stripTrailingSlash(analyticsURLInit) : DEFAULT_BASE_URL;
-        accountID = accountIDInit;
-        appName = appNameInit;
-        debugMode = debug || false;
-        postIntervalSeconds = postIntervalSecondsInit || DEFAULT_POST_INTERVAL_SECONDS;
-        granularitySec = granularitySecInit || DEFAULT_GRANULARITY_IN_SECONDS;
-        postURL = analyticsURL + "/ingest";
-        _setupIDs();
-        currentAnalyticsEvent = _createAnalyticsEvent();
-        _setupTimers();
-        _initFromRemoteConfig(postIntervalSecondsInit, granularitySecInit);
-    }
-
     function _ensureAnalyticsEventExists(eventType, category, subCategory) {
         let events = currentAnalyticsEvent.events;
         events[eventType] = events[eventType] || {};
@@ -263,10 +253,10 @@ function init() {
             throw new Error("missing eventType or category or subCategory");
         }
         if(typeof(count)!== 'number' || count <0){
-            throw new Error("invalid count");
+            throw new Error("invalid count, count should be a positive number");
         }
         if(typeof(value)!== 'number'){
-            throw new Error("invalid value");
+            throw new Error("invalid value, value should be a number");
         }
     }
 
@@ -321,10 +311,35 @@ function init() {
         _updateExistingAnalyticsEvent(modificationIndex, eventType, eventCategory, subCategory, eventCount, eventValue);
     }
 
-    analytics.initSession = initSession;
-    analytics.getCurrentAnalyticsEvent = getCurrentAnalyticsEvent;
+    // Init Analytics
+    if(!accountIDInit || !appNameInit){
+        throw new Error("accountID and appName must exist for init");
+    }
+    analyticsURL = analyticsURLInit? _stripTrailingSlash(analyticsURLInit) : DEFAULT_BASE_URL;
+    accountID = accountIDInit;
+    appName = appNameInit;
+    debugMode = debug || false;
+    postIntervalSeconds = postIntervalSecondsInit || DEFAULT_POST_INTERVAL_SECONDS;
+    granularitySec = granularitySecInit || DEFAULT_GRANULARITY_IN_SECONDS;
+    postURL = analyticsURL + "/ingest";
+    _setupIDs();
+    currentAnalyticsEvent = _createAnalyticsEvent();
+    _setupTimers();
+    _initFromRemoteConfig(postIntervalSecondsInit, granularitySecInit);
+
+    // As analytics lib load is async, our loading scripts will push event data into initData array till the lib load
+    // is complete. Now as load is done, we need to push these pending analytics events. Assuming that the async load of
+    // the lib should mostly happen under a second, we should not lose any accuracy of event times within the initial
+    // 3-second granularity. For more precision use cases, load the lib sync.
+    for(let eventData of analytics._initData){
+        event(...eventData);
+    }
+    analytics._initData = [];
+
+    // Private API for tests
+    analytics._getCurrentAnalyticsEvent = _getCurrentAnalyticsEvent;
+    analytics._getAppConfig = _getAppConfig;
+
+    // Public API
     analytics.event = event;
-    analytics.getAppConfig = getAppConfig;
 }
-
-init();