From 3db341a2cce06c2b3876f067d2c6a38c7e33c04f Mon Sep 17 00:00:00 2001 From: Etienne Margraff Date: Tue, 25 Oct 2016 09:33:40 -0700 Subject: [PATCH 01/38] fix version for vorlon node wrapper --- VorlonNodeWrapper/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/VorlonNodeWrapper/package.json b/VorlonNodeWrapper/package.json index f7b7f393..7fae16d9 100644 --- a/VorlonNodeWrapper/package.json +++ b/VorlonNodeWrapper/package.json @@ -1,6 +1,6 @@ { "name": "vorlon-node-wrapper", - "version": "0.0.2", + "version": "0.0.3", "description": "Wrapper for getting Vorlon.js plugin file inside a node.js application", "main": "wrapper.js", "author": "Vorlon Team", From ea0c3964ae222518885eb494ae009aad5bcdcca0 Mon Sep 17 00:00:00 2001 From: Etienne Margraff Date: Tue, 8 Nov 2016 16:51:30 -0800 Subject: [PATCH 02/38] Init the Botframework inspector plugin --- .../botFrameworkInspector/control.html | 10 +++++++ .../plugins/botFrameworkInspector/icon.png | Bin 0 -> 8388 bytes .../vorlon.botFrameworkInspector.client.ts | 24 +++++++++++++++++ .../vorlon.botFrameworkInspector.dashboard.ts | 25 ++++++++++++++++++ ...vorlon.botFrameworkInspector.interfaces.ts | 5 ++++ Server/config.json | 9 +++++++ 6 files changed, 73 insertions(+) create mode 100644 Plugins/Vorlon/plugins/botFrameworkInspector/control.html create mode 100644 Plugins/Vorlon/plugins/botFrameworkInspector/icon.png create mode 100644 Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts create mode 100644 Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts create mode 100644 Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/control.html b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html new file mode 100644 index 00000000..eaf87ceb --- /dev/null +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html @@ -0,0 +1,10 @@ + + + + + + + +
+ + diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/icon.png b/Plugins/Vorlon/plugins/botFrameworkInspector/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..4e791426204ed74d5700f5ab2444f1be4668b93f GIT binary patch literal 8388 zcmXYX1z1z>`}f&k(p`cKa7amth%k^GB1%Y%E|riHlu5@XAfX^F(jg)Pq)}op6~9sr zBqSszqC*fykLG{;z3;iMUFYnH``qz7cYL0cc+=F7jai5p001_lYbXlfbkS~ zbA0gH1H91(>KR!vf>#8iTLSo>Dd3u2AOIv>`}c#mb2Y=jMnQ~$EymK{0~37ffjbZ! z9IW7V&nNKCtpIlg{|BCVtC~UpAO;wrbge@2S7yR<;OH0Bbt>L8A(2V!!?h2e#7eQ) zSG4a&l1S#Ce(!R`wBkRXN%`>A9Fy}?@T|0$xlU^T`hfI<6aiuX0QR5n&p{ulVUZab zZe8tp(n+V)im!32NCzW>XwH;p_>_W|8Gmn}Yo^dtO6dNdii}mKE~oJEcAFae=IqVc z3>eqsc=*X>VhQoDbkc92kw6Q?M&h)AGuY&xa|9ZPI^`aEEcr#Oa-2AVfzBW5Y`k$C zK>Bj(HxN$Ob*G({7pzqHAE6Sa5~mb>d}x!LoGfoNE4zt|$T6o(Kg0f-J;=iE=kbbLUmb^$M=i}(!pS%W zQUK|QF2D_0-%>B~E-WNuH#dB>m0~8S+1ZOr7ziLmj)tE^&6^!Gu^}mMtj11$HF|%` zzG(w<1+PTfu`+pW3$Zd9L)=Tg`ZFvX7jC!#x!)GJYDxSntg3$6;OlU+&-k%Yyx(?5 z3bRgh^oh$=a|~>4X-jBKqMu3}<7F!4rOyxd!+CW>V{0hLm{%jdEEid61rDZYwW0HTo$iM$8Tb&a1mk^zYzsFwiseAw6fU>o{U9&cOV^NOB@v_gi>Wix#o1`B@ zx=F9fp-TR<9j%d(k+Qh5#%H4~3l*Cxg9PVv0hOWw{HcADPikR?XA-^t5 z$$g=65dMSAki%5Xn-;0hP?;XbA|SGuf1p6PzeXplqOAPjr@0}#*>F+JK*`iVwW^6;#q2rh+m?NqL~zekC2T zz4P{?It@uZqUcjzKazK7aby|Qqb$Y-u5Q`a?6~Mr82#e4ux_b?c%4v-pZOXk&b86n zn3M*g)2Bn?X~%6t>TN1WRn?${p`oGuAzi)65?JcfwdK&+gFz%EC_L+96SeLmd){w? z;zx3>j5)895E6CmyRaA?9o-GaiyfC)49C5jNA%*Q%LqGD%i_f8A@yN$ez-%8wZmzo zp|k@Fv9h9Y>iP79rKA8nc>4Yz3%t}gMg4b<06>W&rAbnzf0bN}ZDjk&L*TfS21;0by;sHgu%#%HLh1Qq**+c3LRvXaEGB#CXJ22I+ zlk|mG%4%z=65t{XRl=k=qq8Bm+t)|e*48@Fx#7y!U#%)^zvme8Rh1p@xRDX~hWWt% z+f%`d&S#LQLd1ONK~?ej!Hcq46VYEhHp@#cF32E?Uf4hRUn6=lnjw}wwL;pizG5q# zFVQ$YKM)*9YW3#BGQ&@!LksOHQ7pu8ml~*!fwL`sQ`3@`JKo{Jzy9913$m>3-JLp1B>+|&|cw6AS`D7(& zbKttfj>|7oNC%B0jy;WmGOb^7ajSuuV0QlDN85$`cD}oj$!j9N2ybORv~wDm^X<$9 z&K`(@LqQ?sANnnd3AUS|qXm&DMU912{V2UXMZpstwCw%nJJY+dVzQ53_2kexM+X%- zE>8!1JRM-UC~SwHKR5?nn^ok1pS$569Th6G7bP4>id6icO+jzwTwL8Reg&zb(j*D4 zpwn>p5kyHCX?WGTa_RTb*$vhE?!{Fx(ig0 zKg#cFzTTbYLZYO<^8!>tFiD<`Ptv{U=2+U$*}l6oZ4U=SsEVuw;;_z1-|SyUvuSq^ zqF;|Mzom0wN|i9tMvq0a!Al3&uWSv~Lf^)bzLwuO#lSEg$Idm(4imfoDsc64tEAER z1;hi>MNapik8GEpf&qpA-$gIV!R=@7s%U}Aznj4ipyBJYUCFbZ=hy6Hp_4*FLSfVD zZ%>CHFxjd{zF>T5!Ur9iG&S-A_%`*>`$c^h%%-Xt-Kw2y=O~0|4JCf$jVG$K?QQw` zD*gHbegGRrhFetYx%t|mHltOHf9ic#S++g!6Xk}d9dD9ayZV(ZtD=~NN8ZmBl;O*TdaYFu4bN%E zVU+3hl19KrRVcYUNV{jj-W&4NaxCp?*}5)enu$25+}ET*qpQF#$>K~;-FH+#cvj^1 z8W-cuSlQVN7xKeJf9%7)At@=AV~s21xz-kY;QL`opm~k82HQJEHR&;{jBwsvm9<}q z;)m%TN1hrXnm$Z!#wb(hM(5`!Lf|UTcG!`Iy8m0L<}qkaPxzeGSnXi$rDgZtwI9_U zmSE)W`ls-6{Qjqvc$y?U{2RCQD@`-L6VZU*)pm_3O)*^$;ctPU5HZShN9d-vIj=k< z8!!xB51@roZ9=HeIoQ~0yvmt8<#D&U(&%vU*iP2VBS1EtYb|Pe!0mBRU`qBfC{{x)=(*albWPDKY|c`d z22x7zrqH5P*Tda~)=y`$%^oC^TGwg)`!bfVrkldHm*zZpyOfn>f%b-fvCB?=)XP9j zlk1Q8@s@U7oXbfkzEEj0+HFtkLVd~s(3bY=N$wUC<^f@DpME${vj%<$xJ*q(PrNT8 zh{42sdZk+VZ~^u!hu?L2D})r=Eck&s1n2ePz40ZW*a!VkrC-xy{JH}`Owtka9I_vb z&X_FN9S&8ig888;x` z@uJ971|d)Gk(3j>Ox&3P44VE;9iqx+Ov zIo>9TQKx+**6A$br@_mcsBW&o&uT0=FCyYYAQKfC)Iq$r>}EH}9~1oxp1SAfiWUn7 z_;xR#3FlWdYdF&g*f`=3V!u?xT+z(i{am6XS!-UR^S`cI>oKYH&;FjIE(fda?wz8z z-WWbC|CSyXXIc#QQ@3STu8&-CKk5WnOkC9DB^t8RoCVsm#> zS6lIkALb7i`BTubi=#C#bu$)`D!f&}Bf85_v7RH?b`7m9h>V?7mj(Qo(ex-cg@6ld zro@N)YU^1}=qn@B4c-(GMgiVk;r=`;u zwx)kLz0@0c3Faz~&BTmw15suXZ>O8A^!dj5$#nSr%C&mb%{j0^p5pl&apRMDZg z^<2vn{t6tkj0I(WeaaJ~lQog5|sUk6QnHW$x6bce*BMvG-P zhkawpsdpRw?qubeYG&U8e8w*=4e9m`FzY-{uRnS?-@0pjpbDW2qUr?wU^ zqV3@M#HEvJUkJO+SiByC3=7!0eETnXa9CwN(%0fPsMK?^J1UC>p$Fkv4BmJoFY=n8 zEsNNdiaQL^BEsvPsxqLwg`Z03tP)n1Gi@Q)bcYWW_w@?g9|SZEnmn%tUVhX{+weTl zgjoZ__2)2H=7z{ZXgl+e1eZEvokZP7HCwbOJG}I{9ZPZeH(s{SJCWcd%wTTmkBLrd zdI1!pi`qdHQvJOb<@hc^|AIMCEc z$e}|nPnj)bk<_oxp!6w%4Ylxv7>~OQjI>9*JHpYVTm}<*{D|6>OV8RP9AyEg27aB8 zxG*-<%Tp2jA(2<}LbL*y1FjFBSF=G!fBh3<2U#>ds~vg%6=y9jL73SQntwg&avTAs zri(g;y}OAP^`b%kp4W*-bwkP~%14KCiJ8^NUi-9a`be2u8nH!mS}*Y~{*-6cu%TAL ziT5t_T?|0jF_U76UY*S8L-E4q*Wd zpVW4x_D`=XFUzm+$N~jo@ZOckDB(cboD<7MvAB1OxPyq4zDU0VK_85%8$$aDGxd z6ux|=lWTXHbUebWLn&m36MeJxe9j_n;DX%=1y2tN2@$RhCw0&vbsq??;VY0o#Uh1oLx&) z<&uAU00r*iGXUwH|U zLC~q(JC~s~Erg8k?Y@Ii4L4ItmAng(G}h zf3}SUuOvUcEc5sMH+ zrq}WKu2WHL(`v{5JV_rye10S^Tz(sUEfDk$=?f~wx|e3v&W0AZwEvE-NcZY0?4Pe^ zx%;}dr z-pVC?;#f&w=EPX97ResXjGbZ4#NEJt){mDi`J71e6H#4gDi{J^s)|0M%NQVdv;}!J z_;0$(10z|{r$j)HfD)0Mtq8qW%Pi6Y`e!u!zkTR1Mz_IibK|4%TfSkA8o*5l%-FO< zkcLL1IRD=rUrw!EBYhwEu4uI#B@4)Kb4eitIG_vJhtz70vn3J#NEK${On0*e1~IR{_lx4pn#jpP*ZN((l$fe zEmJPu|-D@Vd>TfoYZwajI!of%(`R#0D&o8*W%__x@Y2 zO)_ztM;h3Ut4-VKpRu2K=JH|pCDz)9&RT46u6;^8afKDLITcdF=lMUL!NR(Wf+T|! z>u#c{9B{XA{JzTivh^uS)l!k=t$Tdp42UA#E`XIbsN&hRI7o%dJj6g@=1#8GxQzd4e+j+pjrJxnTs_aSGIEH zyT|upoR@r_Cv4GaLp)+h!;iJOMGu#y4$PM6CK7o`G)2Vf=+ug9`ht#HcF3a7q#rb8 zr8!1a2hD(^fko3}bMj~b{1Dub@Ryj*6A`r2?E4mubDbS(L+^vabqhj#qhJ3ZRC1=sc+NHLQTc*>2A&M{U$k{${%N;9Dw=O2v*T@V5CI~ z7mQ!}(tcnd3nX@sXy1D_HOX@G-;-#jKQGW7q~S$CXdoBm23d1*4Fd74X|sr>$>I1^ zKA@$L8vTTH@5grcm-j56KigCop>`l7IxXW1+I~~_^YNfB04FX0^Bn9<1+d-A^MS|N z47unwAXanE|9QfIgn|n7WpKRc^EZ5egM*K!luIKN74kIX!{}hu(p`;c+ezrn*v%u; zbF!QT>~gQve7NqFY=1NQV-EpKC~Y#7977xxR^1a`Gb6ee6oy$h0K6*^U6w`{Y+2>b zp8V>KPms#8HJUcOZ}=qIrq7y)LTqr)n=M%O{5;!nb`HXhm#@lbhwWti2o{JQDJcG7=nK_|v}vD;YDox7^f|JoNUn z8L8@P)Ph2q~qijVeAvDKHBpsPYhcQ!oZk0 zAZBP*NUe~Ud2}&B1MjgxVXvx4(7sg&EnI1Oc&7%tlh`BD{mE5yo-W!_`HZ=Og(85k z5Wn|W0h02Ee0Eh_OWQ^FuyO=V1lODYsad}Lh%NzJ*<#vD3jnpiNEYv=6f*=JVWV4^ zc16|<(1i9F$C*N^i(W*hOVU@L&^l`!|37#jp-0$NaNWJKGgH~*Kc2b%2wm9gZA@2<3fG>`JVd4j9PSF|1Gpx6)EIW9_hyCmq{u?#+vu5&3}29Jt(4Z>i9vj{ zODJOF4!PF;@SzWkest&3buM+>JI@WxjV{G74zehg0ktrb;kF#q*_nrfXzaGP$d%1q zlJTj6i6K0B=El&Oq4Ww2T5s?sT(ea<~gK(xzc0d36o02Z=64Y6A)(6Hrr;xXS*oYt>WNwnXU>b9SQw>j}#$UQs zz{FZJcTC7xd!Kqg?d}~r_y(A@SZ%Y<8>u*~Be~R7KdO0fx7!Pl5#*XsSa0u0H|5~+ zV|I(P{dWn9pq7%2C8aWUAPGGhIc{7y5l_ki4&>qfN&vGMA|4n&)stTCfZYpPV`%&* zl~Zmt2S_P2l%cn$d-Dhk7M16hS)||i?Su9~cL$QPKE>g~%ojON)pcU^raED3c45IE zdVBLvBe98gvc)+q`~X+zmG!3*?hQJqS$?pV@wU6#<%3kIhXq8{@lKv!-ds}u#w=aP zsDs)m-|kl-{6_a?v01YA4<9;F95EBO;gnDh7zEAF!9}{@^uJr=-sEe+@!uUnQ?Jv2PD$S7J`yFen z^Gr3*c+F;nFL<$rq~WKebak61nXiq^kXrwt<|j;bD<2XQ1mvVQ-*c=-#044E*=ED0 zR;xN_b6ja-o0P$5r()JPE=VmS93cfFl2=N;$U^OGLA;a7otB4MSj4J7N|OFI_1g~L zxA|AXg%yr{=dLD=@O;e9t%vH+H0QJW6}l6P!{KarYJDB(EwNPw3qoAIchGYm>iDs} zGeja$aP~k0+r?Pmt|7WLJ6HJhNhQ4xB*zhih8$N3C(P@-)VQDd;cyV3*Vp&#)kkTj zmNM_~bDg=spPFz;pdJ4mQnyzU*q!|l$3kO;pY!2b^Ihar7nE@RIZHn@H+K?7?)vBR z#jhF~)&`RJ+}WNQqq@aw@MLp`Epb*Zb(N&jGZWjwnFg5K;K@gMiN2c*R5g}8Ed#GP zsArV>RTdYi=lKUj*z@gcth-_NEpEYxZr*NgZh`@Bi^4MjBqyhDvUF%9>~-I!+*23} zzwmtiLBOK0%tS^yNtO%J#rFSn7k2@~-I-v7>2Vx~ylq`EX7f6VSO8+sFV7D)a(Xx0 zvxS6%v!?F&`c`9j2Cnux?tukldc7fTtVG``F>sZ+@6vlYq6THK=mbA>c334UInZE; zck-an2|8c~vYtk~4`SZLOL<=`W>i$1foukoG(v;GJH5ox*8`0=2%pq#aKH8RiZ*zv5?7-CQUZD{_wyWkzJ%-v9{&-1uK`F{*i{UZB9~Pe zckzDyrUWsg387d^NFQ*FZ^0Q{O;^!ujasl#os%nz>y=t;&O9r4y;xsW)FVq zd-lBV?^l*|J-aD!-tuIXE*`|=I)YC_eoc{LH_M?*R9aC;?BLzcg^-W zh;y&;+q(k9tv@4|AzAO18!TXe4mvC3DJ}Q!eA6!hVg%anVL@m{y#}=-Fmq$pswLT@ z(XQqnt7mZIkRr+HFlaPFq<;4~eqX1U)q`^Wz7PnrZ!?3E-ZLL#!99n%K>o8ZyQI$H z$RYd&e}YE$2mQ2=38BiGXCCbDU%&7qd$Y5>Dgv>=JfD|fdQIZ%!YVz&6DM>7gtp9BZ?4 z3;907Gs`ZR@)x)8%lt&Qf2qVdGKze2{tRm8&c@|9234LS4K4ZzQQJzqd#h~y1Jr^P z(FcUzlW5LD$ya6U%U6B83j;K5!4KQ^m`?q%fw#Y-}^q@-kKbvVbIy&-j}o_4Ng1_jTXKNk@JpYN{H@k&8?Z5Wi~q zi*PbcCcFN5V{8XedSUc9#YGTl$gFBsfNb`?=s{-<82?uoGM_kjGyhBv@+*dPw6Zi- zbwhn?ni<VyDT(>O zjAeS&)fL?(opkTqVa>;nq}CBI25jR37f48mi4u6q(G}f$!})>STGWT?>nk{a5a5T~ zeTosShPg89p*++mS|F&;FmW;7a3*K_lLeFPjgrltwhv2CiySkJ=MF)2@%4 zUd!-k3|%Lai%q1Sf!#Mrt*@=C$mS_4-l(KQ1b?lpBx?-ao= z2Y^fez6F4~hUxutXQbAj`GE}FX0n$(KhOk;lGLM9u4RGu4i5$^Obfye@aU>SmggN4 a$J)d$ceBJ`kztSkU}Rv5dZXw1=>Gr<90}L} literal 0 HcmV?d00001 diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts new file mode 100644 index 00000000..5e8bb46f --- /dev/null +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts @@ -0,0 +1,24 @@ +module VORLON { + export class BotFrameworkInspectorClient extends ClientPlugin { + constructor() { + super("botFrameworkInspector"); + //this.debug = true; + this._ready = true; + } + + public getID(): string { + return "BOTFRAMEWORKINSPECTOR"; + } + + public sendClientData(): void { + this.sendToDashboard("Yo bitcheeeeeeezzZZZZ!"); + } + + public refresh(): void { + this.sendClientData(); + } + } + + //Register the plugin with vorlon core + Core.RegisterClientPlugin(new BotFrameworkInspectorClient()); +} \ No newline at end of file diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts new file mode 100644 index 00000000..8972f30d --- /dev/null +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts @@ -0,0 +1,25 @@ +module VORLON { + export class BotFrameworkInspectorDashboard extends DashboardPlugin { + constructor() { + super("botFrameworkInspector", "control.html", "control.css"); + this._ready = false; + this._id = "BOTFRAMEWORKINSPECTOR"; + } + + private _containerDiv: HTMLElement; + + public startDashboardSide(div: HTMLDivElement = null): void { + this._insertHtmlContentAsync(div, (filledDiv) => { + this._containerDiv = Tools.QuerySelectorById(div, "botFrameworkInspector"); + this._ready = true; + }) + } + + public onRealtimeMessageReceivedFromClientSide(receivedObject:any):void { + this._containerDiv.textContent = receivedObject; + } + } + + //Register the plugin with vorlon core + Core.RegisterDashboardPlugin(new BotFrameworkInspectorDashboard()); +} \ No newline at end of file diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts new file mode 100644 index 00000000..d8f2c959 --- /dev/null +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts @@ -0,0 +1,5 @@ +module VORLON { + // export class PerformanceItem { + // public name: string; + // } +} \ No newline at end of file diff --git a/Server/config.json b/Server/config.json index 4bd8a379..ab64d3f1 100644 --- a/Server/config.json +++ b/Server/config.json @@ -142,6 +142,15 @@ "enabled": true, "nodeCompliant": false, "nodeOnly": false + }, + { + "id": "BOTFRAMEWORKINSPECTOR", + "name": "Bot Framework Inspector", + "panel": "bottom", + "foldername": "botFrameworkInspector", + "enabled": true, + "nodeCompliant": true, + "nodeOnly": true } ] } \ No newline at end of file From 75d2040cbf1b2e70ca0cc609457309706d1d948e Mon Sep 17 00:00:00 2001 From: Etienne Margraff Date: Wed, 9 Nov 2016 14:14:04 -0800 Subject: [PATCH 03/38] First draft with hooking for libraries --- .vscode/launch.json | 12 + .../vorlon.botFrameworkInspector.client.ts | 46 +- .../vorlon.botFrameworkInspector.dashboard.ts | 14 +- ...vorlon.botFrameworkInspector.interfaces.ts | 22 + .../Vorlon/typings/botbuilder/botbuilder.d.ts | 2405 +++++++++++++++++ Server/config.json | 88 +- client samples/botbuilder/index.js | 41 + client samples/botbuilder/package.json | 16 + gulpfile.js | 29 + 9 files changed, 2622 insertions(+), 51 deletions(-) create mode 100644 Plugins/Vorlon/typings/botbuilder/botbuilder.d.ts create mode 100644 client samples/botbuilder/index.js create mode 100644 client samples/botbuilder/package.json diff --git a/.vscode/launch.json b/.vscode/launch.json index f4ec0ee4..9cd17d08 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -63,6 +63,18 @@ "runtimeExecutable": null, "env": {} }, + { + "name": "Launch botbuilder sample", + "type": "node", + "program": "${workspaceRoot}/client samples/botbuilder/index.js", + "stopOnEntry": false, + "args": [ + "--nolazy" + ], + "cwd": "${workspaceRoot}/client samples/botbuilder", + "runtimeExecutable": null, + "env": {} + }, { // Name of configuration; appears in the launch configuration drop down menu. "name": "Launch w/TypeScript", diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts index 5e8bb46f..ad00b574 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts @@ -1,21 +1,55 @@ -module VORLON { +/// + +module VORLON { export class BotFrameworkInspectorClient extends ClientPlugin { + private _libraryHooked:boolean; + private _botInfo:BotInfo; + constructor() { super("botFrameworkInspector"); //this.debug = true; this._ready = true; + this._libraryHooked = false; + this._botInfo = new BotInfo(); } - public getID(): string { - return "BOTFRAMEWORKINSPECTOR"; + public startClientSide(): void { + this.hookLibraryDialogFunction() + } + + public hookLibraryDialogFunction(){ + var path = require("path"); + var requireHook = require("require-hook"); + requireHook.attach(path.resolve()); + + var that = this; + requireHook.setEvent(function(result, e){ + if (!that._libraryHooked && e.require === "botbuilder") { + var previousDialogFunction = result.Library.prototype.dialog; + + result.Library.prototype.dialog = function(id: string, dialog?: any | any[] | any) { + if(dialog){ + var dialogData = new DialogData(); + dialogData.id = id; + dialogData.dialog = dialog; + that._botInfo.dialogDataList.push(dialogData); + that.refresh(); + } + return previousDialogFunction.apply(this, arguments); + } + + that._libraryHooked = true; + } + return result; + }); } - public sendClientData(): void { - this.sendToDashboard("Yo bitcheeeeeeezzZZZZ!"); + public getID(): string { + return "BOTFRAMEWORKINSPECTOR"; } public refresh(): void { - this.sendClientData(); + this.sendToDashboard(this._botInfo); } } diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts index 8972f30d..38d1d506 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts @@ -6,17 +6,29 @@ this._id = "BOTFRAMEWORKINSPECTOR"; } + private _lastReceivedBotInfo: BotInfo; private _containerDiv: HTMLElement; public startDashboardSide(div: HTMLDivElement = null): void { this._insertHtmlContentAsync(div, (filledDiv) => { this._containerDiv = Tools.QuerySelectorById(div, "botFrameworkInspector"); this._ready = true; + this.display(); }) } public onRealtimeMessageReceivedFromClientSide(receivedObject:any):void { - this._containerDiv.textContent = receivedObject; + this._lastReceivedBotInfo = receivedObject; + this.display(); + } + + public display(){ + if(this._lastReceivedBotInfo){ + this._containerDiv.textContent = ""; + for(var i = 0; i < this._lastReceivedBotInfo.dialogDataList.length; i++){ + this._containerDiv.textContent += "
" + this._lastReceivedBotInfo.dialogDataList[i].id; + } + } } } diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts index d8f2c959..872424cc 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts @@ -2,4 +2,26 @@ // export class PerformanceItem { // public name: string; // } + + export class BotInfo { + public dialogDataList: DialogData[]; + public callStackHistory:BotCallstack[]; + + /** + * + */ + constructor() { + this.dialogDataList = []; + this.callStackHistory = []; + } + } + + export class DialogData { + public id:string; + public dialog:any|any[]; + } + + export class BotCallstack { + public callstack:any[]; + } } \ No newline at end of file diff --git a/Plugins/Vorlon/typings/botbuilder/botbuilder.d.ts b/Plugins/Vorlon/typings/botbuilder/botbuilder.d.ts new file mode 100644 index 00000000..792b96d7 --- /dev/null +++ b/Plugins/Vorlon/typings/botbuilder/botbuilder.d.ts @@ -0,0 +1,2405 @@ +//============================================================================= +// +// INTERFACES +// +//============================================================================= + +/** + * An event received from or being sent to a source. + */ +export interface IEvent { + /** Defines type of event. Should be 'message' for an IMessage. */ + type: string; + + /** SDK thats processing the event. Will always be 'botbuilder'. */ + agent: string; + + /** The original source of the event (i.e. 'facebook', 'skype', 'slack', etc.) */ + source: string; + + /** The original event in the sources native schema. For outgoing messages can be used to pass source specific event data like custom attachments. */ + sourceEvent: any; + + /** Address routing information for the event. Save this field to external storage somewhere to later compose a proactive message to the user. */ + address: IAddress; + + /** + * For incoming messages this is the user that sent the message. By default this is a copy of [address.user](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iaddress.html#user) but you can configure your bot with a + * [lookupUser](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iuniversalbotsettings.html#lookupuser) function that lets map the incoming user to an internal user id. + */ + user: IIdentity; +} + +/** The Properties of a conversation have changed. */ +export interface IConversationUpdate extends IEvent { + /** Array of members added to the conversation. */ + membersAdded?: IIdentity[]; + + /** Array of members removed from the conversation. */ + membersRemoved?: IIdentity[]; + + /** The conversations new topic name. */ + topicName?: string; + + /** If true then history was disclosed. */ + historyDisclosed?: boolean; +} + +/** A user has updated their contact list. */ +export interface IContactRelationUpdate extends IEvent { + /** The action taken. Valid values are "add" or "remove". */ + action: string; +} + +/** + * A chat message sent between a User and a Bot. Messages from the bot to the user come in two flavors: + * + * * __reactive messages__ are messages sent from the Bot to the User as a reply to an incoming message from the user. + * * __proactive messages__ are messages sent from the Bot to the User in response to some external event like an alarm triggering. + * + * In the reactive case the you should copy the [address](#address) field from the incoming message to the outgoing message (if you use the [Message]( /en-us/node/builder/chat-reference/classes/_botbuilder_d_.message.html) builder class and initialize it with the + * [session](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html) this will happen automatically) and then set the [text](#text) or [attachments](#attachments). For proactive messages you’ll need save the [address](#address) from the incoming message to + * an external storage somewhere. You can then later pass this in to [UniversalBot.beginDialog()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.universalbot.html#begindialog) or copy it to an outgoing message passed to + * [UniversalBot.send()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.universalbot.html#send). + * + * Composing a message to the user using the incoming address object will by default send a reply to the user in the context of the current conversation. Some channels allow for the starting of new conversations with the user. To start a new proactive conversation with the user simply delete + * the [conversation](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iaddress.html#conversation) field from the address object before composing the outgoing message. + */ +export interface IMessage extends IEvent { + /** Timestamp of message given by chat service for incoming messages. */ + timestamp: string; + + /** Text to be displayed by as fall-back and as short description of the message content in e.g. list of recent conversations. */ + summary: string; + + /** Message text. */ + text: string; + + /** Identified language of the message text if known. */ + textLocale: string; + + /** For incoming messages contains attachments like images sent from the user. For outgoing messages contains objects like cards or images to send to the user. */ + attachments: IAttachment[]; + + /** Structured objects passed to the bot or user. */ + entities: any[]; + + /** Format of text fields. The default value is 'markdown'. */ + textFormat: string; + + /** Hint for how clients should layout multiple attachments. The default value is 'list'. */ + attachmentLayout: string; +} + +/** Implemented by classes that can be converted into a message. */ +export interface IIsMessage { + /** Returns the JSON object for the message. */ + toMessage(): IMessage; +} + +/** Represents a user, bot, or conversation. */ +export interface IIdentity { + /** Channel specific ID for this identity. */ + id: string; + + /** Friendly name for this identity. */ + name?: string; + + /** If true the identity is a group. Typically only found on conversation identities. */ + isGroup?: boolean; +} + +/** + * Address routing information for a [message](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.imessage.html#address). + * Addresses are bidirectional meaning they can be used to address both incoming and outgoing messages. They're also connector specific meaning that + * [connectors](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iconnector.html) are free to add their own fields. + */ +export interface IAddress { + /** Unique identifier for channel. */ + channelId: string; + + /** User that sent or should receive the message. */ + user: IIdentity; + + /** Bot that either received or is sending the message. */ + bot: IIdentity; + + /** + * Represents the current conversation and tracks where replies should be routed to. + * Can be deleted to start a new conversation with a [user](#user) on channels that support new conversations. + */ + conversation?: IIdentity; +} + +/** Chat connector specific address. */ +export interface IChatConnectorAddress extends IAddress { + /** Incoming Message ID. */ + id?: string; + + /** Specifies the URL to post messages back. */ + serviceUrl?: string; +} + +/** + * Many messaging channels provide the ability to attach richer objects. Bot Builder lets you express these attachments in a cross channel way and [connectors](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iconnector.html) will do their best to render the + * attachments using the channels native constructs. If you desire more control over the channels rendering of a message you can use [IEvent.sourceEvent](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ievent.html#sourceevent) to provide attachments using + * the channels native schema. The types of attachments that can be sent varies by channel but these are the basic types: + * + * * __Media and Files:__ Basic files can be sent by setting [contentType](#contenttype) to the MIME type of the file and then passing a link to the file in [contentUrl](#contenturl). + * * __Cards and Keyboards:__ A rich set of visual cards and custom keyboards can by setting [contentType](#contenttype) to the cards type and then passing the JSON for the card in [content](#content). If you use one of the rich card builder classes like + * [HeroCard](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.herocard.html) the attachment will automatically filled in for you. + */ +export interface IAttachment { + /** MIME type string which describes type of attachment. */ + contentType: string; + + /** (Optional) object structure of attachment. */ + content?: any; + + /** (Optional) reference to location of attachment content. */ + contentUrl?: string; +} + +/** Implemented by classes that can be converted into an attachment. */ +export interface IIsAttachment { + /** Returns the JSON object for the attachment. */ + toAttachment(): IAttachment; +} + +/** Displays a signin card and button to the user. Some channels may choose to render this as a text prompt and link to click. */ +export interface ISigninCard { + /** Title of the Card. */ + title: string; + + /** Sign in action. */ + buttons: ICardAction[]; +} + +/** + * Displays a card to the user using either a smaller thumbnail layout or larger hero layout (the attachments [contentType](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iattachment.html#contenttype) determines which). + * All of the cards fields are optional so this card can be used to specify things like a keyboard on certain channels. Some channels may choose to render a lower fidelity version of the card or use an alternate representation. + */ +export interface IThumbnailCard { + /** Title of the Card. */ + title?: string; + + /** Subtitle appears just below Title field, differs from Title in font styling only. */ + subtitle?: string; + + /** Text field appears just below subtitle, differs from Subtitle in font styling only. */ + text?: string; + + /** Messaging supports all media formats: audio, video, images and thumbnails as well to optimize content download. */ + images?: ICardImage[]; + + /** This action will be activated when user taps on the card. Not all channels support tap actions and some channels may choose to render the tap action as the titles link. */ + tap?: ICardAction; + + /** Set of actions applicable to the current card. Not all channels support buttons or cards with buttons. Some channels may choose to render the buttons using a custom keyboard. */ + buttons?: ICardAction[]; +} + +/** Displays a rich receipt to a user for something they've either bought or are planning to buy. */ +export interface IReceiptCard { + /** Title of the Card. */ + title: string; + + /** Array of receipt items. */ + items: IReceiptItem[]; + + /** Array of additional facts to display to user (shipping charges and such.) Not all facts will be displayed on all channels. */ + facts: IFact[]; + + /** This action will be activated when user taps on the card. Not all channels support tap actions. */ + tap: ICardAction; + + /** Total amount of money paid (or should be paid.) */ + total: string; + + /** Total amount of TAX paid (or should be paid.) */ + tax: string; + + /** Total amount of VAT paid (or should be paid.) */ + vat: string; + + /** Set of actions applicable to the current card. Not all channels support buttons and the number of allowed buttons varies by channel. */ + buttons: ICardAction[]; +} + +/** An individual item within a [receipt](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ireceiptcard.html). */ +export interface IReceiptItem { + /** Title of the item. */ + title: string; + + /** Subtitle appears just below Title field, differs from Title in font styling only. On some channels may be combined with the [title](#title) or [text](#text). */ + subtitle: string; + + /** Text field appears just below subtitle, differs from Subtitle in font styling only. */ + text: string; + + /** Image to display on the card. Some channels may either send the image as a seperate message or simply include a link to the image. */ + image: ICardImage; + + /** Amount with currency. */ + price: string; + + /** Number of items of given kind. */ + quantity: string; + + /** This action will be activated when user taps on the Item bubble. Not all channels support tap actions. */ + tap: ICardAction; +} + +/** Implemented by classes that can be converted into a receipt item. */ +export interface IIsReceiptItem { + /** Returns the JSON object for the receipt item. */ + toItem(): IReceiptItem; +} + +/** The action that should be performed when a card, button, or image is tapped. */ +export interface ICardAction { + /** Defines the type of action implemented by this button. Not all action types are supported by all channels. */ + type: string; + + /** Text description for button actions. */ + title?: string; + + /** Parameter for Action. Content of this property depends on Action type. */ + value: string; + + /** (Optional) Picture to display for button actions. Not all channels support button images. */ + image?: string; +} + +/** Implemented by classes that can be converted into a card action. */ +export interface IIsCardAction { + /** Returns the JSON object for the card attachment. */ + toAction(): ICardAction; +} + +/** An image on a card. */ +export interface ICardImage { + /** Thumbnail image for major content property. */ + url: string; + + /** Image description intended for screen readers. Not all channels will support alt text. */ + alt: string; + + /** Action assigned to specific Attachment. E.g. navigate to specific URL or play/open media content. Not all channels will support tap actions. */ + tap: ICardAction; +} + +/** Implemented by classes that can be converted into a card image. */ +export interface IIsCardImage { + /** Returns the JSON object for the card image. */ + toImage(): ICardImage; +} + +/** A fact displayed on a card like a [receipt](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ireceiptcard.html). */ +export interface IFact { + /** Display name of the fact. */ + key: string; + + /** Display value of the fact. */ + value: string; +} + +/** Implemented by classes that can be converted into a fact. */ +export interface IIsFact { + /** Returns the JSON object for the fact. */ + toFact(): IFact; +} + +/** Settings used to initialize an ILocalizer implementation. */ +interface IDefaultLocalizerSettings { + /** The path to the parent of the bot's locale directory */ + botLocalePath?: string; + + /** The default locale of the bot */ + defaultLocale?: string; +} + +/** Plugin for localizing messages sent to the user by a bot. */ +export interface ILocalizer { + /** + * Loads the localied table for the supplied locale, and call's the supplied callback once the load is complete. + * @param locale The locale to load. + * @param callback callback that is called once the supplied locale has been loaded, or an error if the load fails. + */ + load(locale: string, callback: (err: Error) => void): void; + + /** + * Loads a localized string for the specified language. + * @param locale Desired locale of the string to return. + * @param msgid String to use as a key in the localized string table. Typically this will just be the english version of the string. + * @param namespace (Optional) namespace for the msgid keys. + */ + trygettext(locale: string, msgid: string, namespace?: string): string; + + /** + * Loads a localized string for the specified language. + * @param locale Desired locale of the string to return. + * @param msgid String to use as a key in the localized string table. Typically this will just be the english version of the string. + * @param namespace (Optional) namespace for the msgid keys. + */ + gettext(locale: string, msgid: string, namespace?: string): string; + + /** + * Loads the plural form of a localized string for the specified language. + * @param locale Desired locale of the string to return. + * @param msgid Singular form of the string to use as a key in the localized string table. + * @param msgid_plural Plural form of the string to use as a key in the localized string table. + * @param count Count to use when determining whether the singular or plural form of the string should be used. + * @param namespace (Optional) namespace for the msgid and msgid_plural keys. + */ + ngettext(locale: string, msgid: string, msgid_plural: string, count: number, namespace?: string): string; +} + +/** Persisted session state used to track a conversations dialog stack. */ +export interface ISessionState { + /** Dialog stack for the current session. */ + callstack: IDialogState[]; + + /** Timestamp of when the session was last accessed. */ + lastAccess: number; + + /** Version number of the current callstack. */ + version: number; +} + +/** An entry on the sessions dialog stack. */ +export interface IDialogState { + /** ID of the dialog. */ + id: string; + + /** Persisted state for the dialog. */ + state: any; +} + +/** + * Results returned by a child dialog to its parent via a call to session.endDialog(). + */ +export interface IDialogResult { + /** The reason why the current dialog is being resumed. Defaults to {ResumeReason.completed} */ + resumed?: ResumeReason; + + /** ID of the child dialog thats ending. */ + childId?: string; + + /** If an error occured the child dialog can return the error to the parent. */ + error?: Error; + + /** The users response. */ + response?: T; +} + +/** Context of the received message passed to the Dialog.recognize() method. */ +export interface IRecognizeContext { + /** Message that was received. */ + message: IMessage; + + /** The users preferred locale for the message. */ + locale: string; + + /** If true the Dialog is the active dialog on the callstack. */ + activeDialog: boolean; + + /** Data persisted for the current dialog. */ + dialogData: any; +} + +/** Results from a call to a recognize() function. The implementation is free to add any additional properties to the result. */ +export interface IRecognizeResult { + /** Confidence that the users utterance was understood on a scale from 0.0 - 1.0. */ + score: number; +} + +/** Options passed when binding a dialog action handler. */ +export interface IDialogActionOptions { + /** (Optional) regular expression that should be matched against the users utterance to trigger an action. If this is ommitted the action can only be invoked from a button. */ + matches?: RegExp; + + /** Minimum score needed to trigger the action using the value of [expression](#expression). The default value is 0.1. */ + intentThreshold?: number; + + /** (Optional) arguments to pass to the dialog spawned when the action is triggered. */ + dialogArgs?: any; +} + +/** Results for a recognized dialog action. */ +export interface IRecognizeActionResult extends IRecognizeResult { + /** Named dialog action that was matched. */ + action?: string; + + /** A regular expression that was matched. */ + expression?: RegExp; + + /** The results of the [expression](#expression) that was matched. matched[0] will be the text that was matched and matched[1...n] is the result of capture groups. */ + matched?: string[]; + + /** Optional data passed as part of the action binding. */ + data?: string; + + /** ID of the dialog the action is bound to. */ + dialogId?: string; + + /** Index on the dialog stack of the dialog the action is bound to. */ + dialogIndex?: number; +} + +/** Options passed to built-in prompts. */ +export interface IPromptOptions { + /** + * (Optional) retry prompt to send if the users response isn't understood. Default is to just + * reprompt with the configured [defaultRetryPrompt](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ipromptsoptions.html#defaultretryprompt) + * plus the original prompt. + * + * Note that if the original prompt is an _IMessage_ the retry prompt will be sent as a seperate + * message followed by the original message. If the retryPrompt is also an _IMessage_ it will + * instead be sent in place of the original message. + * * _{string}_ - Initial message to send the user. + * * _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * _{IMessage}_ - Initial message to send the user. Message can contain attachments. + * * _{IIsMessage}_ - Instance of the [Message](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.message.html) builder class. + */ + retryPrompt?: string|string[]|IMessage|IIsMessage; + + /** (Optional) maximum number of times to reprompt the user. By default the user will be reprompted indefinitely. */ + maxRetries?: number; + + /** (Optional) reference date when recognizing times. Date expressed in ticks using Date.getTime(). */ + refDate?: number; + + /** (Optional) type of list to render for PromptType.choice. Default value is ListStyle.auto. */ + listStyle?: ListStyle; + + /** (Optional) flag used to control the reprompting of a user after a dialog started by an action ends. The default value is true. */ + promptAfterAction?: boolean; + + /** (Optional) namespace to use when localizing a passed in prompt. */ + localizationNamespace?: string; +} + +/** Arguments passed to the built-in prompts beginDialog() call. */ +export interface IPromptArgs extends IPromptOptions { + /** Type of prompt invoked. */ + promptType: PromptType; + + /** + * Initial message to send to user. + * * _{string}_ - Initial message to send the user. + * * _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * _{IMessage}_ - Initial message to send the user. Message can contain attachments. + * * _{IIsMessage}_ - Instance of the [Message](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.message.html) builder class. + */ + prompt: string|string[]|IMessage|IIsMessage; + + /** Enum values for a choice prompt. */ + enumsValues?: string[]; +} + +/** Dialog result returned by a system prompt. */ +export interface IPromptResult extends IDialogResult { + /** Type of prompt completing. */ + promptType?: PromptType; +} + +/** Result returned from an IPromptRecognizer. */ +export interface IPromptRecognizerResult extends IPromptResult { + /** Returned from a prompt recognizer to indicate that a parent dialog handled (or captured) the utterance. */ + handled?: boolean; +} + +/** Strongly typed Text Prompt Result. */ +export interface IPromptTextResult extends IPromptResult { } + +/** Strongly typed Number Prompt Result. */ +export interface IPromptNumberResult extends IPromptResult { } + +/** Strongly typed Confirm Prompt Result. */ +export interface IPromptConfirmResult extends IPromptResult { } + +/** Strongly typed Choice Prompt Result. */ +export interface IPromptChoiceResult extends IPromptResult { } + +/** Strongly typed Time Prompt Result. */ +export interface IPromptTimeResult extends IPromptResult { } + +/** Strongly typed Attachment Prompt Result. */ +export interface IPromptAttachmentResult extends IPromptResult { } + +/** Plugin for recognizing prompt responses received by a user. */ +export interface IPromptRecognizer { + /** + * Attempts to match a users reponse to a given prompt. + * @param args Arguments passed to the recognizer including that language, text, and prompt choices. + * @param callback Function to invoke with the result of the recognition attempt. + * @param callback.result Returns the result of the recognition attempt. + */ + recognize(args: IPromptRecognizerArgs, callback: (result: IPromptRecognizerResult) => void): void; +} + +/** Arguments passed to the IPromptRecognizer.recognize() method.*/ +export interface IPromptRecognizerArgs { + /** Type of prompt being responded to. */ + promptType: PromptType; + + /** Text of the users response to the prompt. */ + text: string; + + /** Language of the text if known. */ + language?: string; + + /** For choice prompts the list of possible choices. */ + enumValues?: string[]; + + /** (Optional) reference date when recognizing times. */ + refDate?: number; +} + +/** Global configuration options for the Prompts dialog. */ +export interface IPromptsOptions { + /** Replaces the default recognizer (SimplePromptRecognizer) used to recognize prompt replies. */ + recognizer?: IPromptRecognizer +} + +/** A recognized intent. */ +export interface IIntent { + /** Intent that was recognized. */ + intent: string; + + /** Confidence on a scale from 0.0 - 1.0 that the proper intent was recognized. */ + score: number; +} + +/** A recognized entity. */ +export interface IEntity { + /** Type of entity that was recognized. */ + type: string; + + /** Value of the recognized entity. */ + entity: string; + + /** Start position of entity within text utterance. */ + startIndex?: number; + + /** End position of entity within text utterance. */ + endIndex?: number; + + /** Confidence on a scale from 0.0 - 1.0 that the proper entity was recognized. */ + score?: number; +} + +/** Options used to configure an [IntentDialog](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.intentdialog.html). */ +export interface IIntentDialogOptions { + /** Minimum score needed to trigger the recognition of an intent. The default value is 0.1. */ + intentThreshold?: number; + + /** Controls the dialogs processing of incomming user utterances. The default is RecognizeMode.onBeginIfRoot. The default prior to v3.2 was RecognizeMode.onBegin. */ + recognizeMode?: RecognizeMode; + + /** The order in which the configured [recognizers](#recognizers) should be evaluated. The default order is parallel. */ + recognizeOrder?: RecognizeOrder; + + /** (Optional) list of intent recognizers to run the users utterance through. */ + recognizers?: IIntentRecognizer[]; + + /** Maximum number of recognizers to evaluate at one time when [recognizerOrder](#recognizerorder) is parallel. */ + processLimit?: number; +} + +/** export interface implemented by intent recognizers like the LuisRecognizer class. */ +export interface IIntentRecognizer { + /** Attempts to match a users text utterance to an intent. */ + recognize(context: IRecognizeContext, callback: (err: Error, result: IIntentRecognizerResult) => void): void; +} + +/** Results returned by an intent recognizer. */ +export interface IIntentRecognizerResult extends IRecognizeResult { + /** Top intent that was matched. */ + intent: string; + + /** A regular expression that was matched. */ + expression?: RegExp; + + /** The results of the [expression](#expression) that was matched. matched[0] will be the text that was matched and matched[1...n] is the result of capture groups. */ + matched?: string[]; + + /** Full list of intents that were matched. */ + intents?: IIntent[]; + + /** List of entities recognized. */ + entities?: IEntity[]; +} + +/** Options passed to the constructor of a session. */ +export interface ISessionOptions { + /** Function to invoke when the sessions state is saved. */ + onSave: (done: (err: Error) => void) => void; + + /** Function to invoke when a batch of messages are sent. */ + onSend: (messages: IMessage[], done: (err: Error) => void) => void; + + /** The bots root library of dialogs. */ + library: Library; + + /** The localizer to use for the session. */ + localizer: ILocalizer; + + /** Array of session middleware to execute prior to each request. */ + middleware: ISessionMiddleware[]; + + /** Unique ID of the dialog to use when starting a new conversation with a user. */ + dialogId: string; + + /** (Optional) arguments to pass to the conversations initial dialog. */ + dialogArgs?: any; + + /** (Optional) time to allow between each message sent as a batch. The default value is 250ms. */ + autoBatchDelay?: number; + + /** Default error message to send users when a dialog error occurs. */ + dialogErrorMessage?: string|string[]|IMessage|IIsMessage; + + /** Global actions registered for the bot. */ + actions?: ActionSet; +} + +/** result returnd from a call to EntityRecognizer.findBestMatch() or EntityRecognizer.findAllMatches(). */ +export interface IFindMatchResult { + /** Index of the matched value. */ + index: number; + + /** Value that was matched. */ + entity: string; + + /** Confidence score on a scale from 0.0 - 1.0 that an value matched the users utterance. */ + score: number; +} + +/** Context object passed to IBotStorage calls. */ +export interface IBotStorageContext { + /** (Optional) ID of the user being persisted. If missing __userData__ won't be persisted. */ + userId?: string; + + /** (Optional) ID of the conversation being persisted. If missing __conversationData__ and __privateConversationData__ won't be persisted. */ + conversationId?: string; + + /** (Optional) Address of the message received by the bot. */ + address?: IAddress; + + /** If true IBotStorage should persist __userData__. */ + persistUserData: boolean; + + /** If true IBotStorage should persist __conversationData__. */ + persistConversationData: boolean; +} + +/** Data values persisted to IBotStorage. */ +export interface IBotStorageData { + /** The bots data about a user. This data is global across all of the users conversations. */ + userData?: any; + + /** The bots shared data for a conversation. This data is visible to every user within the conversation. */ + conversationData?: any; + + /** + * The bots private data for a conversation. This data is only visible to the given user within the conversation. + * The session stores its session state using privateConversationData so it should always be persisted. + */ + privateConversationData?: any; +} + +/** Replacable storage system used by UniversalBot. */ +export interface IBotStorage { + /** Reads in data from storage. */ + getData(context: IBotStorageContext, callback: (err: Error, data: IBotStorageData) => void): void; + + /** Writes out data to storage. */ + saveData(context: IBotStorageContext, data: IBotStorageData, callback?: (err: Error) => void): void; +} + +/** Options used to initialize a ChatConnector instance. */ +export interface IChatConnectorSettings { + /** The bots App ID assigned in the Bot Framework portal. */ + appId?: string; + + /** The bots App Password assigned in the Bot Framework Portal. */ + appPassword?: string; + + /** If true the bots userData, privateConversationData, and conversationData will be gzipped prior to writing to storage. */ + gzipData?: boolean; +} + +/** Options used to initialize a UniversalBot instance. */ +export interface IUniversalBotSettings { + /** (Optional) dialog to launch when a user initiates a new conversation with a bot. Default value is '/'. */ + defaultDialogId?: string; + + /** (Optional) arguments to pass to the initial dialog for a conversation. */ + defaultDialogArgs?: any; + + /** (Optional) settings used to configure the frameworks built in default localizer. */ + localizerSettings?: IDefaultLocalizerSettings; + + /** (Optional) function used to map the user ID for an incoming message to another user ID. This can be used to implement user account linking. */ + lookupUser?: (address: IAddress, done: (err: Error, user: IIdentity) => void) => void; + + /** (Optional) maximum number of async options to conduct in parallel. */ + processLimit?: number; + + /** (Optional) time to allow between each message sent as a batch. The default value is 150ms. */ + autoBatchDelay?: number; + + /** (Optional) storage system to use for storing user & conversation data. */ + storage?: IBotStorage; + + /** (optional) if true userData will be persisted. The default value is true. */ + persistUserData?: boolean; + + /** (Optional) if true shared conversationData will be persisted. The default value is false. */ + persistConversationData?: boolean; + + /** (Optional) message to send the user should an unexpected error occur during a conversation. A default message is provided. */ + dialogErrorMessage?: string|string[]|IMessage|IIsMessage; +} + +/** Implemented by connector plugins for the UniversalBot. */ +export interface IConnector { + /** Called by the UniversalBot at registration time to register a handler for receiving incoming events from a channel. */ + onEvent(handler: (events: IEvent[], callback?: (err: Error) => void) => void): void; + + /** Called by the UniversalBot to deliver outgoing messages to a user. */ + send(messages: IMessage[], callback: (err: Error) => void): void; + + /** Called when a UniversalBot wants to start a new proactive conversation with a user. The connector should return a properly formated __address__ object with a populated __conversation__ field. */ + startConversation(address: IAddress, callback: (err: Error, address?: IAddress) => void): void; +} + +/** Function signature for a piece of middleware that hooks the 'receive' or 'send' events. */ +export interface IEventMiddleware { + (event: IEvent, next: Function): void; +} + +/** Function signature for a piece of middleware that hooks the 'botbuilder' event. */ +export interface ISessionMiddleware { + (session: Session, next: Function): void; +} + +/** + * Map of middleware hooks that can be registered in a call to __UniversalBot.use()__. + */ +export interface IMiddlewareMap { + /** Called in series when an incoming event is received. */ + receive?: IEventMiddleware|IEventMiddleware[]; + + /** Called in series before an outgoing event is sent. */ + send?: IEventMiddleware|IEventMiddleware[]; + + /** Called in series once an incoming message has been bound to a session. Executed after [receive](#receive) middleware. */ + botbuilder?: ISessionMiddleware|ISessionMiddleware[]; +} + +/** + * Signature for functions passed as steps to [DialogAction.waterfall()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.dialogaction.html#waterfall). + * + * Waterfalls let you prompt a user for information using a sequence of questions. Each step of the + * waterfall can either execute one of the built-in [Prompts](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.prompts.html), + * start a new dialog by calling [session.beginDialog()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#begindialog), + * advance to the next step of the waterfall manually using `skip()`, or terminate the waterfall. + * + * When either a dialog or built-in prompt is called from a waterfall step, the results from that + * dialog or prompt will be passed via the `results` parameter to the next step of the waterfall. + * Users can say things like "nevermind" to cancel the built-in prompts so you should guard against + * that by at least checking for [results.response](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogresult.html#response) + * before proceeding. A more detailed explination of why the waterfall is being continued can be + * determined by looking at the [code](/en-us/node/builder/chat-reference/enums/_botbuilder_d_.resumereason.html) + * returned for [results.resumed](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogresult.html#resumed). + * + * You can manually advance to the next step of the waterfall using the `skip()` function passed + * in. Calling `skip({ response: "some text" })` with an [IDialogResult](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogresult.html) + * lets you more accurately mimic the results from a built-in prompt and can simplify your overall + * waterfall logic. + * + * You can terminate a waterfall early by either falling through every step of the waterfall using + * calls to `skip()` or simply not starting another prompt or dialog. + * + * __note:__ Waterfalls have a hidden last step which will automatically end the current dialog if + * if you call a prompt or dialog from the last step. This is useful where you have a deep stack of + * dialogs and want a call to [session.endDialog()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#enddialog) + * from the last child on the stack to end the entire stack. The close of the last child will trigger + * all of its parents to move to this hidden step which will cascade the close all the way up the stack. + * This is typically a desired behaviour but if you want to avoid it or stop it somewhere in the + * middle you'll need to add a step to the end of your waterfall that either does nothing or calls + * something liek [session.send()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#send) + * which isn't going to advance the waterfall forward. + * @example + * 

+ * var bot = new builder.BotConnectorBot();
+ * bot.add('/', [
+ *     function (session) {
+ *         builder.Prompts.text(session, "Hi! What's your name?");
+ *     },
+ *     function (session, results) {
+ *         if (results && results.response) {
+ *             // User answered question.
+ *             session.send("Hello %s.", results.response);
+ *         } else {
+ *             // User said nevermind.
+ *             session.send("OK. Goodbye.");
+ *         }
+ *     }
+ * ]);
+ *
+ */ +export interface IDialogWaterfallStep { + /** + * @param session Session object for the current conversation. + * @param result + * * __result:__ _{any}_ - For the first step of the waterfall this will be `null` or the value of any arguments passed to the handler. + * * __result:__ _{IDialogResult}_ - For subsequent waterfall steps this will be the result of the prompt or dialog called in the previous step. + * @param skip Fuction used to manually skip to the next step of the waterfall. + * @param skip.results (Optional) results to pass to the next waterfall step. This lets you more accurately mimic the results returned from a prompt or dialog. + */ + (session: Session, result?: any | IDialogResult, skip?: (results?: IDialogResult) => void): any; +} + +/** A per/local mapping of LUIS service url's to use for a LuisRecognizer. */ +export interface ILuisModelMap { + [local: string]: string; +} + +/** A per/source mapping of custom event data to send. */ +export interface ISourceEventMap { + [source: string]: any; +} + +/** Options passed to Middleware.dialogVersion(). */ +export interface IDialogVersionOptions { + /** Current major.minor version for the bots dialogs. Major version increments result in existing conversations between the bot and user being restarted. */ + version: number; + + /** Optional message to send the user when their conversation is ended due to a version number change. A default message is provided. */ + message?: string|string[]|IMessage|IIsMessage; + + /** Optional regular expression to listen for to manually detect a request to reset the users session state. */ + resetCommand?: RegExp; +} + +/** Options passed to Middleware.firstRun(). */ +export interface IFirstRunOptions { + /** Current major.minor version for the bots first run experience. Major version increments result in redirecting users to [dialogId](#dialogid) and minor increments redirect users to [upgradeDialogId](#upgradedialogid). */ + version: number; + + /** Dialog to redirect users to when the major [version](#version) changes. */ + dialogId: string; + + /** (Optional) args to pass to [dialogId](#dialogid). */ + dialogArgs?: any; + + /** (Optional) dialog to redirect users to when the minor [version](#version) changes. Useful for minor Terms of Use changes. */ + upgradeDialogId?: string; + + /** (Optional) args to pass to [upgradeDialogId](#upgradedialogid). */ + upgradeDialogArgs?: string; +} + +//============================================================================= +// +// ENUMS +// +//============================================================================= + +/** Reason codes for why a dialog was resumed. */ +export enum ResumeReason { + /** The user completed the child dialog and a result was returned. */ + completed, + + /** The user did not complete the child dialog for some reason. They may have exceeded maxRetries or canceled. */ + notCompleted, + + /** The dialog was canceled in response to some user initiated action. */ + canceled, + + /** The user requested to return to the previous step in a dialog flow. */ + back, + + /** The user requested to skip the current step of a dialog flow. */ + forward +} + +/** Order in which an [IntentDialogs](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.intentdialog.html) recognizers should be evaluated. */ +export enum RecognizeOrder { + /** All recognizers will be evaluated in parallel. */ + parallel, + + /** Recognizers will be evaluated in series. Any recognizer that returns a score of 1.0 will prevent the evaluation of the remaining recognizers. */ + series +} + +/** Controls an [IntentDialogs](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.intentdialog.html) processing of the users text utterances. */ +export enum RecognizeMode { + /** Process text utterances whenever the dialog is first loaded through a call to session.beginDialog() and anytime a reply from the user is received. This was the default behaviour prior to version 3.2. */ + onBegin, + + /** Processes text utterances anytime a reply is received but only when the dialog is first loaded if it's the root dialog. This is the default behaviour as of 3.2. */ + onBeginIfRoot, + + /** Only process text utterances when a reply is received. */ + onReply +} + +/** + * Type of prompt invoked. + */ +export enum PromptType { + /** The user is prompted for a string of text. */ + text, + + /** The user is prompted to enter a number. */ + number, + + /** The user is prompted to confirm an action with a yes/no response. */ + confirm, + + /** The user is prompted to select from a list of choices. */ + choice, + + /** The user is prompted to enter a time. */ + time, + + /** The user is prompted to upload an attachment. */ + attachment +} + +/** Type of list to render for PromptType.choice prompt. */ +export enum ListStyle { + /** No list is rendered. This is used when the list is included as part of the prompt. */ + none, + + /** Choices are rendered as an inline list of the form "1. red, 2. green, or 3. blue". */ + inline, + + /** Choices are rendered as a numbered list. */ + list, + + /** Choices are rendered as buttons for channels that support buttons. For other channels they will be rendered as text. */ + button, + + /** The style is selected automatically based on the channel and number of options. */ + auto +} + +/** Identifies the type of text being sent in a message. */ +export var TextFormat: { + /** Text fields should be treated as plain text. */ + plain: string; + + /** Text fields may contain markdown formatting information. */ + markdown: string; + + /** Text fields may contain xml formatting information. */ + xml: string; +}; + +/** Identities how the client should render attachments for a message. */ +export var AttachmentLayout: { + /** Attachments should be rendred as a list. */ + list: string; + + /** Attachments should be rendered as a carousel. */ + carousel: string; +}; + + +//============================================================================= +// +// CLASSES +// +//============================================================================= + +/** + * Manages the bots conversation with a user. + */ +export class Session { + /** + * Registers an event listener. + * @param event Name of the event. Event types: + * - __error:__ An error occured. Passes a JavaScript `Error` object. + * @param listener Function to invoke. + * @param listener.data The data for the event. Consult the list above for specific types of data you can expect to receive. + */ + on(event: string, listener: (data: any) => void): void; + + /** + * Creates an instance of the session. + * @param options Sessions configuration options. + */ + constructor(options: ISessionOptions); + + /** + * Dispatches a message for processing. The session will call any installed middleware before + * the message to the active dialog for processing. + * @param sessionState The current session state. If _null_ a new conversation will be started beginning with the configured [dialogId](#dialogid). + * @param message The message to dispatch. + */ + dispatch(sessionState: ISessionState, message: IMessage): Session; + + /** The bots root library of dialogs. */ + library: Library; + + /** Sessions current state information. */ + sessionState: ISessionState; + + /** The message received from the user. For bot originated messages this may only contain the "to" & "from" fields. */ + message: IMessage; + + /** Data for the user that's persisted across all conversations with the bot. */ + userData: any; + + /** Shared conversation data that's visible to all members of the conversation. */ + conversationData: any; + + /** Private conversation data that's only visible to the user. */ + privateConversationData: any; + + /** Data that's only visible to the current dialog. */ + dialogData: any; + + /** The localizer (if available) to use. */ + localizer:ILocalizer ; + + /** + * Signals that an error occured. The bot will signal the error via an on('error', err) event. + * @param err Error that occured. + */ + error(err: Error): Session; + + /** + * Returns the preferred locale when no parameters are supplied, otherwise sets the preferred locale. + * @param locale (Optional) the locale to use for localizing messages. + * @param callback (Optional) function called when the localization table has been loaded for the supplied locale. + */ + preferredLocale(locale?: string, callback?: (err: Error) => void): string; + + /** + * Loads a localized string for the messages language. If arguments are passed the localized string + * will be treated as a template and formatted using [sprintf-js](https://github.com/alexei/sprintf.js) (see their docs for details.) + * @param msgid String to use as a key in the localized string table. Typically this will just be the english version of the string. + * @param args (Optional) arguments used to format the final output string. + */ + gettext(msgid: string, ...args: any[]): string; + + /** + * Loads the plural form of a localized string for the messages language. The output string will be formatted to + * include the count by replacing %d in the string with the count. + * @param msgid Singular form of the string to use as a key in the localized string table. Use %d to specify where the count should go. + * @param msgid_plural Plural form of the string to use as a key in the localized string table. Use %d to specify where the count should go. + * @param count Count to use when determining whether the singular or plural form of the string should be used. + */ + ngettext(msgid: string, msgid_plural: string, count: number): string; + + /** Triggers saving of changes made to [dialogData](#dialogdata), [userData](#userdata), [conversationdata](#conversationdata), or [privateConversationData'(#privateconversationdata). */ + save(): Session; + + /** + * Sends a message to the user. + * @param message + * * __message:__ _{string}_ - Text of the message to send. The message will be localized using the sessions configured localizer. If arguments are passed in the message will be formatted using [sprintf-js](https://github.com/alexei/sprintf.js). + * * __message:__ _{string[]}_ - The sent message will be chosen at random from the array. + * * __message:__ _{IMessage|IIsMessage}_ - Message to send. + * @param args (Optional) arguments used to format the final output text when __message__ is a _{string|string[]}_. + */ + send(message: string|string[]|IMessage|IIsMessage, ...args: any[]): Session; + + /** + * Sends the user an indication that the bot is typing. For long running operations this should be called every few seconds. + */ + sendTyping(): Session; + + /** + * Returns true if a message has been sent for this session. + */ + messageSent(): boolean; + + /** + * Passes control of the conversation to a new dialog. The current dialog will be suspended + * until the child dialog completes. Once the child ends the current dialog will receive a + * call to [dialogResumed()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.dialog.html#dialogresumed) + * where it can inspect any results returned from the child. + * @param id Unique ID of the dialog to start. + * @param args (Optional) arguments to pass to the dialogs [begin()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.dialog.html#begin) method. + */ + beginDialog(id: string, args?: T): Session; + + /** + * Ends the current dialog and starts a new one its place. The parent dialog will not be + * resumed until the new dialog completes. + * @param id Unique ID of the dialog to start. + * @param args (Optional) arguments to pass to the dialogs [begin()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.dialog.html#begin) method. + */ + replaceDialog(id: string, args?: T): Session; + + /** + * Ends the current conversation and optionally sends a message to the user. + * @param message (Optional) + * * __message:__ _{string}_ - Text of the message to send. The message will be localized using the sessions configured localizer. If arguments are passed in the message will be formatted using [sprintf-js](https://github.com/alexei/sprintf.js). + * * __message:__ _{string[]}_ - The sent message will be chosen at random from the array. + * * __message:__ _{IMessage|IIsMessage}_ - Message to send. + * @param args (Optional) arguments used to format the final output text when __message__ is a _{string|string[]}_. + */ + endConversation(message?: string|string[]|IMessage|IIsMessage, ...args: any[]): Session; + + /** + * Ends the current dialog and optionally sends a message to the user. The parent will be resumed with an [IDialogResult.resumed](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogresult.html#resumed) + * reason of [completed](/en-us/node/builder/chat-reference/enums/_botbuilder_d_.resumereason.html#completed). + * @param message (Optional) + * * __message:__ _{string}_ - Text of the message to send. The message will be localized using the sessions configured localizer. If arguments are passed in the message will be formatted using [sprintf-js](https://github.com/alexei/sprintf.js). + * * __message:__ _{string[]}_ - The sent message will be chosen at random from the array. + * * __message:__ _{IMessage|IIsMessage}_ - Message to send. + * @param args (Optional) arguments used to format the final output text when __message__ is a _{string|string[]}_. + */ + endDialog(message?: string|string[]|IMessage|IIsMessage, ...args: any[]): Session; + + /** + * Ends the current dialog and optionally returns a result to the dialogs parent. + */ + endDialogWithResult(result?: IDialogResult): Session; + + /** + * Cancels an existing dialog and optionally starts a new one it its place. Unlike [endDialog()](#enddialog) + * and [replaceDialog()](#replacedialog) which affect the current dialog, this method lets you end a + * parent dialog anywhere on the stack. The parent of the canceled dialog will be continued as if the + * dialog had called endDialog(). A special [ResumeReason.canceled](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.resumereason#canceled) + * will be returned to indicate that the dialog was canceled. + * @param dialogId + * * __dialogId:__ _{string}_ - ID of the dialog to end. If multiple occurences of the dialog exist on the dialog stack, the last occurance will be canceled. + * * __dialogId:__ _{number}_ - Index of the dialog on the stack to cancel. This is the preferred way to cancel a dialog from an action handler as it ensures that the correct instance is canceled. + * @param replaceWithId (Optional) specifies an ID to start in the canceled dialogs place. This prevents the dialogs parent from being resumed. + * @param replaceWithArgs (Optional) arguments to pass to the new dialog. + */ + cancelDialog(dialogId: string|number, replaceWithId?: string, replaceWithArgs?: any): Session; + + /** + * Clears the sessions callstack and restarts the conversation with the configured dialogId. + * @param dialogId (Optional) ID of the dialog to start. + * @param dialogArgs (Optional) arguments to pass to the dialogs [begin()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.dialog.html#begin) method. + */ + reset(dialogId?: string, dialogArgs?: any): Session; + + /** Returns true if the session has been reset. */ + isReset(): boolean; + + /** + * Immediately ends the current batch and delivers any queued up messages. + * @param callback (Optional) function called when the batch was either successfully delievered or failed for some reason. + */ + sendBatch(callback?: (err: Error) => void): void; +} + +/** + * Message builder class that simplifies building complex messages with attachments. + */ +export class Message implements IIsMessage { + + /** + * Creates a new Message builder. + * @param session (Optional) will be used to populate the messages address and localize any text. + */ + constructor(session?: Session); + + /** Language of the message. */ + textLocale(locale: string): Message; + + /** Format of text fields. */ + textFormat(style: string): Message; + + /** Sets the message text. */ + text(text: string|string[], ...args: any[]): Message; + + /** Conditionally set this message text given a specified count. */ + ntext(msg: string|string[], msg_plural: string|string[], count: number): Message; + + /** Composes a complex and randomized reply to the user. */ + compose(prompts: string[][], ...args: any[]): Message; + + /** Text to be displayed by as fall-back and as short description of the message content in e.g. list of recent conversations. */ + summary(text: string|string[], ...args: any[]): Message; + + /** Hint for how clients should layout multiple attachments. The default value is 'list'. */ + attachmentLayout(style: string): Message; + + /** Cards or images to send to the user. */ + attachments(list: IAttachment[]|IIsAttachment[]): Message; + + /** + * Adds an attachment to the message. See [IAttachment](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iattachment.html) for examples. + * @param attachment The attachment to add. + */ + addAttachment(attachment: IAttachment|IIsAttachment): Message; + + /** Structured objects passed to the bot or user. */ + entities(list: Object[]): Message; + + /** Adds an entity to the message. */ + addEntity(obj: Object): Message; + + /** Address routing information for the message. Save this field to external storage somewhere to later compose a proactive message to the user. */ + address(adr: IAddress): Message; + + /** Timestamp of the message. If called will default the timestamp to (now). */ + timestamp(time?: string): Message; + + /** Message in original/native format of the channel for incoming messages. */ + originalEvent(event: any): Message; + + /** For outgoing messages can be used to pass source specific event data like custom attachments. */ + sourceEvent(map: ISourceEventMap): Message; + + /** Returns the JSON for the message. */ + toMessage(): IMessage; + + /** __DEPRECATED__ use [local()](#local) instead. */ + setLanguage(language: string): Message; + + /** __DEPRECATED__ use [text()](#text) instead. */ + setText(session: Session, prompt: string|string[], ...args: any[]): Message; + + /** __DEPRECATED__ use [ntext()](#ntext) instead. */ + setNText(session: Session, msg: string, msg_plural: string, count: number): Message; + + /** __DEPRECATED__ use [compose()](#compose) instead. */ + composePrompt(session: Session, prompts: string[][], ...args: any[]): Message; + + /** __DEPRECATED__ use [sourceEvent()](#sourceevent) instead. */ + setChannelData(data: any): Message; + + /** + * Selects a prompt at random. + * @param prompts Array of prompts to choose from. When prompts is type _string_ the prompt will simply be returned unmodified. + */ + static randomPrompt(prompts: string|string[]): string; + + /** + * Combines an array of prompts into a single localized prompt and then optionally fills the + * prompts template slots with the passed in arguments. + * @param session Session object used to localize the individual prompt parts. + * @param prompts Array of prompt lists. Each entry in the array is another array of prompts + * which will be chosen at random. The combined output text will be space delimited. + * @param args (Optional) array of arguments used to format the output text when the prompt is a template. + */ + static composePrompt(session: Session, prompts: string[][], args?: any[]): string; +} + +/** Builder class to simplify adding actions to a card. */ +export class CardAction implements IIsCardAction { + + /** + * Creates a new CardAction. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); + + /** Type of card action. */ + type(t: string): CardAction; + + /** Title of the action. For buttons this will be the label of the button. For tap actions this may be used for accesibility purposes or shown on hover. */ + title(text: string|string[], ...args: any[]): CardAction; + + /** The actions value. */ + value(v: string): CardAction; + + /** For buttons an image to include next to the buttons label. Not supported by all channels. */ + image(url: string): CardAction; + + /** Returns the JSON for the action. */ + toAction(): ICardAction; + + /** + * Places a call to a phone number. The should include country code in +44/+1 format for Skype calls. + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static call(session: Session, number: string, title?: string|string[]): CardAction; + + /** + * Opens the specified URL. + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static openUrl(session: Session, url: string, title?: string|string[]): CardAction; + + /** + * Sends a message to the bot for processing in a way that's visible to all members of the conversation. For some channels this may get mapped to a [postBack](#postback). + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static imBack(session: Session, msg: string, title?: string|string[]): CardAction; + + /** + * Sends a message to the bot for processing in a way that's hidden from all members of the conversation. For some channels this may get mapped to a [imBack](#imback). + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static postBack(session: Session, msg: string, title?: string|string[]): CardAction; + + /** + * Plays the specified audio file to the user. Not currently supported for Skype. + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static playAudio(session: Session, url: string, title?: string|string[]): CardAction; + + /** + * Plays the specified video to the user. Not currently supported for Skype. + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static playVideo(session: Session, url: string, title?: string|string[]): CardAction; + + /** + * Opens the specified image in a native image viewer. For Skype only valid as a tap action on a CardImage. + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static showImage(session: Session, url: string, title?: string|string[]): CardAction; + + /** + * Downloads the specified file to the users device. Not currently supported for Skype. + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + */ + static downloadFile(session: Session, url: string, title?: string|string[]): CardAction; + + /** + * Binds a button or tap action to a named action registered for a dialog or globally off the bot. + * + * Can be used anywhere a [postBack](#postback) is valid. You may also statically bind a button + * to an action for something like Facebooks [Persistent Menus](https://developers.facebook.com/docs/messenger-platform/thread-settings/persistent-menu). + * The payload for the button should be `action?` for actions without data or + * `action?=` for actions with data. + * @param session (Optional) Current session object for the conversation. If specified will be used to localize titles. + * @param action Name of the action to invoke when tapped. + * @param data (Optional) data to pass to the action when invoked. The [IRecognizeActionResult.data](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.irecognizeactionresult#data) + * property can be used to access this data. If using [beginDialogAction()](dlg./en-us/node/builder/chat-reference/classes/_botbuilder_d_.dialog#begindialogaction) this value will be passed + * as part of the dialogs initial arguments. + * @param title (Optional) title to assign when binding the action to a button. + */ + static dialogAction(session: Session, action: string, data?: string, title?: string|string[]): CardAction; +} + +/** Builder class to simplify adding images to a card. */ +export class CardImage implements IIsCardImage { + + /** + * Creates a new CardImage. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); + + /** URL of the image to display. */ + url(u: string): CardImage; + + /** Alternate text of the image to use for accessibility pourposes. */ + alt(text: string|string[], ...args: any[]): CardImage; + + /** Action to take when the image is tapped. */ + tap(action: ICardAction|IIsCardAction): CardImage; + + /** Returns the JSON for the image. */ + toImage(): ICardImage; + + /** Creates a new CardImage for a given url. */ + static create(session: Session, url: string): CardImage; +} + +/** Card builder class that simplifies building thumbnail cards. */ +export class ThumbnailCard implements IIsAttachment { + + /** + * Creates a new ThumbnailCard. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); + + /** Title of the Card. */ + title(text: string|string[], ...args: any[]): ThumbnailCard; + + /** Subtitle appears just below Title field, differs from Title in font styling only. */ + subtitle(text: string|string[], ...args: any[]): ThumbnailCard; + + /** Text field appears just below subtitle, differs from Subtitle in font styling only. */ + text(text: string|string[], ...args: any[]): ThumbnailCard; + + /** Messaging supports all media formats: audio, video, images and thumbnails as well to optimize content download. */ + images(list: ICardImage[]|IIsCardImage[]): ThumbnailCard; + + /** Set of actions applicable to the current card. Not all channels support buttons or cards with buttons. Some channels may choose to render the buttons using a custom keyboard. */ + buttons(list: ICardAction[]|IIsCardAction[]): ThumbnailCard; + + /** This action will be activated when user taps on the card. Not all channels support tap actions and some channels may choose to render the tap action as the titles link. */ + tap(action: ICardAction|IIsCardAction): ThumbnailCard; + + /** Returns the JSON for the card, */ + toAttachment(): IAttachment; +} + +/** Card builder class that simplifies building hero cards. Hero cards contain the same information as a thumbnail card, just with a larger more pronounced layout for the cards images. */ +export class HeroCard extends ThumbnailCard { + + /** + * Creates a new HeroCard. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); +} + +/** Card builder class that simplifies building signin cards. */ +export class SigninCard implements IIsAttachment { + + /** + * Creates a new SigninCard. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); + + /** Title of the Card. */ + text(prompts: string|string[], ...args: any[]): SigninCard; + + /** Signin button label and link. */ + button(title: string|string[], url: string): SigninCard; + + /** Returns the JSON for the card, */ + toAttachment(): IAttachment; +} + +/** Card builder class that simplifies building receipt cards. */ +export class ReceiptCard implements IIsAttachment { + + /** + * Creates a new ReceiptCard. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); + + /** Title of the Card. */ + title(text: string|string[], ...args: any[]): ReceiptCard; + + /** Array of receipt items. */ + items(list: IReceiptItem[]|IIsReceiptItem[]): ReceiptCard; + + /** Array of additional facts to display to user (shipping charges and such.) Not all facts will be displayed on all channels. */ + facts(list: IFact[]|IIsFact[]): ReceiptCard; + + /** This action will be activated when user taps on the card. Not all channels support tap actions. */ + tap(action: ICardAction|IIsCardAction): ReceiptCard; + + /** Total amount of money paid (or should be paid.) */ + total(v: string): ReceiptCard; + + /** Total amount of TAX paid (or should be paid.) */ + tax(v: string): ReceiptCard; + + /** Total amount of VAT paid (or should be paid.) */ + vat(v: string): ReceiptCard; + + /** Set of actions applicable to the current card. Not all channels support buttons and the number of allowed buttons varies by channel. */ + buttons(list: ICardAction[]|IIsCardAction[]): ReceiptCard; + + /** Returns the JSON for the card. */ + toAttachment(): IAttachment; +} + +/** Builder class to simplify adding items to a receipt card. */ +export class ReceiptItem implements IIsReceiptItem { + + /** + * Creates a new ReceiptItem. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); + + /** Title of the item. */ + title(text: string|string[], ...args: any[]): ReceiptItem; + + /** Subtitle appears just below Title field, differs from Title in font styling only. On some channels may be combined with the [title](#title) or [text](#text). */ + subtitle(text: string|string[], ...args: any[]): ReceiptItem; + + /** Text field appears just below subtitle, differs from Subtitle in font styling only. */ + text(text: string|string[], ...args: any[]): ReceiptItem; + + /** Image to display on the card. Some channels may either send the image as a seperate message or simply include a link to the image. */ + image(img: ICardImage|IIsCardImage): ReceiptItem; + + /** Amount with currency. */ + price(v: string): ReceiptItem; + + /** Number of items of given kind. */ + quantity(v: string): ReceiptItem; + + /** This action will be activated when user taps on the Item bubble. Not all channels support tap actions. */ + tap(action: ICardAction|IIsCardAction): ReceiptItem; + + /** Returns the JSON for the item. */ + toItem(): IReceiptItem; + + /** Creates a new ReceiptItem. */ + static create(session: Session, price: string, title?: string|string[]): ReceiptItem; +} + +/** Builder class to simplify creating a list of facts for a card like a receipt. */ +export class Fact implements IIsFact { + + /** + * Creates a new Fact. + * @param session (Optional) will be used to localize any text. + */ + constructor(session?: Session); + + /** Display name of the fact. */ + key(text: string|string[], ...args: any[]): Fact; + + /** Display value of the fact. */ + value(v: string): Fact; + + /** Returns the JSON for the fact. */ + toFact(): IFact; + + /** Creates a new Fact. */ + static create(session: Session, value: string, key?: string|string[]): Fact; +} + + +/** + * Implement support for named actions which can be bound to a dialog to handle global utterances from the user like "help" or + * "cancel". Actions get pushed onto and off of the dialog stack as part of dialogs so these listeners can + * come into and out of scope as the conversation progresses. You can also bind named to actions to buttons + * which let your bot respond to button clicks on cards that have maybe scrolled off the screen. + */ +export class ActionSet { + /** + * Called to recognize any actions triggered by the users utterance. + * @param message The message received from the user. + * @param callback Function to invoke with the results of the recognition. The top scoring action, if any, will be returned. + */ + recognizeAction(message: IMessage, callback: (err: Error, result: IRecognizeActionResult) => void): void; + + /** + * Invokes an action that had the highest confidence score for the utterance. + * @param session Session object for the current conversation. + * @param recognizeResult Results returned from call to [recognizeAction()](#recognizeaction). + */ + invokeAction(session: Session, recognizeResult: IRecognizeActionResult): void; +} + +/** + * Base class for all dialogs. Dialogs are the core component of the BotBuilder + * framework. Bots use Dialogs to manage arbitrarily complex conversations with + * a user. + */ +export abstract class Dialog extends ActionSet { + /** + * Called when a new dialog session is being started. + * @param session Session object for the current conversation. + * @param args (Optional) arguments passed to the dialog by its parent. + */ + begin(session: Session, args?: T): void; + + /** + * Called when a new reply message has been received from a user. + * + * Derived classes should implement this to process the message received from the user. + * @param session Session object for the current conversation. + * @param recognizeResult Results returned from a prior call to the dialogs [recognize()](#recognize) method. + */ + abstract replyReceived(session: Session, recognizeResult: IRecognizeResult): void; + + /** + * A child dialog has ended and the current one is being resumed. + * @param session Session object for the current conversation. + * @param result Result returned by the child dialog. + */ + dialogResumed(session: Session, result: IDialogResult): void; + + /** + * Parses the users utterance and assigns a score from 0.0 - 1.0 indicating how confident the + * dialog is that it understood the users utterance. This method is always called for the active + * dialog on the stack. A score of 1.0 will indicate a perfect match and terminate any further + * recognition. + * + * When the score is less than 1.0, every dialog on the stack will have its + * [recognizeAction()](#recognizeaction) method called as well to see if there are any named + * actions bound to the dialog that better matches the users utterance. Global actions registered + * at the bot level will also be evaluated. If the dialog has a score higher then any bound actions, + * the dialogs [replyReceived()](#replyreceived) method will be called with the result object + * returned from the recognize() call. This lets the dialog pass additional data collected during + * the recognize phase to the replyReceived() method for handling. + * + * Should there be an action with a higher score then the dialog the action will be invoked instead + * of the dialogs replyReceived() method. The dialog will stay on the stack and may be resumed + * at some point should the action invoke a new dialog so dialogs should prepare for unexpected calls + * to [dialogResumed()](#dialogresumed). + * @param context The context of the request. + * @param callback Function to invoke with the recognition results. + */ + recognize(context: IRecognizeContext, callback: (err: Error, result: IRecognizeResult) => void): void; + + /** + * Binds an action to the dialog that will cancel the dialog anytime its triggered. When canceled, the + * dialogs parent will be resumed with a [resumed](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogresult#resumed) code indicating that it was [canceled](/en-us/node/builder/chat-reference/enums/_botbuilder_d_.resumereason#canceled). + * @param name Unique name to assign the action. + * @param msg (Optional) message to send the user prior to canceling the dialog. + * @param options (Optional) options used to configure the action. If [matches](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#matches) is specified the action will listen + * for the user to say a word or phrase that triggers the action, otherwise the action needs to be bound to a button using [CardAction.dialogAction()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.cardaction#dialogaction) + * to trigger the action. + */ + cancelAction(name: string, msg?: string|string[]|IMessage|IIsMessage, options?: IDialogActionOptions): Dialog; + + /** + * Binds an action to the dialog that will cause the dialog to be reloaded anytime its triggered. This is + * useful to implement logic that handle user utterances like "start over". + * @param name Unique name to assign the action. + * @param msg (Optional) message to send the user prior to reloading the dialog. + * @param options (Optional) options used to configure the action. If [matches](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#matches) is specified the action will listen + * for the user to say a word or phrase that triggers the action, otherwise the action needs to be bound to a button using [CardAction.dialogAction()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.cardaction#dialogaction) + * to trigger the action. You can also use [dialogArgs](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#dialogargs) to pass additional params to the dialog when reloaded. + */ + reloadAction(name: string, msg?: string|string[]|IMessage|IIsMessage, options?: IDialogActionOptions): Dialog; + + /** + * Binds an action to the dialog that will start another dialog anytime its triggered. The new + * dialog will be pushed onto the stack so it does not automatically end the current task. The + * current task will be continued once the new dialog ends. The built-in prompts will automatically + * re-prompt the user once this happens but that behaviour can be disabled by setting the [promptAfterAction](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ipromptoptions#promptafteraction) + * flag when calling a built-in prompt. + * @param name Unique name to assign the action. + * @param id ID of the dialog to start. + * @param options (Optional) options used to configure the action. If [matches](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#matches) is specified the action will listen + * for the user to say a word or phrase that triggers the action, otherwise the action needs to be bound to a button using [CardAction.dialogAction()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.cardaction#dialogaction) + * to trigger the action. You can also use [dialogArgs](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#dialogargs) to pass additional params to the dialog being started. + */ + beginDialogAction(name: string, id: string, options?: IDialogActionOptions): Dialog; + + /** + * Binds an action that will end the conversation with the user when triggered. + * @param name Unique name to assign the action. + * @param msg (Optional) message to send the user prior to ending the conversation. + * @param options (Optional) options used to configure the action. If [matches](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#matches) is specified the action will listen + * for the user to say a word or phrase that triggers the action, otherwise the action needs to be bound to a button using [CardAction.dialogAction()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.cardaction#dialogaction) + * to trigger the action. + */ + endConversationAction(name: string, msg?: string|string[]|IMessage|IIsMessage, options?: IDialogActionOptions): Dialog; +} + +/** + * Dialog actions offer static shortcuts to implementing common actions. They also implement support for + * named actions which can be bound to a dialog to handle global utterances from the user like "help" or + * "cancel". Actions get pushed onto and off of the dialog stack as part of dialogs so these listeners can + * come into and out of scope as the conversation progresses. You can also bind named to actions to buttons + * which let your bot respond to button clicks on cards that have maybe scrolled off the screen. + */ +export class DialogAction { + /** + * Returns a closure that will send a simple text message to the user. + * @param msg Text of the message to send. The message will be localized using the sessions configured [localizer](#localizer). If arguments are passed in the message will be formatted using [sprintf-js](https://github.com/alexei/sprintf.js) (see the docs for details.) + * @param args (Optional) arguments used to format the final output string. + */ + static send(msg: string, ...args: any[]): IDialogWaterfallStep; + + /** + * Returns a closure that will passes control of the conversation to a new dialog. + * @param id Unique ID of the dialog to start. + * @param args (Optional) arguments to pass to the dialogs begin() method. + */ + static beginDialog(id: string, args?: T): IDialogWaterfallStep; + + /** + * Returns a closure that will end the current dialog. + * @param result (Optional) results to pass to the parent dialog. + */ + static endDialog(result?: any): IDialogWaterfallStep; + + /** + * Returns a closure that wraps a built-in prompt with validation logic. The closure should be used + * to define a new dialog for the prompt using bot.add('/myPrompt', builder.DialogAction.) + * @param promptType Type of built-in prompt to validate. + * @param validator Function used to validate the response. Should return true if the response is valid. + * @param validator.response The users [IDialogResult.response](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogresult.html#response) returned by the built-in prompt. + * @example + * 

+     * var bot = new builder.BotConnectorBot();
+     * bot.add('/', [
+     *     function (session) {
+     *         session.beginDialog('/meaningOfLife', { prompt: "What's the meaning of life?" });
+     *     },
+     *     function (session, results) {
+     *         if (results.response) {
+     *             session.send("That's correct! The meaning of life is 42.");
+     *         } else {
+     *             session.send("Sorry you couldn't figure it out. Everyone knows that the meaning of life is 42.");
+     *         }
+     *     }
+     * ]);
+     * bot.add('/meaningOfLife', builder.DialogAction.validatedPrompt(builder.PromptType.text, function (response) {
+     *     return response === '42';
+     * }));
+     *
+ */ + static validatedPrompt(promptType: PromptType, validator: (response: any) => boolean): Dialog; +} + + +/** + * A library of related dialogs used for routing purposes. Libraries can be chained together to enable + * the development of complex bots. The [UniversalBot](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.universalbot.html) + * class is itself a Library that forms the root of this chain. + * + * Libraries of reusable parts can be developed by creating a new Library instance and adding dialogs + * just as you would to a bot. Your library should have a unique name that corresponds to either your + * libraries website or NPM module name. Bots can then reuse your library by simply adding your parts + * Library instance to their bot using [UniversalBot.library()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.universalbot.html#library). + * If your library itself depends on other libraries you should add them to your library as a dependency + * using [Library.library()](#library). You can easily manage multiple versions of your library by + * adding a version number to your library name. + * + * To invoke dialogs within your library bots will need to call [session.beginDialog()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#begindialog) + * with a fully qualified dialog id in the form of ':'. You'll typically hide + * this from the devloper by exposing a function from their module that starts the dialog for them. + * So calling something like `myLib.someDialog(session, { arg: '' });` would end up calling + * `session.beginDialog('myLib:someDialog', args);` under the covers. + * + * Its worth noting that dialogs are always invoked within the current dialog so once your within + * a dialog from your library you don't need to prefix every beginDialog() call your with your + * libraries name. Its only when crossing from one library context to another that you need to + * include the library name prefix. + */ +export class Library { + /** + * The libraries unique namespace. This is used to issolate the libraries dialogs and localized + * prompts. + */ + name: string; + + /** + * Creates a new instance of the library. + * @param name Unique namespace for the library. + */ + constructor(name: string); + + /** + * Gets or sets the path to the libraries "/locale/" folder containing its localized prompts. + * The prompts for the library should be stored in a "/locale//.json" file + * under this path where "" representes the 2-3 digit language tage for the locale and + * "" is a filename matching the libraries namespace. + * @param path (Optional) path to the libraries "/locale/" folder. If specified this will update the libraries path. + */ + localePath(path?: string): string; + + /** + * Registers or returns a dialog from the library. + * @param id Unique ID of the dialog being regsitered or retrieved. + * @param dialog (Optional) dialog or waterfall to register. + * * __dialog:__ _{Dialog}_ - Dialog to add. + * * __dialog:__ _{IDialogWaterfallStep[]}_ - Waterfall of steps to execute. See [IDialogWaterfallStep](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogwaterfallstep.html) for details. + * * __dialog:__ _{IDialogWaterfallStep}_ - Single step waterfall. Calling a built-in prompt or starting a new dialog will result in the current dialog ending upon completion of the child prompt/dialog. + */ + dialog(id: string, dialog?: Dialog|IDialogWaterfallStep[]|IDialogWaterfallStep): Dialog; + + /** + * Registers or returns a library dependency. + * @param lib + * * __lib:__ _{Library}_ - Library to register as a dependency. + * * __lib:__ _{string}_ - Unique name of the library to lookup. All dependencies will be searched as well. + */ + library(lib: Library|string): Library; + + /** + * Searches the library and all of its dependencies for a specific dialog. Returns the dialog + * if found, otherwise null. + * @param libName Name of the library containing the dialog. + * @param dialogId Unique ID of the dialog within the library. + */ + findDialog(libName: string, dialogId: string): Dialog; + + /** + * Enumerates all of the libraries child libraries. The caller should take appropriate steps to + * avoid circular references when enumerating the hierarchy. Maintaining a map of visited + * libraries should be enough. + * @param callback Iterator function to call with each child. + * @param callback.library The current child. + */ + forEachLibrary(callback: (library: Library) => void): void; +} + +/** + * Built in built-in prompts that can be called from any dialog. + */ +export class Prompts extends Dialog { + /** + * Processes messages received from the user. Called by the dialog system. + * @param session Session object for the current conversation. + * @param (Optional) recognition results returned from a prior call to the dialogs [recognize()](#recognize) method. + */ + replyReceived(session: Session, recognizeResult?: IRecognizeResult): void; + + /** + * Updates global options for the Prompts dialog. + * @param options Options to set. + */ + static configure(options: IPromptsOptions): void; + + /** + * Captures from the user a raw string of text. + * @param session Session object for the current conversation. + * @param prompt + * * __prompt:__ _{string}_ - Initial message to send the user. + * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * __prompt:__ _{IMessage|IIsMessage}_ - Initial message to send the user. Message can contain attachments. + * @param options (Optional) parameters to control the behaviour of the prompt. + */ + static text(session: Session, prompt: string|string[]|IMessage|IIsMessage, options?: IPromptOptions): void; + + /** + * Prompts the user to enter a number. + * @param session Session object for the current conversation. + * @param prompt + * * __prompt:__ _{string}_ - Initial message to send the user. + * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * __prompt:__ _{IMessage|IIsMessage}_ - Initial message to send the user. Message can contain attachments. + * @param options (Optional) parameters to control the behaviour of the prompt. + */ + static number(session: Session, prompt: string|string[]|IMessage|IIsMessage, options?: IPromptOptions): void; + + /** + * Prompts the user to confirm an action with a yes/no response. + * @param session Session object for the current conversation. + * @param prompt + * * __prompt:__ _{string}_ - Initial message to send the user. + * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * __prompt:__ _{IMessage|IIsMessage}_ - Initial message to send the user. Message can contain attachments. + * @param options (Optional) parameters to control the behaviour of the prompt. + */ + static confirm(session: Session, prompt: string|string[]|IMessage|IIsMessage, options?: IPromptOptions): void; + + /** + * Prompts the user to choose from a list of options. + * @param session Session object for the current conversation. + * @param prompt + * * __prompt:__ _{string}_ - Initial message to send the user. + * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * __prompt:__ _{IMessage|IIsMessage}_ - Initial message to send the user. Message can contain attachments. Any [listStyle](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ipromptoptions.html#liststyle) options will be ignored. + * @param choices + * * __choices:__ _{string}_ - List of choices as a pipe ('|') delimted string. + * * __choices:__ _{Object}_ - List of choices expressed as an Object map. The objects field names will be used to build the list of values. + * * __choices:__ _{string[]}_ - List of choices as an array of strings. + * @param options (Optional) parameters to control the behaviour of the prompt. + */ + static choice(session: Session, prompt: string|string[]|IMessage|IIsMessage, choices: string|Object|string[], options?: IPromptOptions): void; + + /** + * Prompts the user to enter a time. + * @param session Session object for the current conversation. + * @param prompt + * * __prompt:__ _{string}_ - Initial message to send the user. + * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * __prompt:__ _{IMessage|IIsMessage}_ - Initial message to send the user. Message can contain attachments. + * @param options (Optional) parameters to control the behaviour of the prompt. + */ + static time(session: Session, prompt: string|string[]|IMessage|IIsMessage, options?: IPromptOptions): void; + + /** + * Prompts the user to upload a file attachment. + * @param session Session object for the current conversation. + * @param prompt + * * __prompt:__ _{string}_ - Initial message to send the user. + * * __prompt:__ _{string[]}_ - Array of possible messages to send user. One will be chosen at random. + * * __prompt:__ _{IMessage|IIsMessage}_ - Initial message to send the user. Message can contain attachments. + * @param options (Optional) parameters to control the behaviour of the prompt. + */ + static attachment(session: Session, prompt: string|string[]|IMessage|IIsMessage, options?: IPromptOptions): void; +} + +/** + * Implements a simple pattern based recognizer for parsing the built-in prompts. Derived classes can + * inherit from SimplePromptRecognizer and override the recognize() method to change the recognition + * of one or more prompt types. + */ +export class SimplePromptRecognizer implements IPromptRecognizer { + /** + * Attempts to match a users reponse to a given prompt. + * @param args Arguments passed to the recognizer including that language, text, and prompt choices. + * @param callback Function to invoke with the result of the recognition attempt. + */ + recognize(args: IPromptRecognizerArgs, callback: (result: IPromptResult) => void): void; +} + +/** Identifies a users intent and optionally extracts entities from a users utterance. */ +export class IntentDialog extends Dialog { + /** + * Constructs a new instance of an IntentDialog. + * @param options (Optional) options used to initialize the dialog. + */ + constructor(options?: IIntentDialogOptions); + + /** + * Processes messages received from the user. Called by the dialog system. + * @param session Session object for the current conversation. + * @param (Optional) recognition results returned from a prior call to the dialogs [recognize()](#recognize) method. + */ + replyReceived(session: Session, recognizeResult?: IRecognizeResult): void; + + /** + * Called when the dialog is first loaded after a call to [session.beginDialog()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session#begindialog). This gives the bot an opportunity to process arguments passed to the dialog. Handlers should always call the `next()` function to continue execution of the dialogs main logic. + * @param handler Function to invoke when the dialog begins. + * @param handler.session Session object for the current conversation. + * @param handler.args Arguments passed to the dialog in the `session.beginDialog()` call. + * @param handler.next Function to call when handler is finished to continue execution of the dialog. + */ + onBegin(handler: (session: Session, args: any, next: () => void) => void): IntentDialog; + + /** + * Invokes a handler when a given intent is detected in the users utterance. + * + * > __NOTE:__ The full details of the match, including the list of intents & entities detected, will be passed to the [args](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iintentrecognizerresult) of the first waterfall step or dialog that's started. + * @param intent + * * __intent:__ _{RegExp}_ - A regular expression that will be evaluated to detect the users intent. + * * __intent:__ _{string}_ - A named intent returned by an [IIntentRecognizer](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iintentrecognizer) plugin that will be used to match the users intent. + * @param dialogId + * * __dialogId:__ _{string} - The ID of a dialog to begin when the intent is matched. + * * __dialogId:__ _{IDialogWaterfallStep[]}_ - Waterfall of steps to execute when the intent is matched. + * * __dialogId:__ _{IDialogWaterfallStep}_ - Single step waterfall to execute when the intent is matched. Calling a built-in prompt or starting a new dialog will result in the current dialog ending upon completion of the child prompt/dialog. + * @param dialogArgs (Optional) arguments to pass the dialog that started when `dialogId` is a _{string}_. + */ + matches(intent: RegExp|string, dialogId: string|IDialogWaterfallStep[]|IDialogWaterfallStep, dialogArgs?: any): IntentDialog; + + /** + * Invokes a handler when any of the given intents are detected in the users utterance. + * + * > __NOTE:__ The full details of the match, including the list of intents & entities detected, will be passed to the [args](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iintentrecognizerresult) of the first waterfall step or dialog that's started. + * @param intent + * * __intent:__ _{RegExp[]}_ - Array of regular expressions that will be evaluated to detect the users intent. + * * __intent:__ _{string[]}_ - Array of named intents returned by an [IIntentRecognizer](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iintentrecognizer) plugin that will be used to match the users intent. + * @param dialogId + * * __dialogId:__ _{string} - The ID of a dialog to begin when the intent is matched. + * * __dialogId:__ _{IDialogWaterfallStep[]}_ - Waterfall of steps to execute when the intent is matched. + * * __dialogId:__ _{IDialogWaterfallStep}_ - Single step waterfall to execute when the intent is matched. Calling a built-in prompt or starting a new dialog will result in the current dialog ending upon completion of the child prompt/dialog. + * @param dialogArgs (Optional) arguments to pass the dialog that started when `dialogId` is a _{string}_. + */ + matchesAny(intent: RegExp[]|string[], dialogId: string|IDialogWaterfallStep[]|IDialogWaterfallStep, dialogArgs?: any): IntentDialog; + + /** + * The default handler to invoke when there are no handlers that match the users intent. + * + * > __NOTE:__ The full details of the recognition attempt, including the list of intents & entities detected, will be passed to the [args](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iintentrecognizerresult) of the first waterfall step or dialog that's started. + * @param dialogId + * * __dialogId:__ _{string} - The ID of a dialog to begin. + * * __dialogId:__ _{IDialogWaterfallStep[]}_ - Waterfall of steps to execute. + * * __dialogId:__ _{IDialogWaterfallStep}_ - Single step waterfall to execute. Calling a built-in prompt or starting a new dialog will result in the current dialog ending upon completion of the child prompt/dialog. + * @param dialogArgs (Optional) arguments to pass the dialog that started when `dialogId` is a _{string}_. + */ + onDefault(dialogId: string|IDialogWaterfallStep[]|IDialogWaterfallStep, dialogArgs?: any): IntentDialog; + + /** + * Adds a new recognizer plugin to the intent dialog. + * @param plugin The recognizer to add. + */ + recognizer(plugin: IIntentRecognizer): IntentDialog; +} + +/** + * Routes incoming messages to a LUIS app hosted on http://luis.ai for intent recognition. + * Once a messages intent has been recognized it will rerouted to a registered intent handler, along + * with any entities, for further processing. + */ +export class LuisRecognizer implements IIntentRecognizer { + /** + * Constructs a new instance of a LUIS recognizer. + * @param models Either an individual LUIS model used for all utterances or a map of per/local models conditionally used depending on the local of the utterance. + */ + constructor(models: string|ILuisModelMap); + + /** Called by the IntentDialog to perform the actual recognition. */ + public recognize(context: IRecognizeContext, callback: (err: Error, result: IIntentRecognizerResult) => void): void; + + /** + * Calls LUIS to recognizing intents & entities in a users utterance. + * @param utterance The text to pass to LUIS for recognition. + * @param serviceUri URI for LUIS App hosted on http://luis.ai. + * @param callback Callback to invoke with the results of the intent recognition step. + * @param callback.err Error that occured during the recognition step. + * @param callback.intents List of intents that were recognized. + * @param callback.entities List of entities that were recognized. + */ + static recognize(utterance: string, modelUrl: string, callback: (err: Error, intents?: IIntent[], entities?: IEntity[]) => void): void; +} + +/** + * Utility class used to parse & resolve common entities like datetimes received from LUIS. + */ +export class EntityRecognizer { + /** + * Searches for the first occurance of a specific entity type within a set. + * @param entities Set of entities to search over. + * @param type Type of entity to find. + */ + static findEntity(entities: IEntity[], type: string): IEntity; + + /** + * Finds all occurrences of a specific entity type within a set. + * @param entities Set of entities to search over. + * @param type Type of entity to find. + */ + static findAllEntities(entities: IEntity[], type: string): IEntity[]; + + /** + * Parses a date from either a users text utterance or a set of entities. + * @param value + * * __value:__ _{string}_ - Text utterance to parse. The utterance is parsed using the [Chrono](http://wanasit.github.io/pages/chrono/) library. + * * __value:__ _{IEntity[]}_ - Set of entities to resolve. + * @returns A valid Date object if the user spoke a time otherwise _null_. + */ + static parseTime(value: string | IEntity[]): Date; + + /** + * Calculates a Date from a set of datetime entities. + * @param entities List of entities to extract date from. + * @returns The successfully calculated Date or _null_ if a date couldn't be determined. + */ + static resolveTime(entities: IEntity[]): Date; + + /** + * Recognizes a time from a users utterance. The utterance is parsed using the [Chrono](http://wanasit.github.io/pages/chrono/) library. + * @param utterance Text utterance to parse. + * @param refDate (Optional) reference date used to calculate the final date. + * @returns An entity containing the resolved date if successful or _null_ if a date couldn't be determined. + */ + static recognizeTime(utterance: string, refDate?: Date): IEntity; + + /** + * Parses a number from either a users text utterance or a set of entities. + * @param value + * * __value:__ _{string}_ - Text utterance to parse. + * * __value:__ _{IEntity[]}_ - Set of entities to resolve. + * @returns A valid number otherwise _Number.NaN_. + */ + static parseNumber(value: string | IEntity[]): number; + + /** + * Parses a boolean from a users utterance. + * @param value Text utterance to parse. + * @returns A valid boolean otherwise _undefined_. + */ + static parseBoolean(value: string): boolean; + + /** + * Finds the best match for a users utterance given a list of choices. + * @param choices + * * __choices:__ _{string}_ - Pipe ('|') delimited list of values to compare against the users utterance. + * * __choices:__ _{Object}_ - Object used to generate the list of choices. The objects field names will be used to build the list of choices. + * * __choices:__ _{string[]}_ - Array of strings to compare against the users utterance. + * @param utterance Text utterance to parse. + * @param threshold (Optional) minimum score needed for a match to be considered. The default value is 0.6. + */ + static findBestMatch(choices: string | Object | string[], utterance: string, threshold?: number): IFindMatchResult; + + /** + * Finds all possible matches for a users utterance given a list of choices. + * @param choices + * * __choices:__ _{string}_ - Pipe ('|') delimited list of values to compare against the users utterance. + * * __choices:__ _{Object}_ - Object used to generate the list of choices. The objects field names will be used to build the list of choices. + * * __choices:__ _{string[]}_ - Array of strings to compare against the users utterance. + * @param utterance Text utterance to parse. + * @param threshold (Optional) minimum score needed for a match to be considered. The default value is 0.6. + */ + static findAllMatches(choices: string | Object | string[], utterance: string, threshold?: number): IFindMatchResult[]; + + /** + * Converts a set of choices into an expanded array. + * @param choices + * * __choices:__ _{string}_ - Pipe ('|') delimited list of values. + * * __choices:__ _{Object}_ - Object used to generate the list of choices. The objects field names will be used to build the list of choices. + * * __choices:__ _{string[]}_ - Array of strings. This will just be echoed back as the output. + */ + static expandChoices(choices: string | Object | string[]): string[]; +} + +/** + * Allows for the creation of custom dialogs that are based on a simple closure. This is useful for + * cases where you want a dynamic conversation flow or you have a situation that just doesn’t map + * very well to using a waterfall. The things to keep in mind: + * * Your dialogs closure is can get called in two different contexts that you potentially need to + * test for. It will get called as expected when the user send your dialog a message but if you + * call another prompt or dialog from your closure it will get called a second time with the + * results from the prompt/dialog. You can typically test for this second case by checking for the + * existant of an `args.resumed` property. It's important to avoid getting yourself into an + * infinite loop which can be easy to do. + * * Unlike a waterfall your dialog will not automatically end. It will remain the active dialog + * until you call [session.endDialog()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#enddialog). + */ +export class SimpleDialog extends Dialog { + /** + * Creates a new custom dialog based on a simple closure. + * @param handler The function closure for your dialog. + * @param handler.session Session object for the current conversation. + * @param handler.args + * * __args:__ _{any}_ - For the first call to the handler this will be either `null` or the value of any arguments passed to [Session.beginDialog()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html#begindialog). + * * __args:__ _{IDialogResult}_ - If the handler takes an action that results in a new dialog being started those results will be returned via subsequent calls to the handler. + */ + constructor(handler: (session: Session, args?: any | IDialogResult) => void); + + /** + * Processes messages received from the user. Called by the dialog system. + * @param session Session object for the current conversation. + */ + replyReceived(session: Session): void; +} + +/** Default in memory storage implementation for storing user & session state data. */ +export class MemoryBotStorage implements IBotStorage { + /** Returns data from memmory for the given context. */ + getData(context: IBotStorageContext, callback: (err: Error, data: IBotStorageData) => void): void; + + /** Saves data to memory for the given context. */ + saveData(context: IBotStorageContext, data: IBotStorageData, callback?: (err: Error) => void): void; + + /** Deletes in-memory data for the given context. */ + deleteData(context: IBotStorageContext): void; +} + +/** Manages your bots conversations with users across multiple channels. */ +export class UniversalBot { + + /** + * Creates a new instance of the UniversalBot. + * @param connector (Optional) the default connector to use for requests. If there's not a more specific connector registered for a channel then this connector will be used./** + * @param settings (Optional) settings to configure the bot with. + */ + constructor(connector?: IConnector, settings?: IUniversalBotSettings); + + /** + * Registers an event listener. The bot will emit its own events as it process incoming and outgoing messages. It will also forward activity related events emitted from the connector, giving you one place to listen for all activity from your bot. The flow of events from the bot is as follows: + * + * #### Message Received + * When the bot receives a new message it will emit the following events in order: + * + * > lookupUser -> receive -> incoming -> getStorageData -> routing + * + * Any [receive middleware](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.imiddlewaremap#receive) that's been installed will be executed between the 'receive' and 'incoming' events. After the 'routing' event is emmited any + * [botbuilder middleware](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.imiddlewaremap#botbuilder) will be executed prior to dispatching the message to the bots active dialog. + * + * #### Connector Activity Received + * Connectors can emit activity events to signal things like a user is typing or that they friended a bot. These activities get routed through middleware like messages but they are not routed through the bots dialog system. They are only ever emitted as events. + * + * The flow of connector events is: + * + * > lookupUser -> receive -> (activity) + * + * #### Message sent + * Bots can send multiple messages so the session will batch up all outgoing message and then save the bots current state before delivering the sent messages. You'll see a single 'saveStorageData' event emitted and then for every outgoing message in the batch you'll see the following + * sequence of events: + * + * > send -> outgoing + * + * Any [send middleware](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.imiddlewaremap#send) that's been installed will be executed between the 'send' and 'outgoing' events. + * + * @param event Name of the event. Bot and connector specific event types: + * #### Bot Events + * - __error:__ An error occured. Passed a JavaScript `Error` object. + * - __lookupUser:__ The user is for an address is about to be looked up. Passed an [IAddress](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iaddress.html) object. + * - __receive:__ An incoming message has been received. Passed an [IEvent](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ievent.html) object. + * - __incoming:__ An incoming message has been received and processed by middleware. Passed an [IMessage](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.imessage.html) object. + * - __routing:__ An incoming message has been bound to a session and is about to be routed through any session middleware and then dispatched to the active dialog for processing. Passed a [Session](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session.html) object. + * - __send:__ An outgoing message is about to be sent to middleware for processing. Passed an [IMessage](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.imessage.html) object. + * - __getStorageData:__ The sessions persisted state data is being loaded from storage. Passed an [IBotStorageContext](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ibotstoragecontext.html) object. + * - __saveStorageData:__ The sessions persisted state data is being written to storage. Passed an [IBotStorageContext](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ibotstoragecontext.html) object. + * + * #### ChatConnector Events + * - __conversationUpdate:__ Your bot was added to a conversation or other conversation metadata changed. Passed an [IConversationUpdate](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iconversationupdate.html) object. + * - __contactRelationUpdate:__ The bot was added to or removed from a user's contact list. Passed an [IContactRelationUpdate](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.icontactrelationupdate.html) object. + * - __typing:__ The user or bot on the other end of the conversation is typing. Passed an [IEvent](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ievent.html) object. + * + * @param listener Function to invoke. + * @param listener.data The data for the event. Consult the list above for specific types of data you can expect to receive. + */ + on(event: string, listener: (data: any) => void): void; + + /** + * Sets a setting on the bot. + * @param name Name of the property to set. Valid names are properties on [IUniversalBotSettings](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iuniversalbotsettings.html). + * @param value The value to assign to the setting. + */ + set(name: string, value: any): UniversalBot; + + /** + * Returns the current value of a setting. + * @param name Name of the property to return. Valid names are properties on [IUniversalBotSettings](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.iuniversalbotsettings.html). + */ + get(name: string): any; + + /** + * Registers or returns a connector for a specific channel. + * @param channelId Unique ID of the channel. Use a channelId of '*' to reference the default connector. + * @param connector (Optional) connector to register. If ommited the connector for __channelId__ will be returned. + */ + connector(channelId: string, connector?: IConnector): IConnector; + + /** + * Registers or returns a dialog for the bot. + * @param id Unique ID of the dialog being regsitered or retrieved. + * @param dialog (Optional) dialog or waterfall to register. + * * __dialog:__ _{Dialog}_ - Dialog to add. + * * __dialog:__ _{IDialogWaterfallStep[]}_ - Waterfall of steps to execute. See [IDialogWaterfallStep](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogwaterfallstep.html) for details. + * * __dialog:__ _{IDialogWaterfallStep}_ - Single step waterfall. Calling a built-in prompt or starting a new dialog will result in the current dialog ending upon completion of the child prompt/dialog. + */ + dialog(id: string, dialog?: Dialog|IDialogWaterfallStep[]|IDialogWaterfallStep): Dialog; + + /** + * Registers or returns a library dependency. + * @param lib + * * __lib:__ _{Library}_ - Library to register as a dependency. + * * __lib:__ _{string}_ - Unique name of the library to lookup. All dependencies will be searched as well. + */ + library(lib: Library|string): Library; + + /** + * Installs middleware for the bot. Middleware lets you intercept incoming and outgoing events/messages. + * @param args One or more sets of middleware hooks to install. + */ + use(...args: IMiddlewareMap[]): UniversalBot; + + /** + * Called when a new event is received. This can be called manually to mimic the bot receiving a message from the user. + * @param events Event or (array of events) received. + * @param done (Optional) function to invoke once the operation is completed. + */ + receive(events: IEvent|IEvent[], done?: (err: Error) => void): void; + + /** + * Proactively starts a new dialog with the user. Any current conversation between the bot and user will be replaced with a new dialog stack. + * @param address Address of the user to start a new conversation with. This should be saved during a previous conversation with the user. Any existing conversation or dialog will be immediately terminated. + * @param dialogId ID of the dialog to begin. + * @param dialogArgs (Optional) arguments to pass to dialog. + * @param done (Optional) function to invoke once the operation is completed. + */ + beginDialog(address: IAddress, dialogId: string, dialogArgs?: any, done?: (err: Error) => void): void; + + /** + * Sends a message to the user without disrupting the current conversations dialog stack. + * @param messages The message (or array of messages) to send the user. + * @param done (Optional) function to invoke once the operation is completed. + */ + send(messages: IIsMessage|IMessage|IMessage[], done?: (err: Error) => void): void; + + /** + * Returns information about when the last turn between the user and a bot occured. This can be called + * before [beginDialog](#begindialog) to determine if the user is currently in a conversation with the + * bot. + * @param address Address of the user to lookup. This should be saved during a previous conversation with the user. + * @param callback Function to invoke with the results of the query. + */ + isInConversation(address: IAddress, callback: (err: Error, lastAccess: Date) => void): void; + + /** + * Registers a global action that will start another dialog anytime its triggered. The new + * dialog will be pushed onto the stack so it does not automatically end any current task. The + * current task will be continued once the new dialog ends. The built-in prompts will automatically + * re-prompt the user once this happens but that behaviour can be disabled by setting the [promptAfterAction](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.ipromptoptions#promptafteraction) + * flag when calling a built-in prompt. + * @param name Unique name to assign the action. + * @param id ID of the dialog to start. + * @param options (Optional) options used to configure the action. If [matches](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#matches) is specified the action will listen + * for the user to say a word or phrase that triggers the action, otherwise the action needs to be bound to a button using [CardAction.dialogAction()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.cardaction#dialogaction) + * to trigger the action. You can also use [dialogArgs](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#dialogargs) to pass additional params to the dialog being started. + */ + beginDialogAction(name: string, id: string, options?: IDialogActionOptions): Dialog; + + /** + * Registers a global action that will end the conversation with the user when triggered. + * @param name Unique name to assign the action. + * @param msg (Optional) message to send the user prior to ending the conversation. + * @param options (Optional) options used to configure the action. If [matches](/en-us/node/builder/chat-reference/interfaces/_botbuilder_d_.idialogactionoptions#matches) is specified the action will listen + * for the user to say a word or phrase that triggers the action, otherwise the action needs to be bound to a button using [CardAction.dialogAction()](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.cardaction#dialogaction) + * to trigger the action. + */ + endConversationAction(name: string, msg?: string|string[]|IMessage|IIsMessage, options?: IDialogActionOptions): Dialog; +} + +/** Connects a UniversalBot to multiple channels via the Bot Framework. */ +export class ChatConnector implements IConnector, IBotStorage { + + /** + * Creates a new instnace of the ChatConnector. + * @param settings (Optional) config params that let you specify the bots App ID & Password you were assigned in the Bot Frameworks developer portal. + */ + constructor(settings?: IChatConnectorSettings); + + /** Registers an Express or Restify style hook to listen for new messages. */ + listen(): (req: any, res: any) => void; + + /** Called by the UniversalBot at registration time to register a handler for receiving incoming events from a channel. */ + onEvent(handler: (events: IEvent[], callback?: (err: Error) => void) => void): void; + + /** Called by the UniversalBot to deliver outgoing messages to a user. */ + send(messages: IMessage[], done: (err: Error) => void): void; + + /** Called when a UniversalBot wants to start a new proactive conversation with a user. The connector should return a properly formated __address__ object with a populated __conversation__ field. */ + startConversation(address: IAddress, done: (err: Error, address?: IAddress) => void): void; + + /** Reads in data from the Bot Frameworks state service. */ + getData(context: IBotStorageContext, callback: (err: Error, data: IBotStorageData) => void): void; + + /** Writes out data to the Bot Frameworks state service. */ + saveData(context: IBotStorageContext, data: IBotStorageData, callback?: (err: Error) => void): void; +} + +/** Connects a UniversalBot to the command line via a console window. */ +export class ConsoleConnector implements IConnector { + /** Starts the connector listening to stdIn. */ + listen(): ConsoleConnector; + + /** Sends a message through the connector. */ + processMessage(line: string): ConsoleConnector; + + /** Called by the UniversalBot at registration time to register a handler for receiving incoming events from a channel. */ + onEvent(handler: (events: IEvent[], callback?: (err: Error) => void) => void): void; + + /** Called by the UniversalBot to deliver outgoing messages to a user. */ + send(messages: IMessage[], callback: (err: Error, conversationId?: string) => void): void; + + /** Called when a UniversalBot wants to start a new proactive conversation with a user. The connector should return a properly formated __address__ object with a populated __conversation__ field. */ + startConversation(address: IAddress, callback: (err: Error, address?: IAddress) => void): void; +} + +export class Middleware { + /** + * Installs a piece of middleware that manages the versioning of a bots dialogs. + * @param options Settings to configure the bahviour of the installed middleware. + */ + static dialogVersion(options: IDialogVersionOptions): IMiddlewareMap; + + /** + * Adds a first run experience to a bot. The middleware uses Session.userData to store the latest version of the first run dialog the user has been through. Incrementing the version number can force users to run back through either the full or a partial first run dialog. + * @param options Settings to configure the bahviour of the installed middleware. + */ + static firstRun(options: IFirstRunOptions): IMiddlewareMap; + + /** + * Installs a piece of middleware that will always send an initial typing indication to the user. + * This is useful because it lets you send the typing indication before any LUIS models are called. + * The typing indicator will only stay valid for a few seconds so if you're performing any long running + * operations you may want to send an additional typing indicator using [session.sendTyping](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.session#sendtyping). + */ + static sendTyping(): IMiddlewareMap; +} + +/** __DEPRECATED__ use an [IntentDialog](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.intentdialog) with a [LuisRecognizer](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.luisrecognizer) instead. */ +export class LuisDialog extends Dialog { + replyReceived(session: Session, recognizeResult?: IRecognizeResult): void; +} + +/** __DEPRECATED__ use an [IntentDialog](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.intentdialog) instead. */ +export class CommandDialog extends Dialog { + replyReceived(session: Session, recognizeResult?: IRecognizeResult): void; +} + +/** __DEPRECATED__ use [UniversalBot](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.universalbot) and a [ChatConnector](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.chatconnector) instead. */ +export class BotConnectorBot extends Dialog { + replyReceived(session: Session, recognizeResult?: IRecognizeResult): void; +} + +/** __DEPRECATED__ use [UniversalBot](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.universalbot) and a [ConsoleConnector](/en-us/node/builder/chat-reference/classes/_botbuilder_d_.consoleconnector) instead. */ +export class TextBot extends Dialog { + replyReceived(session: Session, recognizeResult?: IRecognizeResult): void; +} \ No newline at end of file diff --git a/Server/config.json b/Server/config.json index ab64d3f1..b0017b14 100644 --- a/Server/config.json +++ b/Server/config.json @@ -15,13 +15,6 @@ "vorlonServerURL": "", "vorlonProxyURL": "", "plugins": [ - { - "id": "DOM", - "name": "Dom Explorer", - "panel": "top", - "foldername": "domExplorer", - "enabled": true - }, { "id": "OBJEXPLORER", "name": "Obj. Explorer", @@ -38,6 +31,48 @@ "enabled": true, "nodeCompliant": true }, + { + "id": "NODEJS", + "name": "NodeJS", + "panel": "top", + "foldername": "nodejs", + "enabled": true, + "nodeCompliant": true, + "nodeOnly": true + }, + { + "id": "BOTFRAMEWORKINSPECTOR", + "name": "Bot Framework Inspector", + "panel": "top", + "foldername": "botFrameworkInspector", + "enabled": true, + "nodeCompliant": true, + "nodeOnly": true + }, + { + "id": "CONSOLE", + "name": "Interactive Console", + "panel": "top", + "foldername": "interactiveConsole", + "enabled": true, + "nodeCompliant": true + }, + { + "id": "EXPRESS", + "name": "Express", + "panel": "top", + "foldername": "express", + "enabled": true, + "nodeCompliant": true, + "nodeOnly": true + }, + { + "id": "DOM", + "name": "Dom Explorer", + "panel": "top", + "foldername": "domExplorer", + "enabled": true + }, { "id": "BABYLONINSPECTOR", "name": "Babylon Inspector", @@ -101,56 +136,21 @@ "foldername": "office", "enabled": false }, - { - "id": "NODEJS", - "name": "NodeJS", - "panel": "top", - "foldername": "nodejs", - "enabled": true, - "nodeCompliant": true, - "nodeOnly": true - }, - { - "id": "CONSOLE", - "name": "Interactive Console", - "panel": "bottom", - "foldername": "interactiveConsole", - "enabled": true, - "nodeCompliant": true - }, { "id": "MODERNIZR", "name": "Modernizr", "panel": "bottom", "foldername": "modernizrReport", - "enabled": true - }, - { - "id": "EXPRESS", - "name": "Express", - "panel": "bottom", - "foldername": "express", - "enabled": true, - "nodeCompliant": true, - "nodeOnly": true + "enabled": false }, { "id": "DOMTIMELINE", "name": "Dom timeline", "panel": "top", "foldername": "domtimeline", - "enabled": true, + "enabled": false, "nodeCompliant": false, "nodeOnly": false - }, - { - "id": "BOTFRAMEWORKINSPECTOR", - "name": "Bot Framework Inspector", - "panel": "bottom", - "foldername": "botFrameworkInspector", - "enabled": true, - "nodeCompliant": true, - "nodeOnly": true } ] } \ No newline at end of file diff --git a/client samples/botbuilder/index.js b/client samples/botbuilder/index.js new file mode 100644 index 00000000..229d0fa1 --- /dev/null +++ b/client samples/botbuilder/index.js @@ -0,0 +1,41 @@ +// ========== VORLON Setup +var vorlonWrapper = require("vorlon-node-wrapper"); +vorlonWrapper.start("http://localhost:1337", "default", false); + +// ========== Requiring +var restify = require('restify'); +var builder = require('botbuilder'); + +//========================================================= +// Bot Setup +//========================================================= + +// Setup Restify Server +var server = restify.createServer(); +server.listen(process.env.port || process.env.PORT || 3978, function () { + console.log('%s listening to %s', server.name, server.url); +}); + +// Create chat bot +var connector = new builder.ChatConnector({ + appId: process.env.MICROSOFT_APP_ID, + appPassword: process.env.MICROSOFT_APP_PASSWORD +}); +var bot = new builder.UniversalBot(connector); +server.post('/api/messages', connector.listen()); + +//========================================================= +// Bots Dialogs +//========================================================= + +bot.dialog('/', function (session) { + session.send("Slash, oh oh, savior of the universe!"); +}); + +bot.dialog('/hello', function (session) { + session.send("Hello World"); +}); + +bot.dialog('/coucou', function (session) { + session.send("Coucou world"); +}); \ No newline at end of file diff --git a/client samples/botbuilder/package.json b/client samples/botbuilder/package.json new file mode 100644 index 00000000..2d442a95 --- /dev/null +++ b/client samples/botbuilder/package.json @@ -0,0 +1,16 @@ +{ + "name": "sample", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "dependencies": { + "botbuilder": "^3.4.4", + "restify": "^4.2.0", + "vorlon-node-wrapper": "0.0.3" + } +} diff --git a/gulpfile.js b/gulpfile.js index 3ad2adda..fc3b4f46 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -137,6 +137,35 @@ gulp.task('scripts-specific-plugins-plugins', ['scripts-plugins'], function() { ]) .pipe(concat('vorlon.babylonInspector.dashboard.min.js')) .pipe(gulp.dest('Plugins/release/plugins/babylonInspector/')); + + // Bot framework inspector + gulp.src([ + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.js', + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.js' + ]) + .pipe(concat('vorlon.botFrameworkInspector.client.js')) + .pipe(gulp.dest('Plugins/release/plugins/botFrameworkInspector/')); + + gulp.src([ + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.js', + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.js' + ]) + .pipe(concat('vorlon.botFrameworkInspector.dashboard.js')) + .pipe(gulp.dest('Plugins/release/plugins/botFrameworkInspector/')); + + gulp.src([ + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.min.js', + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.min.js' + ]) + .pipe(concat('vorlon.botFrameworkInspector.client.min.js')) + .pipe(gulp.dest('Plugins/release/plugins/botFrameworkInspector/')); + + gulp.src([ + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.min.js', + 'Plugins/release/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.min.js' + ]) + .pipe(concat('vorlon.botFrameworkInspector.dashboard.min.js')) + .pipe(gulp.dest('Plugins/release/plugins/botFrameworkInspector/')); // Office gulp.src([ From e562d7f6eae1960b8d71afae07dd189018438627 Mon Sep 17 00:00:00 2001 From: Etienne Margraff Date: Wed, 9 Nov 2016 15:35:34 -0800 Subject: [PATCH 04/38] add hook on onSave --- .../vorlon.botFrameworkInspector.client.ts | 39 ++++++++++++++----- ...vorlon.botFrameworkInspector.interfaces.ts | 2 +- client samples/botbuilder/index.js | 2 + 3 files changed, 32 insertions(+), 11 deletions(-) diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts index ad00b574..4caabcbb 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.client.ts @@ -1,30 +1,49 @@ /// +var path = require("path"); +var requireHook = require("require-hook"); module VORLON { export class BotFrameworkInspectorClient extends ClientPlugin { - private _libraryHooked:boolean; + private _hooked:boolean; private _botInfo:BotInfo; constructor() { super("botFrameworkInspector"); //this.debug = true; this._ready = true; - this._libraryHooked = false; + this._hooked = false; this._botInfo = new BotInfo(); } public startClientSide(): void { - this.hookLibraryDialogFunction() - } - - public hookLibraryDialogFunction(){ - var path = require("path"); - var requireHook = require("require-hook"); requireHook.attach(path.resolve()); + this.hookBotFrameworkFunctions(); + } + public hookBotFrameworkFunctions(){ var that = this; requireHook.setEvent(function(result, e){ - if (!that._libraryHooked && e.require === "botbuilder") { + if (!that._hooked && e.require === "botbuilder") { + //Hooking onSave on Session class + var previousSendBatchFunction = result.Session.prototype.sendBatch; + + result.Session.prototype.sendBatch = function(callback:any) { + var returned = previousSendBatchFunction.apply(this, arguments); + var previousOnSaveFunction = this.options.onSave; + + var thatSession = this; + this.options.onSave(function(err:any){ + var botCallStack = new BotCallstack(); + botCallStack.sessionState = thatSession.sessionState; + that._botInfo.callStackHistory.push(botCallStack); + that.refresh(); + return previousOnSaveFunction.apply(this, arguments); + }); + + return returned; + } + + // Hooking Dialog on Library class var previousDialogFunction = result.Library.prototype.dialog; result.Library.prototype.dialog = function(id: string, dialog?: any | any[] | any) { @@ -38,7 +57,7 @@ module VORLON { return previousDialogFunction.apply(this, arguments); } - that._libraryHooked = true; + that._hooked = true; } return result; }); diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts index 872424cc..c7eb11de 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.interfaces.ts @@ -22,6 +22,6 @@ } export class BotCallstack { - public callstack:any[]; + public sessionState; } } \ No newline at end of file diff --git a/client samples/botbuilder/index.js b/client samples/botbuilder/index.js index 229d0fa1..fd6bcc22 100644 --- a/client samples/botbuilder/index.js +++ b/client samples/botbuilder/index.js @@ -30,10 +30,12 @@ server.post('/api/messages', connector.listen()); bot.dialog('/', function (session) { session.send("Slash, oh oh, savior of the universe!"); + session.beginDialog("/hello"); }); bot.dialog('/hello', function (session) { session.send("Hello World"); + builder.Prompts.text(session, "What do you want?"); }); bot.dialog('/coucou', function (session) { From 18b45227376a98183b9d583886edaf395a025d73 Mon Sep 17 00:00:00 2001 From: Etienne Margraff Date: Wed, 9 Nov 2016 16:09:21 -0800 Subject: [PATCH 05/38] Add more details in the sample bot --- client samples/botbuilder/index.js | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/client samples/botbuilder/index.js b/client samples/botbuilder/index.js index fd6bcc22..c3ab8bce 100644 --- a/client samples/botbuilder/index.js +++ b/client samples/botbuilder/index.js @@ -33,10 +33,15 @@ bot.dialog('/', function (session) { session.beginDialog("/hello"); }); -bot.dialog('/hello', function (session) { +bot.dialog('/hello', [function (session) { session.send("Hello World"); builder.Prompts.text(session, "What do you want?"); -}); +}, +function (session, args) { + session.send("Ok!"); + builder.Prompts.text(session, "Quoi d'autre?"); +}, +]); bot.dialog('/coucou', function (session) { session.send("Coucou world"); From 5fb767373e937413cabc73740f17c0b0740865f3 Mon Sep 17 00:00:00 2001 From: davrous Date: Wed, 9 Nov 2016 21:18:40 -0800 Subject: [PATCH 06/38] Adding graph drawing logic in dashboard part of the Bot debugger --- .../botFrameworkInspector/control.html | 12 +- .../vorlon.botFrameworkInspector.dashboard.ts | 164 ++++++++++++++++-- Server/config.json | 2 +- client samples/nodejs/package.json | 1 + 4 files changed, 162 insertions(+), 17 deletions(-) diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/control.html b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html index eaf87ceb..84c866d5 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/control.html +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html @@ -1,10 +1,18 @@  - + + + -
+
+
+ Dialogs List +
    +
    +
    +
    diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts index 38d1d506..c87ff148 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts @@ -1,5 +1,10 @@ module VORLON { export class BotFrameworkInspectorDashboard extends DashboardPlugin { + private _blocksDefinition = `callstack0=>condition: 0|timeline`; + private _callstacksGraphDefinition = []; + private _chart; + private _dialogsList: HTMLUListElement; + constructor() { super("botFrameworkInspector", "control.html", "control.css"); this._ready = false; @@ -8,30 +13,161 @@ private _lastReceivedBotInfo: BotInfo; private _containerDiv: HTMLElement; - + + private _newCallStack(sessionState) { + var csIndex = this._callstacksGraphDefinition.length + 1; + var csBlock = `callstack${csIndex}=>condition: ${csIndex}|timeline`; + this._blocksDefinition += '\n' + csBlock; + + if (sessionState.callstack.length > 0) { + sessionState.callstack.forEach((element, i) => { + let block = `block${i}callstack${csIndex - 1}=>inputoutput: ${element.id}`; + if (element.state["BotBuilder.Data.WaterfallStep"] != undefined){ + block += " - step:" + element.state["BotBuilder.Data.WaterfallStep"] + } + this._blocksDefinition += '\n' + block; + }); + } + else { + let block = `block0callstack${csIndex - 1}=>inputoutput: Empty callstack`; + this._blocksDefinition += '\n' + block; + } + + var csGraphDefinition = []; + + let graphDef = `callstack${csIndex - 1}(yes, right)->callstack${csIndex}\ncallstack${csIndex - 1}(no)->block0callstack${csIndex - 1}->`; + + for (let i = 1; i < sessionState.callstack.length; i++) { + graphDef += `block${i}callstack${csIndex - 1}->`; + } + + csGraphDefinition.push(graphDef); + + this._callstacksGraphDefinition.push(csGraphDefinition); + } + + private _updateSVGGraph() { + var code = this._generateCompleteGraphCode(); + if (this._chart) { + this._chart.clean(); + } + this._chart = window.flowchart.parse(code); + + this._chart.drawSVG('canvas', { + // 'x': 30, + // 'y': 50, + 'line-width': 3, + 'maxWidth': 3,//ensures the flowcharts fits within a certian width + 'line-length': 50, + 'text-margin': 10, + 'font-size': 14, + 'font': 'normal', + 'font-family': 'Helvetica', + 'font-weight': 'normal', + 'font-color': 'black', + 'line-color': 'black', + 'element-color': 'black', + 'fill': 'white', + 'yes-text': 'yes', + 'no-text': 'no', + 'arrow-end': 'block', + 'scale': 1, + 'symbols': { + 'start': { + 'font-color': 'red', + 'element-color': 'green', + 'fill': 'yellow' + }, + 'end': { + 'class': 'end-element' + } + }, + 'flowstate': { + 'past': { 'fill': '#CCCCCC', 'font-size': 12 }, + 'current': { 'fill': 'yellow', 'font-color': 'red', 'font-weight': 'bold' }, + 'future': { 'fill': '#FFFF99' }, + 'request': { 'fill': 'blue' }, + 'invalid': { 'fill': '#444444' }, + 'timeline': { 'fill': '#58C4A3', 'font-size': 12, 'yes-text': ' ', 'no-text': ' ' }, + 'rejected': { 'fill': '#C45879', 'font-size': 12, 'yes-text': 'n/a', 'no-text': 'REJECTED' } + } + }); + } + + private _generateCompleteGraphCode() { + var graphCode = this._blocksDefinition + '\n'; + + this._callstacksGraphDefinition.forEach((csGraphCode) => { + csGraphCode.forEach((blockCode) => { + graphCode += blockCode + '\n'; + }); + }); + + return graphCode; + } + + private _loadScript(url, callback) { + var script = document.createElement("script") + script.type = "text/javascript"; + + script.onload = function () { + callback(); + }; + + script.src = url; + document.getElementsByTagName("head")[0].appendChild(script); + } + public startDashboardSide(div: HTMLDivElement = null): void { - this._insertHtmlContentAsync(div, (filledDiv) => { - this._containerDiv = Tools.QuerySelectorById(div, "botFrameworkInspector"); - this._ready = true; - this.display(); + this._loadScript("http://cdnjs.cloudflare.com/ajax/libs/raphael/2.2.0/raphael-min.js", () => { + this._loadScript("http://flowchart.js.org/flowchart-latest.js", () => { + this._insertHtmlContentAsync(div, (filledDiv) => { + this._dialogsList = document.getElementById("dialogsList"); + //this._containerDiv = Tools.QuerySelectorById(div, "botFrameworkInspector"); + this._ready = true; + this.display(); + }) + }) }) } - public onRealtimeMessageReceivedFromClientSide(receivedObject:any):void { + public onRealtimeMessageReceivedFromClientSide(receivedObject: any): void { this._lastReceivedBotInfo = receivedObject; this.display(); } - - public display(){ - if(this._lastReceivedBotInfo){ - this._containerDiv.textContent = ""; - for(var i = 0; i < this._lastReceivedBotInfo.dialogDataList.length; i++){ - this._containerDiv.textContent += "
    " + this._lastReceivedBotInfo.dialogDataList[i].id; - } + + public display() { + if (this._lastReceivedBotInfo) { + this._callstacksGraphDefinition = []; + this._dialogsList.innerHTML = ""; + + this._lastReceivedBotInfo.dialogDataList.forEach((dataList) => { + let waterFallStep = 0; + if (dataList.dialog && dataList.dialog.length) { + waterFallStep = dataList.dialog.length; + } + + let newLi = `
  • ${dataList.id} (${waterFallStep} step(s))
    • `; + this._dialogsList.innerHTML += newLi; + }); + + this._lastReceivedBotInfo.callStackHistory.forEach((botCallStack) => { + console.log(botCallStack.sessionState); + this._newCallStack(botCallStack.sessionState); + }); + this._updateSVGGraph(); } } } //Register the plugin with vorlon core Core.RegisterDashboardPlugin(new BotFrameworkInspectorDashboard()); -} \ No newline at end of file +} + +interface Window { + flowchart: FlowChart; +} + +interface FlowChart { + parse(code: string): any; +}; \ No newline at end of file diff --git a/Server/config.json b/Server/config.json index b0017b14..ff06dd03 100644 --- a/Server/config.json +++ b/Server/config.json @@ -52,7 +52,7 @@ { "id": "CONSOLE", "name": "Interactive Console", - "panel": "top", + "panel": "bottom", "foldername": "interactiveConsole", "enabled": true, "nodeCompliant": true diff --git a/client samples/nodejs/package.json b/client samples/nodejs/package.json index aca25469..d38cfeab 100644 --- a/client samples/nodejs/package.json +++ b/client samples/nodejs/package.json @@ -15,6 +15,7 @@ "openurl": "^1.1.1", "socket.io": "^1.3.7", "socket.io-client": "^1.3.7", + "url-join": "^1.1.0", "vorlon-node-wrapper": "0.0.2", "xhr2": "^0.1.3", "xmlhttprequest": "^1.8.0" From 9f422c670774071050547610f4d24a67b12723cb Mon Sep 17 00:00:00 2001 From: Etienne Margraff Date: Fri, 25 Nov 2016 15:47:38 -0800 Subject: [PATCH 07/38] working on bot plugin ui --- Plugins/Vorlon/.gitignore | 3 +- .../plugins/botFrameworkInspector/control.css | 109 ++++++++++++++++++ .../botFrameworkInspector/control.html | 44 +++++-- .../vorlon.botFrameworkInspector.dashboard.ts | 31 +++-- 4 files changed, 168 insertions(+), 19 deletions(-) create mode 100644 Plugins/Vorlon/plugins/botFrameworkInspector/control.css diff --git a/Plugins/Vorlon/.gitignore b/Plugins/Vorlon/.gitignore index 7c6c6151..b163553d 100644 --- a/Plugins/Vorlon/.gitignore +++ b/Plugins/Vorlon/.gitignore @@ -13,4 +13,5 @@ !plugins/nodejs/** !plugins/nodejs/**/*.css !plugins/nodejs/**/*.js -!plugins/nodejs/dom-timeline.js \ No newline at end of file +!plugins/nodejs/dom-timeline.js +!plugins/botFrameworkInspector/**/*.css \ No newline at end of file diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/control.css b/Plugins/Vorlon/plugins/botFrameworkInspector/control.css new file mode 100644 index 00000000..6967b11c --- /dev/null +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/control.css @@ -0,0 +1,109 @@ +body { + margin: 0; +} + +#splitter { + display: flex; + flex-wrap: nowrap; + font-family: "Menlo", "Consolas", "Lucida Console", Courier, monospace; +} + + +.hidden{ + visibility: collapse; +} + +#left { + flex-grow: 4; +} + +#left .section-header { + border-bottom: 1px solid lightgrey; + padding: 5px; +} + +#left #dialogs { + height: 100vh; + display:flex; + flex-direction: column; +} + +#left #dialog { + display:flex; + flex-direction: row; + line-height: 80px; + border-bottom: 1px solid lightgray; +} + +#left .dialog-id { + background-color: mediumpurple; + flex-grow: 1; + color: white; + padding-left: 10px; + margin: 0; + padding: 10px; +} + +#left .dialog-detail { + flex-grow: 4; + display: flex; + flex-direction: row; + background-color: #ccc; + color: darkslategray; + padding-left: 20px; +} + +#left .dialog-detail { + margin:0; + padding: 10px; +} + +#left .dialog-detail p { + margin:0; + margin-left:20px; + margin-right:20px; +} + +#left .dialog-detail .waterfall-steps { + display:flex; + flex-grow: 4; +} + +#left .dialog-detail .waterfall-step { + display: inline-block; + background-color: #3E3D3D; + color: white; + text-align: center; + flex-grow: 1; + margin-left: 10px; + max-width: 100px; +} + +#left #callstacks { + height: 100vh; +} + +#right { + border-left: solid 1px gray; +} + +#right ul { + list-style-type: none; + margin: 0; + padding: 0; +} + +#right ul li { + border: 1px solid #ccc; + border-top:0; + border-left: 0; + background-color: #eee; + padding: 25px; + width: 200px; + text-transform: uppercase; +} + +#right ul li.selected{ + background-color: #3E3D3D; + color: white; +} diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/control.html b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html index 84c866d5..9776ef70 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/control.html +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html @@ -1,18 +1,46 @@  - + - - -
    -
    - Dialogs List -
      +
      + + -
      diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts index c87ff148..9ee00eb6 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/vorlon.botFrameworkInspector.dashboard.ts @@ -119,16 +119,27 @@ } public startDashboardSide(div: HTMLDivElement = null): void { - this._loadScript("http://cdnjs.cloudflare.com/ajax/libs/raphael/2.2.0/raphael-min.js", () => { - this._loadScript("http://flowchart.js.org/flowchart-latest.js", () => { - this._insertHtmlContentAsync(div, (filledDiv) => { - this._dialogsList = document.getElementById("dialogsList"); - //this._containerDiv = Tools.QuerySelectorById(div, "botFrameworkInspector"); - this._ready = true; - this.display(); - }) - }) - }) + this._insertHtmlContentAsync(div, (filledDiv) => { + //this._dialogsList = document.getElementById("dialogsList"); + + + $("#menu").on("click", "li#display-dialog", function(event){ + $("#dialogs").removeClass("hidden"); + $("#callstacks").addClass("hidden"); + $("#display-dialog").addClass("selected"); + $("#display-callstacks").removeClass("selected"); + }); + + $("#menu").on("click", "li#display-callstacks", function(event){ + $("#dialogs").addClass("hidden"); + $("#callstacks").removeClass("hidden"); + $("#display-dialog").removeClass("selected"); + $("#display-callstacks").addClass("selected"); + }); + + this._ready = true; + this.display(); + }); } public onRealtimeMessageReceivedFromClientSide(receivedObject: any): void { From aa780935535e0a6748a4f3bdd67b7f22b8a591e2 Mon Sep 17 00:00:00 2001 From: Etienne Margraff Date: Fri, 25 Nov 2016 17:03:21 -0800 Subject: [PATCH 08/38] added ui for dialogstack --- .../plugins/botFrameworkInspector/control.css | 74 ++++++++++++++- .../botFrameworkInspector/control.html | 95 +++++++++++++++++-- 2 files changed, 157 insertions(+), 12 deletions(-) diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/control.css b/Plugins/Vorlon/plugins/botFrameworkInspector/control.css index 6967b11c..da794a67 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/control.css +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/control.css @@ -8,13 +8,16 @@ body { font-family: "Menlo", "Consolas", "Lucida Console", Courier, monospace; } - .hidden{ visibility: collapse; + display: none!important; } #left { flex-grow: 4; + overflow: scroll; + overflow-x: hidden; + height:100vh; } #left .section-header { @@ -28,7 +31,7 @@ body { flex-direction: column; } -#left #dialog { +#left .dialog { display:flex; flex-direction: row; line-height: 80px; @@ -70,7 +73,6 @@ body { } #left .dialog-detail .waterfall-step { - display: inline-block; background-color: #3E3D3D; color: white; text-align: center; @@ -79,12 +81,74 @@ body { max-width: 100px; } -#left #callstacks { - height: 100vh; +#left #dialogstacks { + display:flex; + flex-direction: column; +} + +#left #dialogstacks .user-entry { + display:flex; + flex-direction: row; +} + +#left #dialogstacks .user-entry .entry { + background-color: forestgreen; + flex-grow: 1; + color: white; + border-bottom: 1px solid lightgray; + line-height: 100%; + margin: 0; + padding: 20px; + max-width: 150px; +} + +#left #dialogstacks .user-entry .stacks { + display: flex; + flex-direction: column; + flex-grow: 5; + background-color: #ccc; +} + +#left #dialogstacks .user-entry .stack { + display: flex; + flex-direction: column; + border-bottom: 1px solid darkslategray; + padding: 10px; +} + +#left #dialogstacks .user-entry .dialogs-in-stack { + display: flex; + flex-direction: row; +} + +#left #dialogstacks .user-entry .data { + border: 1px solid darkslategray; + background-color: #eee; + padding: 10px; + margin-top: 10px; +} + +#left #dialogstacks .user-entry .stack .dialog-in-stack { + background-color: #3E3D3D; + color: white; + text-align: center; + flex-grow: 1; + height:50px; + line-height: 50px; + max-width: 100px; +} + +#left #dialogstacks .user-entry .stack .dialogs-in-stack .line { + height: 0px; + width: 20px; + border-bottom: 1px solid black; + align-self: center; } #right { border-left: solid 1px gray; + height: 100vh; + overflow: hidden; } #right ul { diff --git a/Plugins/Vorlon/plugins/botFrameworkInspector/control.html b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html index 9776ef70..8d98bee7 100644 --- a/Plugins/Vorlon/plugins/botFrameworkInspector/control.html +++ b/Plugins/Vorlon/plugins/botFrameworkInspector/control.html @@ -6,9 +6,9 @@
      -