@moengage/web-sdk 2.55.0 → 2.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +63 -0
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -100,6 +100,22 @@ declare interface Identity {
|
|
|
100
100
|
[identity: string]: string;
|
|
101
101
|
}
|
|
102
102
|
|
|
103
|
+
/**
|
|
104
|
+
* Callback function for onsite module events
|
|
105
|
+
*/
|
|
106
|
+
declare interface OnsiteCallback {
|
|
107
|
+
(data: any): void;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Data structure for self-handled onsite interactions
|
|
112
|
+
*/
|
|
113
|
+
declare interface OnsiteInteractionData {
|
|
114
|
+
campaignId: string;
|
|
115
|
+
campaignName: string;
|
|
116
|
+
context: any;
|
|
117
|
+
}
|
|
118
|
+
|
|
103
119
|
/**
|
|
104
120
|
* Initializes the SDK.
|
|
105
121
|
* @param initData - configuration for SDK intialization.
|
|
@@ -296,6 +312,52 @@ declare function on_cards_loaded(): Promise<any>;
|
|
|
296
312
|
*/
|
|
297
313
|
declare const cards: any;
|
|
298
314
|
|
|
315
|
+
/**
|
|
316
|
+
* Contains the properties and methods of the onsite module for in-app messaging.
|
|
317
|
+
*/
|
|
318
|
+
declare const onsite: {
|
|
319
|
+
/**
|
|
320
|
+
* Retrieves web personalisation V1 campaign data.
|
|
321
|
+
* @returns The onsite data if SDK is loaded and available; otherwise false.
|
|
322
|
+
*/
|
|
323
|
+
getData(): Promise<any>;
|
|
324
|
+
|
|
325
|
+
/**
|
|
326
|
+
* Registers a callback function for web personalisation V1.
|
|
327
|
+
* @param callback - The callback function to register.
|
|
328
|
+
* @returns Promise.
|
|
329
|
+
*/
|
|
330
|
+
registerCallback(callback: OnsiteCallback): Promise<any>;
|
|
331
|
+
|
|
332
|
+
/**
|
|
333
|
+
* Gets self-handled onsite messaging data.
|
|
334
|
+
* @param callback - The callback function to handle the onsite messaging data.
|
|
335
|
+
* @returns
|
|
336
|
+
*/
|
|
337
|
+
getSelfHandledOSM(callback: OnsiteCallback): any;
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* Tracks when a self-handled onsite message is shown.
|
|
341
|
+
* @param data - The data associated with the shown onsite message.
|
|
342
|
+
* @returns Promise<any>.
|
|
343
|
+
*/
|
|
344
|
+
selfHandledShown(data: OnsiteInteractionData): Promise<any>;
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* Tracks when a self-handled onsite message is clicked.
|
|
348
|
+
* @param data - The data associated with the clicked onsite message.
|
|
349
|
+
* @returns Promise<any>.
|
|
350
|
+
*/
|
|
351
|
+
selfHandledClicked(data: OnsiteInteractionData): Promise<any>;
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* Tracks when a self-handled onsite message is dismissed.
|
|
355
|
+
* @param data - The data associated with the dismissed onsite message.
|
|
356
|
+
* @returns Promise<any>.
|
|
357
|
+
*/
|
|
358
|
+
selfHandledDismissed(data: OnsiteInteractionData): Promise<any>;
|
|
359
|
+
};
|
|
360
|
+
|
|
299
361
|
export {
|
|
300
362
|
initialize,
|
|
301
363
|
isMoeLoaded,
|
|
@@ -325,5 +387,6 @@ export {
|
|
|
325
387
|
handle_page_change,
|
|
326
388
|
on_cards_loaded,
|
|
327
389
|
cards,
|
|
390
|
+
onsite,
|
|
328
391
|
InitData,
|
|
329
392
|
};
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
const Moe={initialize:e=>{var d=e.app_id,o=e.debug_logs||0,a=e.cluster||"DC_1",n=e.disable_onsite||!1,i=e.enableSPA||!1,s=e.cards||null,t=e.disable_web_push||!1,r=e.swPath||"/serviceworker.js",g=e.disableCookies||!1,l=e.useLatest||!1,
|
|
1
|
+
const Moe={initialize:e=>{var d=e.app_id,o=e.debug_logs||0,a=e.cluster||"DC_1",n=e.disable_onsite||!1,i=e.enableSPA||!1,s=e.cards||null,t=e.disable_web_push||!1,r=e.swPath||"/serviceworker.js",g=e.disableCookies||!1,l=e.useLatest||!1,M=e.sdkVersion||"2.56.0",w=e.disableSdk||!1,_=e.proxyDomains||null;try{s&&(s=JSON.stringify(s))}catch(e){console.log("Failed to parse cards config",e)}if("undefined"!=typeof window&&document&&!window.Moengage){var u=a.toLowerCase(),c=document.createElement("script"),m=M&&!l?`https://cdn.moengage.com/release/${u}/versions/${M}/moe_webSdk.min.latest.js`:`https://cdn.moengage.com/release/${u}/moe_webSdk.min.latest.js`;c.type="text/javascript",c.text=`!function(e,n,i,t,a,r,o,d){if(!"${u}"||"{DC}"==="${u}")return console.error("Data center has not been passed correctly. Please follow the SDK installation instruction carefully.");var s=e[a]=e[a]||[];if(s.invoked=0,s&&s.initialised>0||s.invoked>0)return console.error("MoEngage Web SDK initialised multiple times. Please integrate the Web SDK only once!"),!1;e.moengage_object=a;var l={},g=function n(i){return function(){for(var n=arguments.length,t=Array(n),a=0;a<n;a++)t[a]=arguments[a];(e.moengage_q=e.moengage_q||[]).push({f:i,a:t})}},u=["track_event","add_user_attribute","add_first_name","add_last_name","add_email","add_mobile","add_user_name","add_gender","add_birthday","destroy_session","add_unique_user_id","update_unique_user_id","moe_events","call_web_push","track","location_type_attribute","track_page_view","getSdkVersion","setDebugLevel","handle_page_change","identifyUser","getUserIdentities"],m={onsite:["getData","registerCallback","getSelfHandledOSM"]};for(var c in u)l[u[c]]=g(u[c]);for(var v in m)for(var f in m[v])null==l[v]&&(l[v]={}),l[v][m[v][f]]=g(v+"."+m[v][f]);r=n.createElement(i),o=n.getElementsByTagName("head")[0],r.async=1,r.src=t,o.appendChild(r),e.moe=e.moe||function(){return(s.invoked=s.invoked+1,s.invoked>1)?(console.error("MoEngage Web SDK initialised multiple times. Please integrate the Web SDK only once!"),!1):(d=arguments.length<=0?void 0:arguments[0],l)},r.addEventListener("load",function(){if(d)return e[a]=e.moe(d),(e[a]&&(e[a].initialised=e[a].initialised+1||1)),!0}),r.addEventListener("error",function(){return console.error("Moengage Web SDK loading failed."),!1})}(window,document,"script","${m}","Moengage");\n Moengage = moe({\n app_id: "${d}",\n debug_logs: ${o},\n swPath: "${r}",\n cluster: "${a.toUpperCase()}",\n disableOnsite: ${n},\n disableCookies: ${g},\n disable_web_push: ${t},\n enableSPA: ${i},\n cards: ${s},\n disableSdk: ${w},\n proxyDomains: ${_}\n });\n `,document.head.appendChild(c)}},isMoeLoaded:()=>{try{if("undefined"!=typeof window&&document&&window.Moengage)return!0}catch(e){return!1}return!1},track_event:(e,d)=>Moe.isMoeLoaded()&&window.Moengage.track_event(e,d),getSdkVersion:()=>Moe.isMoeLoaded()&&window.Moengage.getSdkVersion(),setDebugLevel:e=>Moe.isMoeLoaded()&&window.Moengage.setDebugLevel(e),add_unique_user_id:e=>Moe.isMoeLoaded()&&window.Moengage.add_unique_user_id(e),update_unique_user_id:e=>Moe.isMoeLoaded()&&window.Moengage.update_unique_user_id(e),identifyUser:e=>Moe.isMoeLoaded()&&window.Moengage.identifyUser(e),getUserIdentities:()=>Moe.isMoeLoaded()&&window.Moengage.getUserIdentities(),enableSdk:()=>Moe.isMoeLoaded()&&window.Moengage.enableSdk(),disableSdk:()=>Moe.isMoeLoaded()&&window.Moengage.disableSdk(),isSdkEnabled:()=>Moe.isMoeLoaded()&&window.Moengage.isSdkEnabled(),getUserId:()=>Moe.isMoeLoaded()&&window.Moengage.getUserId(),getUserAttribute:e=>Moe.isMoeLoaded()&&window.Moengage.getUserAttribute(e),add_user_attribute:(e,d)=>Moe.isMoeLoaded()&&window.Moengage.add_user_attribute(e,d),add_first_name:e=>Moe.isMoeLoaded()&&window.Moengage.add_first_name(e),add_last_name:e=>Moe.isMoeLoaded()&&window.Moengage.add_last_name(e),add_email:e=>Moe.isMoeLoaded()&&window.Moengage.add_email(e),add_mobile:e=>Moe.isMoeLoaded()&&window.Moengage.add_mobile(e),add_user_name:e=>Moe.isMoeLoaded()&&window.Moengage.add_user_name(e),add_gender:e=>Moe.isMoeLoaded()&&window.Moengage.add_gender(e),add_birthday:e=>Moe.isMoeLoaded()&&window.Moengage.add_birthday(e),destroy_session:()=>Moe.isMoeLoaded()&&window.Moengage.destroy_session(),call_web_push:e=>Moe.isMoeLoaded()&&window.Moengage.call_web_push(e),track_page_view:()=>Moe.isMoeLoaded()&&window.Moengage.track_page_view(),handle_page_change:()=>Moe.isMoeLoaded()&&window.Moengage.handle_page_change(),on_cards_loaded:()=>new Promise(((e,d)=>{"undefined"!=typeof window?window.Moengage.cards?(Moe.cards=window.Moengage.cards,e()):window.addEventListener("MOE_LIFECYCLE",(d=>{"CARDS_INITIALIZED"===d.detail.name&&(Moe.cards=window.Moengage.cards,e())})):d()})),cards:"undefined"!=typeof window&&window.Moengage&&window.Moengage.cards||{},onsite:{getData:()=>Moe.isMoeLoaded()&&window.Moengage.onsite.getData(),registerCallback:e=>Moe.isMoeLoaded()&&window.Moengage.onsite.registerCallback(e),getSelfHandledOSM:e=>Moe.isMoeLoaded()&&window.Moengage.onsite.getSelfHandledOSM(e),selfHandledShown:e=>Moe.isMoeLoaded()&&window.Moengage.onsite.selfHandledShown(e),selfHandledClicked:e=>Moe.isMoeLoaded()&&window.Moengage.onsite.selfHandledClicked(e),selfHandledDismissed:e=>Moe.isMoeLoaded()&&window.Moengage.onsite.selfHandledDismissed(e)}};module.exports=Moe;
|