From 56bee6ed5ac5e25361a8e2ecadb3bce9af40143b Mon Sep 17 00:00:00 2001
From: Jan Dvorak <storytellercz@proton.me>
Date: Thu, 5 Sep 2024 14:13:07 +0200
Subject: [PATCH] Add docs to master for easier management

---
 .gitignore                                   |    1 -
 docs/api.js                                  |   25 +
 docs/assets/css/external-small.png           |  Bin 0 -> 491 bytes
 docs/assets/css/logo.png                     |  Bin 0 -> 7143 bytes
 docs/assets/css/main.css                     |  783 +++
 docs/assets/favicon.ico                      |  Bin 0 -> 5430 bytes
 docs/assets/img/spinner.gif                  |  Bin 0 -> 2685 bytes
 docs/assets/index.html                       |   10 +
 docs/assets/js/api-filter.js                 |   56 +
 docs/assets/js/api-list.js                   |  255 +
 docs/assets/js/api-search.js                 |   98 +
 docs/assets/js/apidocs.js                    |  376 ++
 docs/assets/js/yui-prettify.js               |   17 +
 docs/assets/vendor/prettify/CHANGES.html     |  130 +
 docs/assets/vendor/prettify/COPYING          |  202 +
 docs/assets/vendor/prettify/README.html      |  203 +
 docs/assets/vendor/prettify/prettify-min.css |    1 +
 docs/assets/vendor/prettify/prettify-min.js  |    1 +
 docs/classes/Roles.html                      | 5185 ++++++++++++++++++
 docs/classes/UIHelpers.html                  |  246 +
 docs/classes/index.html                      |   10 +
 docs/data.json                               | 1743 ++++++
 docs/elements/index.html                     |   10 +
 docs/files/index.html                        |   10 +
 docs/files/roles_client_uiHelpers.js.html    |  193 +
 docs/files/roles_roles_client.js.html        | 1206 ++++
 docs/files/roles_roles_common_async.js.html  | 1432 +++++
 docs/index.html                              |  118 +
 docs/modules/Roles.html                      |  152 +
 docs/modules/UIHelpers.html                  |  134 +
 docs/modules/index.html                      |   10 +
 31 files changed, 12606 insertions(+), 1 deletion(-)
 create mode 100644 docs/api.js
 create mode 100644 docs/assets/css/external-small.png
 create mode 100644 docs/assets/css/logo.png
 create mode 100644 docs/assets/css/main.css
 create mode 100644 docs/assets/favicon.ico
 create mode 100644 docs/assets/img/spinner.gif
 create mode 100644 docs/assets/index.html
 create mode 100644 docs/assets/js/api-filter.js
 create mode 100644 docs/assets/js/api-list.js
 create mode 100644 docs/assets/js/api-search.js
 create mode 100644 docs/assets/js/apidocs.js
 create mode 100644 docs/assets/js/yui-prettify.js
 create mode 100644 docs/assets/vendor/prettify/CHANGES.html
 create mode 100644 docs/assets/vendor/prettify/COPYING
 create mode 100644 docs/assets/vendor/prettify/README.html
 create mode 100644 docs/assets/vendor/prettify/prettify-min.css
 create mode 100644 docs/assets/vendor/prettify/prettify-min.js
 create mode 100644 docs/classes/Roles.html
 create mode 100644 docs/classes/UIHelpers.html
 create mode 100644 docs/classes/index.html
 create mode 100644 docs/data.json
 create mode 100644 docs/elements/index.html
 create mode 100644 docs/files/index.html
 create mode 100644 docs/files/roles_client_uiHelpers.js.html
 create mode 100644 docs/files/roles_roles_client.js.html
 create mode 100644 docs/files/roles_roles_common_async.js.html
 create mode 100644 docs/index.html
 create mode 100644 docs/modules/Roles.html
 create mode 100644 docs/modules/UIHelpers.html
 create mode 100644 docs/modules/index.html

diff --git a/.gitignore b/.gitignore
index 00e5ba2a..31bff412 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,7 +17,6 @@ smart.lock
 
 .idea
 .DS_Store
-docs/
 node_modules/
 .npm/
 .coverage/
diff --git a/docs/api.js b/docs/api.js
new file mode 100644
index 00000000..6aca44ca
--- /dev/null
+++ b/docs/api.js
@@ -0,0 +1,25 @@
+YUI.add("yuidoc-meta", function(Y) {
+   Y.YUIDoc = { meta: {
+    "classes": [
+        "Roles",
+        "UIHelpers"
+    ],
+    "modules": [
+        "Roles",
+        "UIHelpers"
+    ],
+    "allModules": [
+        {
+            "displayName": "Roles",
+            "name": "Roles",
+            "description": "Provides functions related to user authorization. Compatible with built-in Meteor accounts packages.\n\nRoles are accessible through `Meteor.roles` collection and documents consist of:\n - `_id`: role name\n - `children`: list of subdocuments:\n   - `_id`\n\nChildren list elements are subdocuments so that they can be easier extended in the future or by plugins.\n\nRoles can have multiple parents and can be children (subroles) of multiple roles.\n\nExample: `{_id: 'admin', children: [{_id: 'editor'}]}`\n\nThe assignment of a role to a user is stored in a collection, accessible through `RoleAssignmentCollection`.\nIt's documents consist of\n - `_id`: Internal MongoDB id\n - `role`: A role object which got assigned. Usually only contains the `_id` property\n - `user`: A user object, usually only contains the `_id` property\n - `scope`: scope name\n - `inheritedRoles`: A list of all the roles objects inherited by the assigned role."
+        },
+        {
+            "displayName": "UIHelpers",
+            "name": "UIHelpers",
+            "description": "Convenience functions for use on client.\n\nNOTE: You must restrict user actions on the server-side; any\nclient-side checks are strictly for convenience and must not be\ntrusted."
+        }
+    ],
+    "elements": []
+} };
+});
\ No newline at end of file
diff --git a/docs/assets/css/external-small.png b/docs/assets/css/external-small.png
new file mode 100644
index 0000000000000000000000000000000000000000..759a1cdcb5b1697e5be290d98b830e279cd71f3c
GIT binary patch
literal 491
zcmV<H0Tlj;P)<h;3K|Lk000e1NJLTq000mG000mO1^@s6AM^iV0000PbVXQnQ*UN;
zcVTj606}DLVr3vnZDD6+Qe|Oed2z{QJOBUzjY&j7RCwBA{Qv(y10{fofkHsB0W2_v
zUBVFtR#sLp=H=xBVFzYr=KaWuf!;khr%J>Ds{zR1^XE?tfB*h@ASKHAa7wwn{MEbP
z7_^nS7{V*>+A}bS;P%45fB%Ai|Neasi2rl3{=EO;!w318%8Ovl7jArHc=P5Brfr~D
z0AYimtss2w$hlYlfd>7*aO3TNzw875LBK0xAD9Np|A(oEVYnB*eE9~V6wP%78SXuL
z&#-X)Er#`zY#Ce<cQE|@_n*NrZu>)^8hM<t@c%yx7=Qlqo#E+=&kU8xDhyfmhZ%Ci
zB^dtyV`g~#;=9AYe+-T|4Pa;I2jl<${xZmkvoM^x_?{uwM}|RLMTp_`2UZ3)Hogb%
z@2x(7(}2e(%NV%1Med)x^p}B+U4TJPLyAFJUXtPFBQCJ`lT(!p@9(X`oen;~J|q6|
z@wSPb3!@4d7=I%C`v334k56{?0OcisymvtS3)uihSYBXcWaI%-d^i%^A0P&W@^_&6
hzgP_zx|s<ezyP)2!%xqD#*+X5002ovPDHLkV1nUx>>B_8

literal 0
HcmV?d00001

diff --git a/docs/assets/css/logo.png b/docs/assets/css/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..c82444af95895d38bea6fe96cc5354a7419f770c
GIT binary patch
literal 7143
zcmV<D8yMt?P)<h;3K|Lk000e1NJLTq008O$003wR0{{R3$TFO-0007@P)t-s&e7N@
zH-gsK-M+%iNMNBuSD%THvDVn#HAarCvc0>%$*Zuu-rwWBz{*f-v)|z5tg^kZw!u0~
zlO{BO($v~UUZfl-b-TdHt+Ku{LW;Gz#LLdsP-?Qy(b!LEv9Y$nGD3^4w7)Dldf3_D
zJWrO?*4r&RfK6$yJ583Wu)WyY-%Vz%($w19+~LmA*u}}wPinH(*xkX!%}!~sxV^_q
zWvjTn#y?b@($(9~(%4OAuF%ri)79J4)!T%UyUx+rOJu8sl)L}{0J*)#+1%l+v%b5(
z$-2JCDmjHHHiIZNf+{$LyTHk>w7$2y#k#-9Co*bXWspKke-IjLOI3=tyTog8ndax{
zfrq4ae4-vPgC91BB`tFuHGU*4aTX$Tqo}$!K#ZHAwT+d%kCd(;EO`|ra<jO@Av=s%
zT#X$ne;+M?9xZ_$DR&tseJVte79)5XEPp6Lj^g9yt+Kr*HG-?Kyx`&Gu(rV@HH5FU
zzalSz-rwW0x5Br(#>vdo#>&#g$k5T#*)~UzNMNGG$Iw7gk2OPn(9+pCNQ5#&jW0in
z)z{oaS)e;kmr-i6&Cu6AQku`v*g;mFMOvZC%+$-y)y>b=P-?Qy(bvn()y&V<(bL+~
z*4sy9r%`FK%+A(LW2@KM-r3sV)YjZXRg-CRr^Cn3%FWfv&D2I&m@7Jl*Vx`kU!g)*
zpG8@r)79HZUZyxolQBJb%gxj~ONT>OpDsFeCOe8YNs=^0kJ8lIJ4}d3U!g`>nmJ6B
zM`)`mIfm5N++Jv*SYn<+U!=do%sozut+B(jxy0Gq;43z8mYcpTHhw)#iiC@_qo>0{
zR-Zgfh)PtJ+S}l{zQ`jmeR_efQE9Tcy~o<z;k>}gP*|BOIfd8Q-zz$WhK2J20000(
zbW%=J`1|?v^!csy@b>TT^5*d9<Ll_|_Tkjm#l~gK(;MZmebTFrYn(xUmwx5Ftj*vt
zpMNE3N<o$zTX9voJWC7{C<OqevyM>!02s4LL_t(|UewoRZyZ+?2H-YQt9;6b2BfI5
zRW-F7#Snw6*j}%_&L5kZMP>#wGc$yl%iO=x_fm#-f~K51vOhn1&pG$*7dH;Dx*ctu
zKYVxP`->O9Iej`9425R?`{&EEXD?j%x~93K-QLyG(|hCi>R_n7j<(h-b?3iIr4otg
z&6~?x+kg`3^XD5+pZ<DJ%4M_J!NI{|qpha7y{oGCbEHDqSzC90X(^qK%oAu7P#2^W
zx&i3QjQ6j?WR_S_rBW^)k2l&b6Y%Fl1+%rOdSGa13DSji9_iNB_BM&sx3WT@K)-TI
zlEE4;6bi}4`VM>5=RkFIHdV(40HxB%Yi*=KpN~p6f?M0SU+ze#$s)4?o6B))A(>1z
z)^v3BoMft__EIbcs5a6liPVKi0|6%8@FC%uyMt2_sf^w#uqfv_TQj&Pk?Lr@lm}Fe
zR5PWn-Q6`VU2#DkTK**`$<!*E*lhJXozC*N&Gw!XMa6j5<@0%Mq!AwJGV0;OA8Dq5
z2BOg|S1|O<DG92SF$`=xskN5N=juDUs!j;C8+mG=kfzh?bV>oe>GgVrbS02TkUMAd
zH!8)+uz@uO%dJT##qOXQFWbA1o$9DP1E;xn>Eca{jj2*!G?l>h>I(fWXJk0lU{!1B
zja3uu4y~&-?LEgyZEFHkFU4KTB8`qs3n_~f9gR?f!B;t1)>|{hw>2@xE-voWx3?S<
zwXKdr4T~4hXmo#{OV^0h=Z!F_YjeB+D6>+p@z#m!H?bNluzh_tWP9XP2NJc4G_gOY
zlLpooXwuk8!ADuyY|R)3wqR);Jyj3wQBqZ?dGRJ9b2_Qdo2F8>lM1pTi;@J^@N_aS
zr?RjDJL;^lcOMn?dTm}K)h}K^_0qul(gMkvJSIY84<toaD3&c@NO`bkE7SV5!BQ*g
zYDddaP_MV1$y-fnVt$WH#YWmi+UufyL(g(>LaJzEl}!Vy3)XLHVp4Z(?Jb8*ZH<XY
z_0ZRVrrqwnIkAz}NT&Nk<S{JTcN|h;RfLsG-_gW=y;Wet4INd7NOjcZO_7SbG~(7u
zcadpe3DSjm9%^X$57|Sg{BZ1BHgTmUUKChZ!>5|B9TK&>Hg6GWDv@&cyZ82VbLvIn
zqJ5WL+nX=59*;-ya4eVdlX?65zj6};J8QG|9s;$kT0qUuqjbMXIz2$7WG6*ws6S08
z6R?tCwYg?!u)3$yyRE<q>ue+X_+Y8sO?jhqNi5!ZK;3SgG%z=y3pF_NY;|G+R$Z`)
z@ro^44y?6xHr!lwkW|N|%2P@x_xnLLNQYuXs$Qux_Y}{BM_?6!wI0}#abPW)_|7cR
zUcPo<)YghqnvT#&Rp~U7`qqe)>?HM~c{K&8LXKjT${CI|3~cFrn;6((oBcqjjwZ`U
zQ#{f=?S1MUim~>Mya{!D)q_+O?i5Erp`?pxYKm9~t$x?}iM4EAPQ%1H+|b_h$<$UA
ziqbwBSft{X5z_q_q<kkaY0&jph7+I0C;^$lM-G&z$w^$U_z)<VsCWU;IFtHe<-uBE
zPoa-Lg^GP-Uc7q<j7;e*Ce>xS7yBK#Yuk5w^X@9Pk(#L3zWC^&ffh-TG(nA*;;fQM
z(!jL*C}IRvYej`ozz(D8yFQ-ksJ4tW)o+r%!0JV&hW5pzf~uIO6iiYQDI`j)Y)<(~
z0<{1l%2{@zfBhV~$ZE6?i9$-I6-BKW+K;0`YI&DNZdH)3EeR>!N&J}~ynQ#zg@UPC
z`8t|HVMIxyw5XGJFQd|eR48%qVuF<v_Aqsh;2UY^`WR|wrMomjf5hC^NvC<HZb-GE
zLP|o-YSW~{$<xFi{Nvb3Y8@1Fiefhnq_7Gqx00gHe^F2}=?M8oknD$2Yb_&9^h0X8
zWzfB9`-+`}P;;7nq)@BG788qeHA}V;3QF3(v<MYW_2<nFj(7&cN{h5^STyewa#%Ik
zKZx4fRPlL~0zpVknL=vVNeK1PYK0*caZVPClSLXQimxNyzDd2+xx)%lbT2X`6-MjM
z(xRz885sfeXH-Lb?|V}nbyh!OqN#pE_l_Y`GN;D&U551bcurP(S7K0E!pDlNUPw!Y
zIC_^+{eJ#LB31SiXqj6_!@z=y6CMfEn!O|Xm*vW>e>T{A-jCX8^$v_iF{Z{jh4jS`
zPha=U4~Bw|SGiLv6&_>?lEj8}ir%Jt9~J$56LMb;g{?cBk-~mDs6g^5{hxBPe~Rk7
z;&^`OOn-4EGky7~W5${2q?6hvX~t<ZM*BjI3mF&{(3LbInt+R0UUqPYaz)riSmoAI
zENoXm$=%f@;ilb!sheyf4Ui3cjY8uUhr1R3m7eE3uY2!qY7aZ>O!&o5zUSrpoaYe}
zH@l$4M{SdOB~2f-tt3G;l~N^?6%Y=IO^Q1%kGiAOPUW&f`d+c`z3>eqWj0@k+KpR6
zjPb&OiyyAWNH>DdP11;NqM}n%k;19F#~(%s>PW;tH~26bRjZU0>4NT`yL)5GAjzvW
z4c=Wk@8~9jP0(shprAZ7>!rQrQ8}qsQb~H1glozmsSs6;)QiniB6({&I$J(jAD4?l
z2z0ygse{Lkp6>X15{lID9|{E8PZ&swtlT%GoqF=C8x;%5q_cde{dD^h5~8B`0aC+O
zVKr?N!j?zfQBKnNOQcNyC9?Onht$=Rd>|^Do$<!E+uGV%zK)Or9R*D#>ty3Q-QC?C
zi+X%G(sw7&(-T}ulW9tRq(Rbez6rky9G^Clx_01LPfx3_;BZnK!=jaHA*-z+?DMaD
z3+k@YYce36=dJhZ=kF0x+Iv3+H;88*uTL6Uj`0&|wCQ(kZJjMAveVO0o*2{yPQ~<-
z6g4>#&*t7b4XFRgLgKQ>vM^HcD?sftAb(G_18P^V!wc2ofn_Q~16V$Kyr{dpvy|rU
z?EIIgDQ2%qdK*a<pM<2a<Mu5wQQ;FIsBM6XEtj9vhKaQ|Ici*>rn8E*he)Q=#`!l9
z^_)Ph?A4T}RK%(k#jCqZq9UogN>L`EDFh|Gj-($lQiiIG)Gt=!tTF+WtBMYAY+Tux
z8A8>OG*=Z+BSpv4Nr4JehM_*tkP=LiVUv!8V@4HJAa8%ci@M8Ir6?&*4j>iIK_$J8
zq>9bwKIvlB66v>n)c0jkRgQ{h?{OEZ9*HIeDvZ*sWQ9m@RLeBO5|y@In>JqyO4P<O
zWj{z8*23Yid-6Q>aw*e*gJYh9LdbcFn*P<@lW6)5&8$Ynp7%<cshTF1emDjp9AF95
zbQ%cdF{VgWOP8o1DY_&Z{v?VjngS!2HH@^+?kz%nM&_>4c;{z71yY78NkP*=(6ns&
zUOzX6h6tVRBvUm_4{73t5xy*r8jUP)RHT&07zh<rNnp!jjTiG*f^t<kE5xRqD(Wt#
zkF-a4*Z=A4)zX>{U}d{({w4Y-tJ|NQCRT{{p-HCd<ams&Qs^=TJ`O`QLDdvRO{%OI
zy45cdSVcvLMA{Jq2L)n@slvhuPuA*-{H`BTQNAYo<Z9{O``I-vs@LYv4CUjaVycWM
znX1Vc1i_SN7n`HP@D!+G(*Pd~o1sou7)DX8T3DqOe3oiL&?4S2jct1b>YiuZRZ5ca
zOHc3RTTm3$WAjne#Vkk)m~^x(FjaM`D2OS-DuJ3rL9zAH1=51WQEdekx-a%#?i&!(
z!x`qPqOfAv{8E*ak^UJqg^-%!4*xcgN}r_Kd~grG)ifKPxEIrzs=Byk!ywkLl&T9{
zO>qhrsE#R7*(|M~omU9!l~YFO**(HS5K<;7O~p&h_qyikAQUQu*XE;7^4*WcrZ9#v
zbgpV#va-8kUaLl0LB-TXLDAB0m=aa08b(sgUJ+bX4vHVaNm!rX&5hw!F-xIJfplKh
zshYim-(17=_1b(CwdaHm76AiW5LeX{c}pxViL5}KOq=H=Duxb%nufli8%|#dRGT$l
z-gP1HTbVQ}Xb3(eUfK(&$XfK~a~7wJSJRJGQg=@p>K+&y5gP@l%(%f+HE7Z@e@lJ@
zs<kj_a8#X8k{T5oL5@1*BoZNtx-X27LQVWqIX$dAp56_p$cl}Z{+%xtpHGqWE9gjr
zS0$;}=Fjx37<{16Z5X1q5!46<1%;5PiKIX^P09#z>TDk<P@zBts%1%5<doSPE}6lC
zl^@Nwa7kx|MDvv$2}y4g($Y2`P^*UaW#j5ViCT?JRov<Vr1bKdP&H}vQ&a+qq~^v3
zv-FxsVA~d`3a4rYrI`3F3zcSYSbO?4v2gh@dzt<CvdCUeI)J1Dl9Zy#^hHq@b<|Qu
zqLHea;E-}H#!+oOnP8|JCfnJ|aLS^plxo^?T1g6+0Pon_H$$xoRwR8i@2*oudf}Q&
zRQc+Gi2Ar^)c{aDT}SB_EWuQ@DWHtWWGU2*jRo8Va?pgOjfw=8sGL)L98Zy|9SJbO
zGg~{c14~xW=FyOvz3StY_pnesK8dC8OxM6vM9dRh;!fD8Do4#K20@@YrfzXm10mH=
zP%RZzX01CUDC((ccETW+b}zVB-di3&s=Vy!y+}GoOnw=kgrc@SbRy9SQj-&WuW55t
zxtI*JG-`rxjVut9gq@J6j>Aw33{}E9{1_wtfWWM^4O7R0KnH=SGPZtyR+6fkvh@9v
zdmSo7^;P9{at51F?#`I1D-I9}W4nOgVU7v~dGiiIy}w~`Qb;&@bkTBewGz}}f!b9F
z31=k3U8BICFq8Zq>$|U%zOyMcPl0sq^Kb7-k9(GKujl%wN7RzEmr>Ol4zql8W}+1e
z`P(_Fm7NO!#898Z_hSjZAqzDg>cRgDDk_C@JkDOjE`*SH@4=r=;F;Bf3eLX_sqDVq
zk$MqGtJYTD$mjEQy@g!gm3TG@UY(eO!Opg}%;jMNoB=olyg>sW1l6M*>_AkFRAg-s
zfC8%_;(>^sfJzLJQ*qdjsEYvL9G0k#G(~DF(wq%FiK`6d()sz<%3M#qSUP*>2H!{2
zayEZvf7kKfR_E)g>)<P2y}mD(IyXF#HjUaAkTtWa5hYC%zj2^wy^z0%3I!UfKSqJX
zwiB(q?P%6qkf5Fj6`{&d@>QSAM#v?I>kZpBDybKBhllhtLOOWsc6m{ew5oNHh+3To
zSO`Mg`=F4E)i;m~{s_y^gy5Hj;REdq)dI`cNKjjQdP6o12dzAax{SZ@A)W^n2(c#h
z^hBI^v=P@EHeeN!dT-)>=$WVVA6Hxu-B<P`Bo(5rovg`2)G^pz8il4VK<#W<nH<R`
zO%ofdVI_<Zii)V@(3zYIU`Zx4+fgDMs%<BtE;*VT)d3lk*=RgQHm$?up2TeDl6p~}
zbIsFxkiGam{U7f1mHQ+l^>z6g*Yg<Fy?{zs*L&C3fAa=pa3{n{uBMR7rTY7B#-iD@
z6NO5ps5m+f`$0Wmx}hnqPYWNeKSV?gtR9xAzFs35AC8TWP2)of<z1JTb?3KSI=VU%
zXo{q_zCu#ZK1ueZ%GP_x$%W;*uIG+45Y$Y|N`G!&O-;>%*K79W`pzC~&oI<vBm$f5
zzPqQ9btxHgY!Zot6?T9WMIDI@$EL>86m>ZU_j;pO%DpC*tgp&PwO-VhOVufm&b_bt
zB(|_n(znXj^{yXEwVA<!u62yH=ImEg*36AFg;WZJP4zdQyww4u4Fq-Rd?5!h<_8Rj
z_WP^3*ciNJ8XrkD9i*hkmp{OJ={U6z%flt#u#LE06aNfnX<5`?J?HVgBzy08dXgu7
z*D4#U^MbW5FO#@%X0QcO8#+JqH#Igk9XW8fqX9KV)c#zKz@};`YoPUB{mI5NXHM47
z9Sh=rc(lr1|Bo=#nEUyEi6s7k=K|f^fxn|n8Af_*kbru&`O@ZBb#=X6Ti4tSq#U+a
zG^h1k(_>)8ByQ;5zrVZVXhSBG>COmLj8ydn07153aBc1F_Vxgx2P^qQaiMCg?|=S7
ztnHhh;MvD7e)5r<l!@wHhsyL_3;Ju$o+YGpjI~;J;#|`JVa;@ASRm-pFDUAHs%oyk
z`cx3=l}0OmWA?6I>35@+e>qKApW69^@0Pam$Do{)iR#^)F-Pd@>RMZCsyhp;AT0d2
zI&pRG_lp^Tm9zlb{m|dRP&sSLUm4_#T;TipG4WI;UdvI-{Tmi!jc?oh#IMnId`~4U
z64m{XkXP!v_nLuJ)fGJ=@5D8Qrlrn?7S7plwEO;vsUz>Owp3uOxev}PRs}h2Yakey
zT}hq8=X=OXYxPlnTzO6GW&P3a|Lcw67F=yJ(mSI4N}Df5{Vy$N|Jqg+#&Q1v{b3+O
zeEFeBDNN?uHf`rd>m|8U@7g$<u%=?l(ik(B(MT-UKw3kQvW>m@j{czj(qk1A6|@RE
zBywpmBOOCaxQPFX&pCPS{oWi-2s7z(lRx0Y_xn8go|AJfiAtI-r7XAFDe74W8>R{0
z-`V)>;%oC%TbHhHG<{KHRN?y}tav-Wd;1@PJb(V|n``x~_hC)oF!8&mUpjYosZNmc
zW4`Ke*Z9;Oo*bPV2{lbzfT&1>5mBEf)Z${&W!AisHP6XuC17nkp1s}7wp!Wdc3gOl
z6G0`;5O(vO#!j}i+iGt6tD7~!C#ShxQ<uK3+nc5fb}TH$QD0Ql=zXkdf);Oj%*RY3
z`%2RFSheaBELgdsG0}27Res#I?RZpGPvLS2I^eWPJVJN`3RXh>$X_AMp7(X`KlXnQ
zw2vs#btS4P=3^#h>XrnRPZiS%X@X-Sl_hJ&rV=44vqoUmmmZz9wn~z!3P~X>nzRq9
zQQ46{6AAUNu@>`T-xs8PbIQNO3KKWNS_$I>6~q3eqq2$pkX2}~7*6!yNIZUZ5RUE;
z6|jlk|1h$B$-g%jh*H4@tdJEZW@RNRu>zH4?ZZm6I7Q96qGQL84}N><VTfwldXV<b
zWo8={*QJlDU=Sxm+G&HXKy?%=Ow0vXW`(dYF^?yl?-&I2fN3{BI+G;oT(Tlr(XZUF
zNo3+~U8%&JLfsIK!=zwkNKIFRi4`bL?F@walyU3fXXGT=sl~;7g~|;J!%2^c(`_lN
zLRH%krCs4LD}*)bsta5Dpfidwb_YbAFsxD$^QEY{+|v58TT$ggS41bIiKwtM)(>ey
zO*cJ9md=WH)mbGcI`$w|FoU8#)+^@2zQs%-S>fV_4QN%nM%OxM*iNgaFK+vBuzH%X
zqEEvfd>qqgP}C{9q}#{7gnF7$(Xaul!i0%2iM{eG=}xQ4IH6bp3)ZNvfMwRBhoI=-
zsFMc!-oQ_)A}!|5kbh$g8>os%3=?A#&-k+?DeCV#z8$c_#JydNI8i%#Xt?)R4@X6%
z>8r(jHIp(IVkcwF3KJtbMe=`=8`iT6uWl((J<A3w!bFeR1XfJlp&5AM0Yf6>1v!hF
zDKug+2^#C}S5tIKQnh_=;gljhccbB0V1=&CtHXx6V(JbB6|h0f|Hd?v2z9PemaL(&
zkk!?rQ`>Xm)iW=?T-s9hZF(G?h!wEivq^xJm3;)(9S$mBpL|G<`C(2f%35^G%qk1C
z$ce$SZe}4>m|g$7)Y)-)tK}gQ_ZOCNk371U?}a!%aR8?tBBJJ$s5h5SmL;o#g|1zb
zxS?3v3qO_Q+B_tkUNN(R)YpVP^5CAo?c?y+y?V@NQ8TmEvMR}{>8h=DoI(kkOKVvo
z<>;h0tS+nQeD{w7boi*KsmZZ@TFmdDrt)QGWo5ytt#zzZ^WiR9z2PG|X~G&kd^g_r
zv3IC2^61#U?&+(hQgyi;TV_@Q)nNl+N!1i}>HK^;z4b@aw|M`*4=dB|KlWcWXS32U
z5C?I=Q(J@tp^bqOQ$)zA5JE(hN-FCIXuw0jn<7Y0UL-C>&<F75bNB|HMa)6zMMe5D
z?v~VX{Wo}PwwovTF_~qCh3QOtS}IyyUJ^#dog}hSpG#2A0E_6P+{6hxy1RV5fBGEk
z93%-Iu_pY)fE8yx+$?DuZB5`V=Az21bjZa?VOR!T{}lE(=7X1PIQ){)DM8mkVW+|l
zH|*(-5Yc~mrBxq^`g)pjd6@jhy0XdnzbErjrgYeU3=4;rgbI0E^*1T1qAOr&Chld0
zU5Bz(!ywXWbJUZlL{~<_L~+--rG^!-g0rL9ylTjCsA1_vJQ7vuI@GY+4RC6N>g1Tz
zu*D^ozUx3(iMgfcXs!iN)vyqj8Wz1yUQTdq)v<kj_kmq-LfC@*kFJya{KfJ3CSGvt
zc1P=d;2J0kh3!MwT-V<ZJ4xJgL)(wEUw!seP-<9|9nhk%Hykg3n0ljjea|AgG7e!2
zx{hgu0&;8CX3Lv_=NJksOG$LfRW)5lGB%?bUTF6N+Y2qrHEOjA44YO=(=c4u5`cEl
dE_aK*`wbys)<9*L9Wej^002ovPDHLkV1mbb3%&pV

literal 0
HcmV?d00001

diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
new file mode 100644
index 00000000..cdfe209e
--- /dev/null
+++ b/docs/assets/css/main.css
@@ -0,0 +1,783 @@
+/*
+Font sizes for all selectors other than the body are given in percentages,
+with 100% equal to 13px. To calculate a font size percentage, multiply the
+desired size in pixels by 7.6923076923.
+
+Here's a quick lookup table:
+
+10px - 76.923%
+11px - 84.615%
+12px - 92.308%
+13px - 100%
+14px - 107.692%
+15px - 115.385%
+16px - 123.077%
+17px - 130.769%
+18px - 138.462%
+19px - 146.154%
+20px - 153.846%
+*/
+
+html {
+    background: #fff;
+    color: #333;
+    overflow-y: scroll;
+}
+
+body {
+    /*font: 13px/1.4 'Lucida Grande', 'Lucida Sans Unicode', 'DejaVu Sans', 'Bitstream Vera Sans', 'Helvetica', 'Arial', sans-serif;*/
+    font: 13px/1.4 'Helvetica', 'Arial', sans-serif;
+    margin: 0;
+    padding: 0;
+}
+
+/* -- Links ----------------------------------------------------------------- */
+a {
+    color: #356de4;
+    text-decoration: none;
+}
+
+.hidden {
+    display: none;
+}
+
+a:hover { text-decoration: underline; }
+
+/* "Jump to Table of Contents" link is shown to assistive tools, but hidden from
+   sight until it's focused. */
+.jump {
+    position: absolute;
+    padding: 3px 6px;
+    left: -99999px;
+    top: 0;
+}
+
+.jump:focus { left: 40%; }
+
+/* -- Paragraphs ------------------------------------------------------------ */
+p { margin: 1.3em 0; }
+dd p, td p { margin-bottom: 0; }
+dd p:first-child, td p:first-child { margin-top: 0; }
+
+/* -- Headings -------------------------------------------------------------- */
+h1, h2, h3, h4, h5, h6 {
+    color: #D98527;/*was #f80*/
+    font-family: 'Trebuchet MS', sans-serif;
+    font-weight: bold;
+    line-height: 1.1;
+    margin: 1.1em 0 0.5em;
+}
+
+h1 {
+    font-size: 184.6%;
+    color: #30418C;
+    margin: 0.75em 0 0.5em;
+}
+
+h2 {
+    font-size: 153.846%;
+    color: #E48A2B;
+}
+
+h3 { font-size: 138.462%; }
+
+h4 {
+    border-bottom: 1px solid #DBDFEA;
+    color: #E48A2B;
+    font-size: 115.385%;
+    font-weight: normal;
+    padding-bottom: 2px;
+}
+
+h5, h6 { font-size: 107.692%; }
+
+/* -- Code and examples ----------------------------------------------------- */
+code, kbd, pre, samp {
+    font-family: Menlo, Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Courier New', Courier, monospace;
+    font-size: 92.308%;
+    line-height: 1.35;
+}
+
+p code, p kbd, p samp, li code {
+    background: #FCFBFA;
+    border: 1px solid #EFEEED;
+    padding: 0 3px;
+}
+
+a code, a kbd, a samp,
+pre code, pre kbd, pre samp,
+table code, table kbd, table samp,
+.intro code, .intro kbd, .intro samp,
+.toc code, .toc kbd, .toc samp {
+    background: none;
+    border: none;
+    padding: 0;
+}
+
+pre.code, pre.terminal, pre.cmd {
+    overflow-x: auto;
+    *overflow-x: scroll;
+    padding: 0.3em 0.6em;
+}
+
+pre.code {
+    background: #FCFBFA;
+    border: 1px solid #EFEEED;
+    border-left-width: 5px;
+}
+
+pre.terminal, pre.cmd {
+    background: #F0EFFC;
+    border: 1px solid #D0CBFB;
+    border-left: 5px solid #D0CBFB;
+}
+
+/* Don't reduce the font size of <code>/<kbd>/<samp> elements inside <pre>
+   blocks. */
+pre code, pre kbd, pre samp { font-size: 100%; }
+
+/* Used to denote text that shouldn't be selectable, such as line numbers or
+   shell prompts. Guess which browser this doesn't work in. */
+.noselect {
+    -moz-user-select: -moz-none;
+    -khtml-user-select: none;
+    -webkit-user-select: none;
+    -o-user-select: none;
+    user-select: none;
+}
+
+/* -- Lists ----------------------------------------------------------------- */
+dd { margin: 0.2em 0 0.7em 1em; }
+dl { margin: 1em 0; }
+dt { font-weight: bold; }
+
+/* -- Tables ---------------------------------------------------------------- */
+caption, th { text-align: left; }
+
+table {
+    border-collapse: collapse;
+    width: 100%;
+}
+
+td, th {
+    border: 1px solid #fff;
+    padding: 5px 12px;
+    vertical-align: top;
+}
+
+td { background: #E6E9F5; }
+td dl { margin: 0; }
+td dl dl { margin: 1em 0; }
+td pre:first-child { margin-top: 0; }
+
+th {
+    background: #D2D7E6;/*#97A0BF*/
+    border-bottom: none;
+    border-top: none;
+    color: #000;/*#FFF1D5*/
+    font-family: 'Trebuchet MS', sans-serif;
+    font-weight: bold;
+    line-height: 1.3;
+    white-space: nowrap;
+}
+
+
+/* -- Layout and Content ---------------------------------------------------- */
+#doc {
+    margin: auto;
+    min-width: 1024px;
+}
+
+.content { padding: 0 20px 0 25px; }
+
+.sidebar {
+    padding: 0 15px 0 10px;
+}
+#bd {
+    padding: 7px 0 130px;
+    position: relative;
+    width: 99%;
+}
+
+/* -- Table of Contents ----------------------------------------------------- */
+
+/* The #toc id refers to the single global table of contents, while the .toc
+   class refers to generic TOC lists that could be used throughout the page. */
+
+.toc code, .toc kbd, .toc samp { font-size: 100%; }
+.toc li { font-weight: bold; }
+.toc li li { font-weight: normal; }
+
+/* -- Intro and Example Boxes ----------------------------------------------- */
+/*
+.intro, .example { margin-bottom: 2em; }
+.example {
+    -moz-border-radius: 4px;
+    -webkit-border-radius: 4px;
+    border-radius: 4px;
+    -moz-box-shadow: 0 0 5px #bfbfbf;
+    -webkit-box-shadow: 0 0 5px #bfbfbf;
+    box-shadow: 0 0 5px #bfbfbf;
+    padding: 1em;
+}
+.intro {
+    background: none repeat scroll 0 0 #F0F1F8; border: 1px solid #D4D8EB; padding: 0 1em;
+}
+*/
+
+/* -- Other Styles ---------------------------------------------------------- */
+
+/* These are probably YUI-specific, and should be moved out of Selleck's default
+   theme. */
+
+.button {
+    border: 1px solid #dadada;
+    -moz-border-radius: 3px;
+    -webkit-border-radius: 3px;
+    border-radius: 3px;
+    color: #444;
+    display: inline-block;
+    font-family: Helvetica, Arial, sans-serif;
+    font-size: 92.308%;
+    font-weight: bold;
+    padding: 4px 13px 3px;
+    -moz-text-shadow: 1px 1px 0 #fff;
+    -webkit-text-shadow: 1px 1px 0 #fff;
+    text-shadow: 1px 1px 0 #fff;
+    white-space: nowrap;
+
+    background: #EFEFEF; /* old browsers */
+    background: -moz-linear-gradient(top, #f5f5f5 0%, #efefef 50%, #e5e5e5 51%, #dfdfdf 100%); /* firefox */
+    background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#f5f5f5), color-stop(50%,#efefef), color-stop(51%,#e5e5e5), color-stop(100%,#dfdfdf)); /* webkit */
+    filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f5f5f5', endColorstr='#dfdfdf',GradientType=0 ); /* ie */
+}
+
+.button:hover {
+    border-color: #466899;
+    color: #fff;
+    text-decoration: none;
+    -moz-text-shadow: 1px 1px 0 #222;
+    -webkit-text-shadow: 1px 1px 0 #222;
+    text-shadow: 1px 1px 0 #222;
+
+    background: #6396D8; /* old browsers */
+    background: -moz-linear-gradient(top, #6396D8 0%, #5A83BC 50%, #547AB7 51%, #466899 100%); /* firefox */
+    background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#6396D8), color-stop(50%,#5A83BC), color-stop(51%,#547AB7), color-stop(100%,#466899)); /* webkit */
+    filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#6396D8', endColorstr='#466899',GradientType=0 ); /* ie */
+}
+
+.newwindow { text-align: center; }
+
+.header .version em {
+    display: block;
+    text-align: right;
+}
+
+
+#classdocs .item {
+    border-bottom: 1px solid #466899;
+    margin: 1em 0;
+    padding: 1.5em;
+}
+
+#classdocs .item .params p,
+    #classdocs .item .returns p,{
+    display: inline;
+}
+
+#classdocs .item em code, #classdocs .item em.comment {
+    color: green;
+}
+
+#classdocs .item em.comment a {
+    color: green;
+    text-decoration: underline;
+}
+
+#classdocs .foundat {
+    font-size: 11px;
+    font-style: normal;
+}
+
+.attrs .emits {
+    margin-left: 2em;
+    padding: .5em;
+    border-left: 1px dashed #ccc;
+}
+
+abbr {
+    border-bottom: 1px dashed #ccc;
+    font-size: 80%;
+    cursor: help;
+}
+
+.prettyprint li.L0, 
+.prettyprint li.L1, 
+.prettyprint li.L2, 
+.prettyprint li.L3, 
+.prettyprint li.L5, 
+.prettyprint li.L6, 
+.prettyprint li.L7, 
+.prettyprint li.L8 {
+    list-style: decimal;
+}
+
+ul li p {
+    margin-top: 0;
+}
+
+.method .name {
+    font-size: 110%;
+}
+
+.apidocs .methods .extends .method,
+.apidocs .properties .extends .property,
+.apidocs .attrs .extends .attr,
+.apidocs .events .extends .event {
+    font-weight: bold;
+}
+
+.apidocs .methods .extends .inherited,
+.apidocs .properties .extends .inherited,
+.apidocs .attrs .extends .inherited,
+.apidocs .events .extends .inherited {
+    font-weight: normal;
+}
+
+#hd {
+    background: whiteSmoke;
+    background: -moz-linear-gradient(top,#DCDBD9 0,#F6F5F3 100%);
+    background: -webkit-gradient(linear,left top,left bottom,color-stop(0%,#DCDBD9),color-stop(100%,#F6F5F3));
+    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#dcdbd9',endColorstr='#F6F5F3',GradientType=0);
+    border-bottom: 1px solid #DFDFDF;
+    padding: 0 15px 1px 20px;
+    margin-bottom: 15px;
+}
+
+#hd img {
+    margin-right: 10px;
+    vertical-align: middle;
+}
+
+
+/* -- API Docs CSS ---------------------------------------------------------- */
+
+/*
+This file is organized so that more generic styles are nearer the top, and more
+specific styles are nearer the bottom of the file. This allows us to take full
+advantage of the cascade to avoid redundant style rules. Please respect this
+convention when making changes.
+*/
+
+/* -- Generic TabView styles ------------------------------------------------ */
+
+/*
+These styles apply to all API doc tabviews. To change styles only for a
+specific tabview, see the other sections below.
+*/
+
+.yui3-js-enabled .apidocs .tabview {
+    visibility: hidden; /* Hide until the TabView finishes rendering. */
+    _visibility: visible;
+}
+
+.apidocs .tabview.yui3-tabview-content { visibility: visible; }
+.apidocs .tabview .yui3-tabview-panel { background: #fff; }
+
+/* -- Generic Content Styles ------------------------------------------------ */
+
+/* Headings */
+h2, h3, h4, h5, h6 {
+    border: none;
+    color: #30418C;
+    font-weight: bold;
+    text-decoration: none;
+}
+
+.link-docs {
+    float: right;
+    font-size: 15px;
+    margin: 4px 4px 6px;
+    padding: 6px 30px 5px;
+}
+
+.apidocs { zoom: 1; }
+
+/* Generic box styles. */
+.apidocs .box {
+    border: 1px solid;
+    border-radius: 3px;
+    margin: 1em 0;
+    padding: 0 1em;
+}
+
+/* A flag is a compact, capsule-like indicator of some kind. It's used to
+   indicate private and protected items, item return types, etc. in an
+   attractive and unobtrusive way. */
+.apidocs .flag {
+    background: #bababa;
+    border-radius: 3px;
+    color: #fff;
+    font-size: 11px;
+    margin: 0 0.5em;
+    padding: 2px 4px 1px;
+}
+
+/* Class/module metadata such as "Uses", "Extends", "Defined in", etc. */
+.apidocs .meta {
+    background: #f9f9f9;
+    border-color: #efefef;
+    color: #555;
+    font-size: 11px;
+    padding: 3px 6px;
+}
+
+.apidocs .meta p { margin: 0; }
+
+/* Deprecation warning. */
+.apidocs .box.deprecated,
+.apidocs .flag.deprecated {
+    background: #fdac9f;
+    border: 1px solid #fd7775;
+}
+
+.apidocs .box.deprecated p { margin: 0.5em 0; }
+.apidocs .flag.deprecated { color: #333; }
+
+/* Module/Class intro description. */
+.apidocs .intro {
+    background: #f0f1f8;
+    border-color: #d4d8eb;
+}
+
+/* Loading spinners. */
+#bd.loading .apidocs,
+#api-list.loading .yui3-tabview-panel {
+    background: #fff url(../img/spinner.gif) no-repeat center 70px;
+    min-height: 150px;
+}
+
+#bd.loading .apidocs .content,
+#api-list.loading .yui3-tabview-panel .apis {
+    display: none;
+}
+
+.apidocs .no-visible-items { color: #666; }
+
+/* Generic inline list. */
+.apidocs ul.inline {
+    display: inline;
+    list-style: none;
+    margin: 0;
+    padding: 0;
+}
+
+.apidocs ul.inline li { display: inline; }
+
+/* Comma-separated list. */
+.apidocs ul.commas li:after { content: ','; }
+.apidocs ul.commas li:last-child:after { content: ''; }
+
+/* Keyboard shortcuts. */
+kbd .cmd { font-family: Monaco, Helvetica; }
+
+/* -- Generic Access Level styles ------------------------------------------- */
+.apidocs .item.protected,
+.apidocs .item.private,
+.apidocs .index-item.protected,
+.apidocs .index-item.deprecated,
+.apidocs .index-item.private {
+    display: none;
+}
+
+.show-deprecated .item.deprecated,
+.show-deprecated .index-item.deprecated,
+.show-protected .item.protected,
+.show-protected .index-item.protected,
+.show-private .item.private,
+.show-private .index-item.private {
+    display: block;
+}
+
+.hide-inherited .item.inherited,
+.hide-inherited .index-item.inherited {
+    display: none;
+}
+
+/* -- Generic Item Index styles --------------------------------------------- */
+.apidocs .index { margin: 1.5em 0 3em; }
+
+.apidocs .index h3 {
+    border-bottom: 1px solid #efefef;
+    color: #333;
+    font-size: 13px;
+    margin: 2em 0 0.6em;
+    padding-bottom: 2px;
+}
+
+.apidocs .index .no-visible-items { margin-top: 2em; }
+
+.apidocs .index-list {
+    border-color: #efefef;
+    font-size: 12px;
+    list-style: none;
+    margin: 0;
+    padding: 0;
+    -moz-column-count: 4;
+    -moz-column-gap: 10px;
+    -moz-column-width: 170px;
+    -ms-column-count: 4;
+    -ms-column-gap: 10px;
+    -ms-column-width: 170px;
+    -o-column-count: 4;
+    -o-column-gap: 10px;
+    -o-column-width: 170px;
+    -webkit-column-count: 4;
+    -webkit-column-gap: 10px;
+    -webkit-column-width: 170px;
+    column-count: 4;
+    column-gap: 10px;
+    column-width: 170px;
+}
+
+.apidocs .no-columns .index-list {
+    -moz-column-count: 1;
+    -ms-column-count: 1;
+    -o-column-count: 1;
+    -webkit-column-count: 1;
+    column-count: 1;
+}
+
+.apidocs .index-item { white-space: nowrap; }
+
+.apidocs .index-item .flag {
+    background: none;
+    border: none;
+    color: #afafaf;
+    display: inline;
+    margin: 0 0 0 0.2em;
+    padding: 0;
+}
+
+/* -- Generic API item styles ----------------------------------------------- */
+.apidocs .args {
+    display: inline;
+    margin: 0 0.5em;
+}
+
+.apidocs .flag.chainable { background: #46ca3b; }
+.apidocs .flag.protected { background: #9b86fc; }
+.apidocs .flag.private { background: #fd6b1b; }
+.apidocs .flag.async { background: #356de4; }
+.apidocs .flag.required { background: #e60923; }
+
+.apidocs .item {
+    border-bottom: 1px solid #efefef;
+    margin: 1.5em 0 2em;
+    padding-bottom: 2em;
+}
+
+.apidocs .item h4,
+.apidocs .item h5,
+.apidocs .item h6 {
+    color: #333;
+    font-family: inherit;
+    font-size: 100%;
+}
+
+.apidocs .item .description p,
+.apidocs .item pre.code {
+    margin: 1em 0 0;
+}
+
+.apidocs .item .meta {
+    background: none;
+    border: none;
+    padding: 0;
+}
+
+.apidocs .item .name {
+    display: inline;
+    font-size: 14px;
+}
+
+.apidocs .item .type,
+.apidocs .item .type a,
+.apidocs .returns-inline {
+    color: #555;
+}
+
+.apidocs .item .type,
+.apidocs .returns-inline {
+    font-size: 11px;
+    margin: 0 0 0 0;
+}
+
+.apidocs .item .type a { border-bottom: 1px dotted #afafaf; }
+.apidocs .item .type a:hover { border: none; }
+
+/* -- Item Parameter List --------------------------------------------------- */
+.apidocs .params-list {
+    list-style: square;
+    margin: 1em 0 0 2em;
+    padding: 0;
+}
+
+.apidocs .param { margin-bottom: 1em; }
+
+.apidocs .param .type,
+.apidocs .param .type a {
+    color: #666;
+}
+
+.apidocs .param .type {
+    margin: 0 0 0 0.5em;
+    *margin-left: 0.5em;
+}
+
+.apidocs .param-name { font-weight: bold; }
+
+/* -- Item "Emits" block ---------------------------------------------------- */
+.apidocs .item .emits {
+    background: #f9f9f9;
+    border-color: #eaeaea;
+}
+
+/* -- Item "Returns" block -------------------------------------------------- */
+.apidocs .item .returns .type,
+.apidocs .item .returns .type a {
+    font-size: 100%;
+    margin: 0;
+}
+
+/* -- Class Constructor block ----------------------------------------------- */
+.apidocs .constructor .item {
+    border: none;
+    padding-bottom: 0;
+}
+
+/* -- File Source View ------------------------------------------------------ */
+.apidocs .file pre.code,
+#doc .apidocs .file pre.prettyprint {
+    background: inherit;
+    border: none;
+    overflow: visible;
+    padding: 0;
+}
+
+.apidocs .L0,
+.apidocs .L1,
+.apidocs .L2,
+.apidocs .L3,
+.apidocs .L4,
+.apidocs .L5,
+.apidocs .L6,
+.apidocs .L7,
+.apidocs .L8,
+.apidocs .L9 {
+    background: inherit;
+}
+
+/* -- Submodule List -------------------------------------------------------- */
+.apidocs .module-submodule-description {
+    font-size: 12px;
+    margin: 0.3em 0 1em;
+}
+
+.apidocs .module-submodule-description p:first-child { margin-top: 0; }
+
+/* -- Sidebar TabView ------------------------------------------------------- */
+#api-tabview { margin-top: 0.6em; }
+
+#api-tabview-filter,
+#api-tabview-panel {
+    border: 1px solid #dfdfdf;
+}
+
+#api-tabview-filter {
+    border-bottom: none;
+    border-top: none;
+    padding: 0.6em 10px 0 10px;
+}
+
+#api-tabview-panel { border-top: none; }
+#api-filter { width: 97%; }
+
+/* -- Content TabView ------------------------------------------------------- */
+#classdocs .yui3-tabview-panel { border: none; }
+
+/* -- Source File Contents -------------------------------------------------- */
+.prettyprint li.L0,
+.prettyprint li.L1,
+.prettyprint li.L2,
+.prettyprint li.L3,
+.prettyprint li.L5,
+.prettyprint li.L6,
+.prettyprint li.L7,
+.prettyprint li.L8 {
+    list-style: decimal;
+}
+
+/* -- API options ----------------------------------------------------------- */
+#api-options {
+    font-size: 11px;
+    margin-top: 2.2em;
+    position: absolute;
+    right: 1.5em;
+}
+
+/*#api-options label { margin-right: 0.6em; }*/
+
+/* -- API list -------------------------------------------------------------- */
+#api-list {
+    margin-top: 1.5em;
+    *zoom: 1;
+}
+
+.apis {
+    font-size: 12px;
+    line-height: 1.4;
+    list-style: none;
+    margin: 0;
+    padding: 0.5em 0 0.5em 0.4em;
+}
+
+.apis a {
+    border: 1px solid transparent;
+    display: block;
+    margin: 0 0 0 -4px;
+    padding: 1px 4px 0;
+    text-decoration: none;
+    _border: none;
+    _display: inline;
+}
+
+.apis a:hover,
+.apis a:focus {
+    background: #E8EDFC;
+    background: -moz-linear-gradient(top, #e8edfc 0%, #becef7 100%);
+    background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#E8EDFC), color-stop(100%,#BECEF7));
+    border-color: #AAC0FA;
+    border-radius: 3px;
+    color: #333;
+    outline: none;
+}
+
+.api-list-item a:hover,
+.api-list-item a:focus {
+    font-weight: bold;
+    text-shadow: 1px 1px 1px #fff;
+}
+
+.apis .message { color: #888; }
+.apis .result a { padding: 3px 5px 2px; }
+
+.apis .result .type {
+    right: 4px;
+    top: 7px;
+}
+
+.api-list-item .yui3-highlight {
+    font-weight: bold;
+}
+
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..414ac4fb9e145171ae8f660e51879e18c401e653
GIT binary patch
literal 5430
zcmdT|c~n&A6@SF^c=}JZwQU+rgHaP#WKr3f0cL=KVVglvkVQZiQDfDk(FA2t0)iWh
zY=W#JA~S%vRZzjDF`C4MRAU4c7u+h2MgbA{^?q-_;)qB%w&!%tx#zw2&G&uxzWd$#
zyTAK5PK$ew8$O()>u4_YeUAH#<G9hI)z8H=zKO;r&=}p)4D~o&IF80Oe*n1t<Z1K6
zKRmqA_(^|rH2-`0;NGZn%A!TPmIm)%XRdcU$xV71U0qt5^ZI&jI#cUW7Akv~AvMGX
z!4yR3kHKn#@hz%5O(Xl7uQ~Q@VS0>Wt}S-?OOYwFzy>RQteQ9yKUN)d(VW}sS?gZ?
zPx|>Q!Vau3)9EakCq-qL90hZ1ks>ulgswI!)`q9{n*WN=S|2z6sbrBy(?+QgBE*JB
zlnJnZksB2AoRK}#3JJogNS28kUOaCb+SeXkot@mC@Q@R^-quL*5MiyIF?RYpVBbPF
z?DVronzI>VjK-tk)Cp_N^|bcAW9b_=#|x%(<@s2lFu)#3Gp(_~*#hPBT~HA!L*8sL
z5-cX6B63B6=K7xxlrGM9x4<?xOKf#A!47{B3TTflZe)wQ6)G3Vu{+QS87^i>v^V+X
z@!h76dhelXtk*db8Fs$J#|HUcwzQ80?IA{iKik6!8Kj%}a)*xu8-<f`EHf#(_j-2U
z`sl%5j>j)QTIwf8F}-ijENc|feZIeh-y_r024x{G$d+3m-A#1A<x%qp%{@BW+lF2!
zO5Ic*<bd6NcKq4pdyA1v_v~HLJZSH^4oDK~;&@i_Yc}-kcdzb@P0hN`zhyC0<RwC`
zrwH4<Y<N31xeDq1gvgKy9;=#eecZD~^V<31#rusX4|yMpTXtL#=-8PfH={E&!3KLH
zthF`7*MiB|8?}75=DNO~RgG7s{(MmJw_}M>#mc4rKV*4JZ^cW^A4gm2x16n1`1ZBt
zO=A=*TCJ+)5vp5_WA9%1Y4U@{YvUl~xHfH$Q*}!uT_cBaTn!1wWT;vqhtL>_N{i-`
zfQE5hjWeU^-jamj5&vVrqw#x_P5&?BEJq*RzBTINkt&-zmoH8FU)Zf`y7|$CeM+xA
z(W}x^+#S9n9DFkWk3*qYvohtsrN85O+mNd#4m%%+URIj!DtH`gG9FO|pJ4UW(O5P4
zV=U1gfmAQ~(RZ!C<9X}QhQpQqhr&a@FPv?KZLX$BC)`V-oY`Qlj~LU*h?w>%R!kU$
zNMoJ*&mJ`of0s5qz27vdJlL^Q8R!6IkPDAj+X?^DoJ_IBb_Ui9bg|ZGBEogYVA<FY
zP=D&A#k<tc_Bxrc;z-#%2UN^wnCnP*YJ+WZ0bheQiVP5Iu7ju<pJD0f5vWSp{N+2-
z-v#c6!-wn(!aUDchB{#n;dNPvD_?tZW{HsQVvZz<ArdV0u+C%>R!$g+%(=6w-i7}9
zGv5f)!~Cij>W#&6W2#YMu2gemybnsLeinM$A#0{3QXNgO*=9Q81XB??Z5*PFr>LIX
zzxU_C+R*w~HLNN*HaX7TxO0uAF21swh9$;2*fv{4wOdX;U^d8j9+BrM=D9?2cPxHw
zHko|zA<plwm^m2z&5c(klrEW5mnt(uvbzWyTm)DrF~KUK0V2gSNVf~sOc{R;%3xO%
z`AV?egK8M%1B=CYp)SIw{1qiD7v~RF|Be8gmONh@WP3}9a}Ylu8`hEyD+LC~q%+^Y
zkbFSzuZ~406!5iOsE$SPG{hKBK)l%KZj0*Cu))}HxmqzV-$#J_xsq-hM7#~r#C;;j
z2c<zy*h_KH6N|-u4#*|DGF-c3(Mk_%rfQ?^V5R)m>hEZ8A5t0fRZ5n-33diaUb7+6
z#t55SEV}ipZBPWMV=<e>B4GlH#pvl{v2#gq*{{)09Pl?4tC#GInl=Ur)_N!k6r*Tf
z-!^1Z{_k6;)?X1SM@fJq)UimI;9yMos7v{v`|RP3>)Hdcp{uiltBw!PPb3bMOuRP1
z+JLTx*cC!tXPzDJhb%rGM2IK;$YQcMK&tiwVG@rCzQoTc78y1t+8H96-lKL~@~XG$
zC;oq7cg~l&Zsy1(PRRIXs*@Qu*~~zO+!Q6DcGwYUhdhdh9vkAE%(33l9Lf-9-Ub$n
zrNl)UFV7+#wpD6E+*${zGi|T5x3=`jt$XYuo;t2P)VW1TamD<|aE0YmhN}e<B}T}e
zW%0TVl$&v+f3r+Tama8<j&kDDj7PF}U~7}?4H0AbDe4YXc=YJ%>&iIc<$cAAl>WBF
z$z7occH!}rohRdzDN<A9%od;|MC}Kb7t9X~A7aUd6zU@wCRBz|U(sEkvb*b30`*CG
zL7pcWzw1kP?=iArp)!DMAfK{#DWN*k<BK%H`JCB8><YH!&qC9NH1Zeo0Xqlg!<Y4m
zVlmEiBI^HfOw?P~o9?e3t@J4macn6MmUd$t`GS0!M?621e7${^5XC|2n9TDdKg_XH
z`$1}sG{S(r>>NU5uhb{jD;6&f{QH}9YL4GIf68+I(%Fs506Vfl#`}WRT;>br*K7|<
z6b0C*^P;y6j%G-u9*yA=j|nUm2@|$bKCvF`+L>?6HFdq|`IkF4v}<FRR4L|)DJEQA
z@db;oY<Ei(_=^6Mo8*Ti77tRY8x#-h{B|=;pt+gUb8fWM!OqY9tGl|oUg=NYq@Rs<
zv_Bv6<L<206~WTBvOq~MUpT4b!rdA<p45*~+_HWwYmVfl4Xht3p?qXL8_$)TO%YFh
z=H=RIhyHZ-_1}X_=ZtFBEviva??^n1cz_&A%8{O2%l5EBuD9qVKJa-#@eoJ8$R)oN
zF`htqv_-6k9Dld73}^e&)8AO<i}v^G4=I8UF86L=XHp*QL_IY5nBK7`N3tj`w$CA6
zM*5fy3?Ep{+A6n1em75uH=l^p#d!<*)79U9ZK~$qUo6l2;^1<h28BQMzVtmp8SKpa
zg5gCLVP_`ATn6Pr5}nU_!s-aBS#kEJ$Rr=6Iv63v$@~HJsH6JR^S1w<KT-Xzp}NAq
zCT4Lh;l+zmKl-lXYllLLc^*3{=28hW5~)@)oMtwxww{5F4kp-SIR#Ybir=PVK>t%b
zH#c0;xmcFBvNm?v(TW8#n|F9wBU@&QH2UU}BAJfOw$l+$H969H8dh59VYN`7xatI4
z*sJgvkPga)fzEsO;O>V_XHSXilm*Lcw?yStd=Y%2FhF)K)6H77MPm3omN;rS^$N@M
z#vn?d_vB{XIsJj|J=l5et<Qe@^k4TsXuffET+=_#PrrHYJChq{&zN5Q{<O)XJGTe)
z?QF2R2e^)=Z3fziF4mB6RIZsss;?c~5U5D5^P)xfT6C|48v4w@ggz%kbc>Llh1W?`
c9H-qz(m`J;Xu?oLlCTZhNI;9}q1!h68y;F)#sB~S

literal 0
HcmV?d00001

diff --git a/docs/assets/img/spinner.gif b/docs/assets/img/spinner.gif
new file mode 100644
index 0000000000000000000000000000000000000000..44f96ba68c8910d19f49e8365bf589ee4e6991e4
GIT binary patch
literal 2685
zcmeH{YfzJC8iv0w0RzSmAjy&hC;`H$F$shaAO<od`S>6#w1ZBuqOP1eV&xzQwK$cK
zkb?<_1QC!z6+{~vj><7mpp+3&q{5Dt1$U9<3{C|V26e`6+}0U?@ONkSN8g|C`^+=f
zec#XX!r`F-fpJ8D2y6j>udlD4pC5<AiH(gtdh}>oT3UK~dPYWuR4SFpWW~kBI-Ty)
zrAvCf-e52^Ha2#4cJ}o23=R&CjEszqjy`(yXliO|W@ct?Ztm&Rr_Y~1-`w1M{ra`P
zzkftTL}X-Se0+RDLPBO{W_EUVPEL+SqbVvXDlILot*vcoY3b|h8y+6Md-v|chYzQx
zr)Otp7Z(>-R#u)pd$zv5zO}Wry}hkaD7w13`uqDQCnp;k8k(A#mX?;**48#QHr~8>
zlai8BUtizc+}zvSJ3l}F;>C+2M~>XPckkuPmqw%U)vH&B4<82pkB{?j=qTvGeqqR`
z5R2iB1Wl->t8k$(8WzAl-af1_0N4}u*W}bRgf#%9q-JH99w-MtKSV)|0SLen*ai3i
zKwLs*dgT7l1Mh@}LqbZXsptdIrmkC${_G3<>BH|s@jv$AEj=<WF^LlY6(u4gE;BhL
zIU|k|m2@KEc+%-OiszX#XBa2b;u4cnzer=GCS`d6&aceC-GC#o_Z{84e+e+JIOb85
znEdS*?htuZec8qg-YSW`ovrgm>AulRJ-t~vQzbstTBdj1f9x+OI}c{HEGJTIo)-S3
zvXu@V5Ze5s?o^rjP2oAJZBgJ43EeZab1q+7T3AZ*>`$M~Ip=VyAkWdBfV0!N;IWlu
zD(gxt-qC?f-Y0OdwW^d52?XMe&uMsja#IsM*&(x|vpcV`xxBXSr!40`V8IVychwC@
z(!=(Wi*J)OEFo9!i_1H9B3S81`;tp(L9|zFZVRfT#e-Mxsdc=o%{qm6GUnDq8#@+w
z>zp9;^*C*b0a>)OpldGR<O6#t@SzyTT&f@J`!N<@1+g(M?%tt(-rlt_^?R|{y^T#m
zpVn4=yQs6v*dy?3x!E@GeZv6k$6~TZMBelXX^$Ucg3kO|z?>YLW-}Rgrhi;mT3&%e
zb^^cg9z2rK8N!u+qrAU$JXq=Q<ycwRWCj=&IyV}YijR`7H6{|}qP06Z-mjM;6Q&+u
z-&%eqviCoO#ew#OuRwGz5=DaX3cFB$v)nxnust1TR|PrvqcJ6+<ir?|6cC_~BWj4X
zVI&j)pbTUJU1JFIHyQ&3eHy|bJY;kn7Th8bV@T#ko#^|HB>$F%*?-T?FD#nCSJ%RJ
zM8EzX-KiKhdEPdX+W9(2!>6Tj7tGHG(@GXIHcI#ZvuG)z`cvk-VdBK*c|$UxeEHgt
zh|eHoo#Hc@pK-so^azG|S%hK;SFlf#7sO=2{OEwvn5bYJuJ)RU<z{B)uCE7aW=NzN
zzEwnPZ^U&A4IRz>!t37+vAHhjqeCDD7^hxtbsYzs?)RgAac-&SQ9q*ejs5N9;>zmK
zPUNUo2`H82%N0r`1gQ%0iFCS%U#Nn#S`7$YER~j(tMN9rtZI;7tOElDR#vuErF^v%
z*JNdL`G(A{(F)h2u*1<?f6Rvh1C7H_2!~@e+C%49Sa9ryr4J`Lfzy>gkN>^r%0ek*
zgATbqYlGa_bGv|KZA}7qZy-^>7P2IOH6RK_p0{{FP*Z?`0Sgup2zfAw7b+2os*;)q
z+5#lPY#aSu@*Qn1b)Pw6htWZ`zgMBUpw<*<ObYlS1~W`6529Bx%kxE*bVhMC$hs=3
zld+gV_3{$twK_fxi-m8Ni#o7g`Z{JWw!fMWcXTzCh`OaBcNa`qGamafS;?mYfFnkM
z=U7^L-3LWZj{#RcnMPxQ*f|b*Qck9<Zn=db-N*;1*2?%pHLet%cKOuM4B!g0>kdk!
zI2X()g6*)r9wu>OjUHjg4XG}it7AJ{SYC~${GkN#!S<pI62$L${8vd~QL$E6a<NoJ
z5{8os#1NEELV=)prCMalNoH&MIl*u>q}P9oXlOJoAHCyhZJk<7)Dy2%T-Q`9NtoT?
zY$ef_KCTe&F^x^D+|KF=eiSu@+>KzjBXCcw!o>=<#ex+Z!{Kbw1y5|(6?AL-F>Q@`
zuo>r&XN^`QxOtZJWT7R`yM{vkjX0hzY5o_L9GG#?(B^5qQxb*`lhBZP;sO;+aia2c
zCaZudbVWYTsS0qtA`?@uVQ$EHXcr9BK!#y*gOuzZfplYa;d_x0w1J4;p)O;uTj$;O
zv99g_E?%o3GlPCna4l!>3Kn6$TmgB^SaLxzk9U(vpJzOlL7uAtVwlUNiF4YB+lX<^
pE|2Kr%d?-r>ImN9F0EXz^8E;tU2&^Zb%igPc${)^%gY+r_aA#xUsC`8

literal 0
HcmV?d00001

diff --git a/docs/assets/index.html b/docs/assets/index.html
new file mode 100644
index 00000000..487fe15b
--- /dev/null
+++ b/docs/assets/index.html
@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+    <head>
+        <title>Redirector</title>
+        <meta http-equiv="refresh" content="0;url=../">
+    </head>
+    <body>
+        <a href="../">Click here to redirect</a>
+    </body>
+</html>
diff --git a/docs/assets/js/api-filter.js b/docs/assets/js/api-filter.js
new file mode 100644
index 00000000..d442e543
--- /dev/null
+++ b/docs/assets/js/api-filter.js
@@ -0,0 +1,56 @@
+YUI.add('api-filter', function (Y) {
+
+Y.APIFilter = Y.Base.create('apiFilter', Y.Base, [Y.AutoCompleteBase], {
+    // -- Initializer ----------------------------------------------------------
+    initializer: function () {
+        this._bindUIACBase();
+        this._syncUIACBase();
+    },
+    getDisplayName: function(name) {
+
+        Y.each(Y.YUIDoc.meta.allModules, function(i) {
+            if (i.name === name && i.displayName) {
+                name = i.displayName;
+            }
+        });
+
+        if (this.get('queryType') === 'elements') {
+            name = '&lt;' + name + '&gt;';
+        }
+
+        return name;
+    }
+
+}, {
+    // -- Attributes -----------------------------------------------------------
+    ATTRS: {
+        resultHighlighter: {
+            value: 'phraseMatch'
+        },
+
+        // May be set to "classes", "elements" or "modules".
+        queryType: {
+            value: 'classes'
+        },
+
+        source: {
+            valueFn: function() {
+                var self = this;
+                return function(q) {
+                    var data = Y.YUIDoc.meta[self.get('queryType')],
+                        out = [];
+                    Y.each(data, function(v) {
+                        if (v.toLowerCase().indexOf(q.toLowerCase()) > -1) {
+                            out.push(v);
+                        }
+                    });
+                    return out;
+                };
+            }
+        }
+    }
+});
+
+}, '3.4.0', {requires: [
+    'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources'
+]});
diff --git a/docs/assets/js/api-list.js b/docs/assets/js/api-list.js
new file mode 100644
index 00000000..e8f650d5
--- /dev/null
+++ b/docs/assets/js/api-list.js
@@ -0,0 +1,255 @@
+YUI.add('api-list', function (Y) {
+
+var Lang   = Y.Lang,
+    YArray = Y.Array,
+
+    APIList = Y.namespace('APIList'),
+
+    classesNode    = Y.one('#api-classes'),
+    elementsNode   = Y.one('#api-elements'),
+    inputNode      = Y.one('#api-filter'),
+    modulesNode    = Y.one('#api-modules'),
+    tabviewNode    = Y.one('#api-tabview'),
+
+    tabs = APIList.tabs = {},
+
+    filter = APIList.filter = new Y.APIFilter({
+        inputNode : inputNode,
+        maxResults: 1000,
+
+        on: {
+            results: onFilterResults
+        }
+    }),
+
+    search = APIList.search = new Y.APISearch({
+        inputNode : inputNode,
+        maxResults: 100,
+
+        on: {
+            clear  : onSearchClear,
+            results: onSearchResults
+        }
+    }),
+
+    tabview = APIList.tabview = new Y.TabView({
+        srcNode  : tabviewNode,
+        panelNode: '#api-tabview-panel',
+        render   : true,
+
+        on: {
+            selectionChange: onTabSelectionChange
+        }
+    }),
+
+    focusManager = APIList.focusManager = tabviewNode.plug(Y.Plugin.NodeFocusManager, {
+        circular   : true,
+        descendants: '#api-filter, .yui3-tab-panel-selected .api-list-item a, .yui3-tab-panel-selected .result a',
+        keys       : {next: 'down:40', previous: 'down:38'}
+    }).focusManager,
+
+    LIST_ITEM_TEMPLATE =
+        '<li class="api-list-item {typeSingular}">' +
+            '<a href="{rootPath}{typePlural}/{name}.html">{displayName}</a>' +
+        '</li>';
+
+// -- Init ---------------------------------------------------------------------
+
+// Duckpunch FocusManager's key event handling to prevent it from handling key
+// events when a modifier is pressed.
+Y.before(function (e, activeDescendant) {
+    if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) {
+        return new Y.Do.Prevent();
+    }
+}, focusManager, '_focusPrevious', focusManager);
+
+Y.before(function (e, activeDescendant) {
+    if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) {
+        return new Y.Do.Prevent();
+    }
+}, focusManager, '_focusNext', focusManager);
+
+// Create a mapping of tabs in the tabview so we can refer to them easily later.
+tabview.each(function (tab, index) {
+    var name = tab.get('label').toLowerCase();
+
+    tabs[name] = {
+        index: index,
+        name : name,
+        tab  : tab
+    };
+});
+
+// Switch tabs on Ctrl/Cmd-Left/Right arrows.
+tabviewNode.on('key', onTabSwitchKey, 'down:37,39');
+
+// Focus the filter input when the `/` key is pressed.
+Y.one(Y.config.doc).on('key', onSearchKey, 'down:83');
+
+// Keep the Focus Manager up to date.
+inputNode.on('focus', function () {
+    focusManager.set('activeDescendant', inputNode);
+});
+
+// Update all tabview links to resolved URLs.
+tabview.get('panelNode').all('a').each(function (link) {
+    link.setAttribute('href', link.get('href'));
+});
+
+// -- Private Functions --------------------------------------------------------
+function getFilterResultNode() {
+    var queryType = filter.get('queryType');
+    return queryType === 'classes' ? classesNode
+            : queryType === 'elements' ? elementsNode : modulesNode;
+}
+
+// -- Event Handlers -----------------------------------------------------------
+function onFilterResults(e) {
+    var frag         = Y.one(Y.config.doc.createDocumentFragment()),
+        resultNode   = getFilterResultNode(),
+        typePlural   = filter.get('queryType'),
+        typeSingular = typePlural === 'classes' ? 'class' : typePlural === 'elements' ? 'element' : 'module';
+
+    if (e.results.length) {
+        YArray.each(e.results, function (result) {
+            frag.append(Lang.sub(LIST_ITEM_TEMPLATE, {
+                rootPath    : APIList.rootPath,
+                displayName : filter.getDisplayName(result.highlighted),
+                name        : result.text,
+                typePlural  : typePlural,
+                typeSingular: typeSingular
+            }));
+        });
+    } else {
+        frag.append(
+            '<li class="message">' +
+                'No ' + typePlural + ' found.' +
+            '</li>'
+        );
+    }
+
+    resultNode.empty(true);
+    resultNode.append(frag);
+
+    focusManager.refresh();
+}
+
+function onSearchClear(e) {
+
+    focusManager.refresh();
+}
+
+function onSearchKey(e) {
+    var target = e.target;
+
+    if (target.test('input,select,textarea')
+            || target.get('isContentEditable')) {
+        return;
+    }
+
+    e.preventDefault();
+
+    inputNode.focus();
+    focusManager.refresh();
+}
+
+function onSearchResults(e) {
+    var frag = Y.one(Y.config.doc.createDocumentFragment());
+
+    if (e.results.length) {
+        YArray.each(e.results, function (result) {
+            frag.append(result.display);
+        });
+    } else {
+        frag.append(
+            '<li class="message">' +
+                'No results found. Maybe you\'ll have better luck with a ' +
+                'different query?' +
+            '</li>'
+        );
+    }
+
+
+    focusManager.refresh();
+}
+
+function onTabSelectionChange(e) {
+    var tab  = e.newVal,
+        name = tab.get('label').toLowerCase();
+
+    tabs.selected = {
+        index: tab.get('index'),
+        name : name,
+        tab  : tab
+    };
+
+    switch (name) {
+    case 'elements':// fallthru
+    case 'classes': // fallthru
+    case 'modules':
+        filter.setAttrs({
+            minQueryLength: 0,
+            queryType     : name
+        });
+
+        search.set('minQueryLength', -1);
+
+        // Only send a request if this isn't the initially-selected tab.
+        if (e.prevVal) {
+            filter.sendRequest(filter.get('value'));
+        }
+        break;
+
+    case 'everything':
+        filter.set('minQueryLength', -1);
+        search.set('minQueryLength', 1);
+
+        if (search.get('value')) {
+            search.sendRequest(search.get('value'));
+        } else {
+            inputNode.focus();
+        }
+        break;
+
+    default:
+        // WTF? We shouldn't be here!
+        filter.set('minQueryLength', -1);
+        search.set('minQueryLength', -1);
+    }
+
+    if (focusManager) {
+        setTimeout(function () {
+            focusManager.refresh();
+        }, 1);
+    }
+}
+
+function onTabSwitchKey(e) {
+    var currentTabIndex = tabs.selected.index;
+
+    if (!(e.ctrlKey || e.metaKey)) {
+        return;
+    }
+
+    e.preventDefault();
+
+    switch (e.keyCode) {
+    case 37: // left arrow
+        if (currentTabIndex > 0) {
+            tabview.selectChild(currentTabIndex - 1);
+            inputNode.focus();
+        }
+        break;
+
+    case 39: // right arrow
+        if (currentTabIndex < (Y.Object.size(tabs) - 2)) {
+            tabview.selectChild(currentTabIndex + 1);
+            inputNode.focus();
+        }
+        break;
+    }
+}
+
+}, '3.4.0', {requires: [
+    'api-filter', 'api-search', 'event-key', 'node-focusmanager', 'tabview'
+]});
diff --git a/docs/assets/js/api-search.js b/docs/assets/js/api-search.js
new file mode 100644
index 00000000..175f6a61
--- /dev/null
+++ b/docs/assets/js/api-search.js
@@ -0,0 +1,98 @@
+YUI.add('api-search', function (Y) {
+
+var Lang   = Y.Lang,
+    Node   = Y.Node,
+    YArray = Y.Array;
+
+Y.APISearch = Y.Base.create('apiSearch', Y.Base, [Y.AutoCompleteBase], {
+    // -- Public Properties ----------------------------------------------------
+    RESULT_TEMPLATE:
+        '<li class="result {resultType}">' +
+            '<a href="{url}">' +
+                '<h3 class="title">{name}</h3>' +
+                '<span class="type">{resultType}</span>' +
+                '<div class="description">{description}</div>' +
+                '<span class="className">{class}</span>' +
+            '</a>' +
+        '</li>',
+
+    // -- Initializer ----------------------------------------------------------
+    initializer: function () {
+        this._bindUIACBase();
+        this._syncUIACBase();
+    },
+
+    // -- Protected Methods ----------------------------------------------------
+    _apiResultFilter: function (query, results) {
+        // Filter components out of the results.
+        return YArray.filter(results, function (result) {
+            return result.raw.resultType === 'component' ? false : result;
+        });
+    },
+
+    _apiResultFormatter: function (query, results) {
+        return YArray.map(results, function (result) {
+            var raw  = Y.merge(result.raw), // create a copy
+                desc = raw.description || '';
+
+            // Convert description to text and truncate it if necessary.
+            desc = Node.create('<div>' + desc + '</div>').get('text');
+
+            if (desc.length > 65) {
+                desc = Y.Escape.html(desc.substr(0, 65)) + ' &hellip;';
+            } else {
+                desc = Y.Escape.html(desc);
+            }
+
+            raw['class'] || (raw['class'] = '');
+            raw.description = desc;
+
+            // Use the highlighted result name.
+            raw.name = result.highlighted;
+
+            return Lang.sub(this.RESULT_TEMPLATE, raw);
+        }, this);
+    },
+
+    _apiTextLocator: function (result) {
+        return result.displayName || result.name;
+    }
+}, {
+    // -- Attributes -----------------------------------------------------------
+    ATTRS: {
+        resultFormatter: {
+            valueFn: function () {
+                return this._apiResultFormatter;
+            }
+        },
+
+        resultFilters: {
+            valueFn: function () {
+                return this._apiResultFilter;
+            }
+        },
+
+        resultHighlighter: {
+            value: 'phraseMatch'
+        },
+
+        resultListLocator: {
+            value: 'data.results'
+        },
+
+        resultTextLocator: {
+            valueFn: function () {
+                return this._apiTextLocator;
+            }
+        },
+
+        source: {
+            value: '/api/v1/search?q={query}&count={maxResults}'
+        }
+    }
+});
+
+}, '3.4.0', {requires: [
+    'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources',
+    'escape'
+]});
diff --git a/docs/assets/js/apidocs.js b/docs/assets/js/apidocs.js
new file mode 100644
index 00000000..af9ac322
--- /dev/null
+++ b/docs/assets/js/apidocs.js
@@ -0,0 +1,376 @@
+YUI().use(
+    'yuidoc-meta',
+    'api-list', 'history-hash', 'node-screen', 'node-style', 'pjax',
+function (Y) {
+
+var win          = Y.config.win,
+    localStorage = win.localStorage,
+
+    bdNode = Y.one('#bd'),
+
+    pjax,
+    defaultRoute,
+
+    classTabView,
+    selectedTab;
+
+// Kill pjax functionality unless serving over HTTP.
+if (!Y.getLocation().protocol.match(/^https?\:/)) {
+    Y.Router.html5 = false;
+}
+
+// Create the default route with middleware which enables syntax highlighting
+// on the loaded content.
+defaultRoute = Y.Pjax.defaultRoute.concat(function (req, res, next) {
+    prettyPrint();
+    bdNode.removeClass('loading');
+
+    next();
+});
+
+pjax = new Y.Pjax({
+    container      : '#docs-main',
+    contentSelector: '#docs-main > .content',
+    linkSelector   : '#bd a',
+    titleSelector  : '#xhr-title',
+
+    navigateOnHash: true,
+    root          : '/',
+    routes        : [
+        // -- / ----------------------------------------------------------------
+        {
+            path     : '/(index.html)?',
+            callbacks: defaultRoute
+        },
+
+        // -- /elements/* -------------------------------------------------------
+        {
+            path     : '/elements/:element.html*',
+            callbacks: defaultRoute
+        },
+
+        // -- /classes/* -------------------------------------------------------
+        {
+            path     : '/classes/:class.html*',
+            callbacks: [defaultRoute, 'handleClasses']
+        },
+
+        // -- /files/* ---------------------------------------------------------
+        {
+            path     : '/files/*file',
+            callbacks: [defaultRoute, 'handleFiles']
+        },
+
+        // -- /modules/* -------------------------------------------------------
+        {
+            path     : '/modules/:module.html*',
+            callbacks: defaultRoute
+        }
+    ]
+});
+
+// -- Utility Functions --------------------------------------------------------
+
+pjax.checkVisibility = function (tab) {
+    tab || (tab = selectedTab);
+
+    if (!tab) { return; }
+
+    var panelNode = tab.get('panelNode'),
+        visibleItems;
+
+    // If no items are visible in the tab panel due to the current visibility
+    // settings, display a message to that effect.
+    visibleItems = panelNode.all('.item,.index-item').some(function (itemNode) {
+        if (itemNode.getComputedStyle('display') !== 'none') {
+            return true;
+        }
+    });
+
+    panelNode.all('.no-visible-items').remove();
+
+    if (!visibleItems) {
+        if (Y.one('#index .index-item')) {
+            panelNode.append(
+                '<div class="no-visible-items">' +
+                    '<p>' +
+                    'Some items are not shown due to the current visibility ' +
+                    'settings. Use the checkboxes at the upper right of this ' +
+                    'page to change the visibility settings.' +
+                    '</p>' +
+                '</div>'
+            );
+        } else {
+            panelNode.append(
+                '<div class="no-visible-items">' +
+                    '<p>' +
+                    'This class doesn\'t provide any methods, properties, ' +
+                    'attributes, or events.' +
+                    '</p>' +
+                '</div>'
+            );
+        }
+    }
+
+    // Hide index sections without any visible items.
+    Y.all('.index-section').each(function (section) {
+        var items        = 0,
+            visibleItems = 0;
+
+        section.all('.index-item').each(function (itemNode) {
+            items += 1;
+
+            if (itemNode.getComputedStyle('display') !== 'none') {
+                visibleItems += 1;
+            }
+        });
+
+        section.toggleClass('hidden', !visibleItems);
+        section.toggleClass('no-columns', visibleItems < 4);
+    });
+};
+
+pjax.initClassTabView = function () {
+    if (!Y.all('#classdocs .api-class-tab').size()) {
+        return;
+    }
+
+    if (classTabView) {
+        classTabView.destroy();
+        selectedTab = null;
+    }
+
+    classTabView = new Y.TabView({
+        srcNode: '#classdocs',
+
+        on: {
+            selectionChange: pjax.onTabSelectionChange
+        }
+    });
+
+    pjax.updateTabState();
+    classTabView.render();
+};
+
+pjax.initLineNumbers = function () {
+    var hash      = win.location.hash.substring(1),
+        container = pjax.get('container'),
+        hasLines, node;
+
+    // Add ids for each line number in the file source view.
+    container.all('.linenums>li').each(function (lineNode, index) {
+        lineNode.set('id', 'l' + (index + 1));
+        lineNode.addClass('file-line');
+        hasLines = true;
+    });
+
+    // Scroll to the desired line.
+    if (hasLines && /^l\d+$/.test(hash)) {
+        if ((node = container.getById(hash))) {
+            win.scroll(0, node.getY());
+        }
+    }
+};
+
+pjax.initRoot = function () {
+    var terminators = /^(?:classes|files|elements|modules)$/,
+        parts       = pjax._getPathRoot().split('/'),
+        root        = [],
+        i, len, part;
+
+    for (i = 0, len = parts.length; i < len; i += 1) {
+        part = parts[i];
+
+        if (part.match(terminators)) {
+            // Makes sure the path will end with a "/".
+            root.push('');
+            break;
+        }
+
+        root.push(part);
+    }
+
+    pjax.set('root', root.join('/'));
+};
+
+pjax.updateTabState = function (src) {
+    var hash = win.location.hash.substring(1),
+        defaultTab, node, tab, tabPanel;
+
+    function scrollToNode() {
+        if (node.hasClass('protected')) {
+            Y.one('#api-show-protected').set('checked', true);
+            pjax.updateVisibility();
+        }
+
+        if (node.hasClass('private')) {
+            Y.one('#api-show-private').set('checked', true);
+            pjax.updateVisibility();
+        }
+
+        setTimeout(function () {
+            // For some reason, unless we re-get the node instance here,
+            // getY() always returns 0.
+            var node = Y.one('#classdocs').getById(hash);
+            win.scrollTo(0, node.getY() - 70);
+        }, 1);
+    }
+
+    if (!classTabView) {
+        return;
+    }
+
+    if (src === 'hashchange' && !hash) {
+        defaultTab = 'index';
+    } else {
+        if (localStorage) {
+            defaultTab = localStorage.getItem('tab_' + pjax.getPath()) ||
+                'index';
+        } else {
+            defaultTab = 'index';
+        }
+    }
+
+    if (hash && (node = Y.one('#classdocs').getById(hash))) {
+        if ((tabPanel = node.ancestor('.api-class-tabpanel', true))) {
+            if ((tab = Y.one('#classdocs .api-class-tab.' + tabPanel.get('id')))) {
+                if (classTabView.get('rendered')) {
+                    Y.Widget.getByNode(tab).set('selected', 1);
+                } else {
+                    tab.addClass('yui3-tab-selected');
+                }
+            }
+        }
+
+        // Scroll to the desired element if this is a hash URL.
+        if (node) {
+            if (classTabView.get('rendered')) {
+                scrollToNode();
+            } else {
+                classTabView.once('renderedChange', scrollToNode);
+            }
+        }
+    } else {
+        tab = Y.one('#classdocs .api-class-tab.' + defaultTab);
+
+        // When the `defaultTab` node isn't found, `localStorage` is stale.
+        if (!tab && defaultTab !== 'index') {
+            tab = Y.one('#classdocs .api-class-tab.index');
+        }
+
+        if (classTabView.get('rendered')) {
+            Y.Widget.getByNode(tab).set('selected', 1);
+        } else {
+            tab.addClass('yui3-tab-selected');
+        }
+    }
+};
+
+pjax.updateVisibility = function () {
+    var container = pjax.get('container');
+
+    container.toggleClass('hide-inherited',
+            !Y.one('#api-show-inherited').get('checked'));
+
+    container.toggleClass('show-deprecated',
+            Y.one('#api-show-deprecated').get('checked'));
+
+    container.toggleClass('show-protected',
+            Y.one('#api-show-protected').get('checked'));
+
+    container.toggleClass('show-private',
+            Y.one('#api-show-private').get('checked'));
+
+    pjax.checkVisibility();
+};
+
+// -- Route Handlers -----------------------------------------------------------
+
+pjax.handleClasses = function (req, res, next) {
+    var status = res.ioResponse.status;
+
+    // Handles success and local filesystem XHRs.
+    if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) {
+        pjax.initClassTabView();
+    }
+
+    next();
+};
+
+pjax.handleFiles = function (req, res, next) {
+    var status = res.ioResponse.status;
+
+    // Handles success and local filesystem XHRs.
+    if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) {
+        pjax.initLineNumbers();
+    }
+
+    next();
+};
+
+// -- Event Handlers -----------------------------------------------------------
+
+pjax.onNavigate = function (e) {
+    var hash         = e.hash,
+        originTarget = e.originEvent && e.originEvent.target,
+        tab;
+
+    if (hash) {
+        tab = originTarget && originTarget.ancestor('.yui3-tab', true);
+
+        if (hash === win.location.hash) {
+            pjax.updateTabState('hashchange');
+        } else if (!tab) {
+            win.location.hash = hash;
+        }
+
+        e.preventDefault();
+        return;
+    }
+
+    // Only scroll to the top of the page when the URL doesn't have a hash.
+    this.set('scrollToTop', !e.url.match(/#.+$/));
+
+    bdNode.addClass('loading');
+};
+
+pjax.onOptionClick = function (e) {
+    pjax.updateVisibility();
+};
+
+pjax.onTabSelectionChange = function (e) {
+    var tab   = e.newVal,
+        tabId = tab.get('contentBox').getAttribute('href').substring(1);
+
+    selectedTab = tab;
+
+    // If switching from a previous tab (i.e., this is not the default tab),
+    // replace the history entry with a hash URL that will cause this tab to
+    // be selected if the user navigates away and then returns using the back
+    // or forward buttons.
+    if (e.prevVal && localStorage) {
+        localStorage.setItem('tab_' + pjax.getPath(), tabId);
+    }
+
+    pjax.checkVisibility(tab);
+};
+
+// -- Init ---------------------------------------------------------------------
+
+pjax.on('navigate', pjax.onNavigate);
+
+pjax.initRoot();
+pjax.upgrade();
+pjax.initClassTabView();
+pjax.initLineNumbers();
+pjax.updateVisibility();
+
+Y.APIList.rootPath = pjax.get('root');
+
+Y.one('#api-options').delegate('click', pjax.onOptionClick, 'input');
+
+Y.on('hashchange', function (e) {
+    pjax.updateTabState('hashchange');
+}, win);
+
+});
diff --git a/docs/assets/js/yui-prettify.js b/docs/assets/js/yui-prettify.js
new file mode 100644
index 00000000..18de8649
--- /dev/null
+++ b/docs/assets/js/yui-prettify.js
@@ -0,0 +1,17 @@
+YUI().use('node', function(Y) {
+    var code = Y.all('.prettyprint.linenums');
+    if (code.size()) {
+        code.each(function(c) {
+            var lis = c.all('ol li'),
+                l = 1;
+            lis.each(function(n) {
+                n.prepend('<a name="LINENUM_' + l + '"></a>');
+                l++;
+            });
+        });
+        var h = location.hash;
+        location.hash = '';
+        h = h.replace('LINE_', 'LINENUM_');
+        location.hash = h;
+    }
+});
diff --git a/docs/assets/vendor/prettify/CHANGES.html b/docs/assets/vendor/prettify/CHANGES.html
new file mode 100644
index 00000000..b50b8414
--- /dev/null
+++ b/docs/assets/vendor/prettify/CHANGES.html
@@ -0,0 +1,130 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <title>Change Log</title>
+  </head>
+  <body bgcolor="white">
+    <a style="float:right" href="README.html">README</a>
+
+    <h1>Known Issues</h1>
+    <ul>
+      <li>Perl formatting is really crappy.  Partly because the author is lazy and
+      partly because Perl is
+      <a href="http://www.perlmonks.org/?node_id=663393">hard</a> to parse.
+      <li>On some browsers, <code>&lt;code&gt;</code> elements with newlines in the text
+      which use CSS to specify <code>white-space:pre</code> will have the newlines
+      improperly stripped if the element is not attached to the document at the time
+      the stripping is done.  Also, on IE 6, all newlines will be stripped from
+      <code>&lt;code&gt;</code> elements because of the way IE6 produces
+      <code>innerHTML</code>.  Workaround: use <code>&lt;pre&gt;</code> for code with
+      newlines.
+    </ul>
+
+    <h1>Change Log</h1>
+    <h2>29 March 2007</h2>
+    <ul>
+      <li>Added <a href="tests/prettify_test.html#PHP">tests</a> for PHP support
+        to address 
+      <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=3"
+       >issue 3</a>.
+      <li>Fixed
+      <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=6"
+       >bug</a>: <code>prettyPrintOne</code> was not halting.  This was not
+        reachable through the normal entry point.
+      <li>Fixed
+      <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=4"
+       >bug</a>: recursing into a script block or PHP tag that was not properly
+        closed would not silently drop the content.
+        (<a href="tests/prettify_test.html#issue4">test</a>)
+      <li>Fixed
+      <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=8"
+       >bug</a>: was eating tabs
+        (<a href="tests/prettify_test.html#issue8">test</a>)
+      <li>Fixed entity handling so that the caveat
+        <blockquote>
+          <p>Caveats: please properly escape less-thans.  <tt>x&amp;lt;y</tt>
+          instead of <tt>x&lt;y</tt>, and use <tt>&quot;</tt> instead of 
+          <tt>&amp;quot;</tt> for string delimiters.</p>
+        </blockquote>
+        is no longer applicable.
+      <li>Added noisefree's C#
+      <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=4"
+       >patch</a>
+      <li>Added a <a href="http://google-code-prettify.googlecode.com/files/prettify-small.zip">distribution</a> that has comments and
+        whitespace removed to reduce download size from 45.5kB to 12.8kB.
+    </ul>
+    <h2>4 Jul 2008</h2>
+    <ul>
+      <li>Added <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=17">language specific formatters</a> that are triggered by the presence
+      of a <code>lang-&lt;language-file-extension&gt;</code></li>
+      <li>Fixed <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=29">bug</a>: python handling of <code>'''string'''</code>
+      <li>Fixed bug: <code>/</code> in regex <code>[charsets] should not end regex</code>
+    </ul>
+    <h2>5 Jul 2008</h2>
+    <ul>
+      <li>Defined language extensions for Lisp and Lua</code>
+    </ul>
+    <h2>14 Jul 2008</h2>
+    <ul>
+      <li>Language handlers for F#, OCAML, SQL</code>
+      <li>Support for <code>nocode</code> spans to allow embedding of line
+      numbers and code annotations which should not be styled or otherwise
+      affect the tokenization of prettified code.
+      See the issue 22
+      <a href="tests/prettify_test.html#issue22">testcase</a>.</code>
+    </ul>
+    <h2>6 Jan 2009</h2>
+    <ul>
+      <li>Language handlers for Visual Basic, Haskell, CSS, and WikiText</li>
+      <li>Added <tt>.mxml</tt> extension to the markup style handler for
+        Flex <a href="http://en.wikipedia.org/wiki/MXML">MXML files</a>.  See
+        <a
+        href="http://code.google.com/p/google-code-prettify/issues/detail?id=37"
+        >issue 37</a>.
+      <li>Added <tt>.m</tt> extension to the C style handler so that Objective
+        C source files properly highlight.  See
+        <a
+        href="http://code.google.com/p/google-code-prettify/issues/detail?id=58"
+       >issue 58</a>.
+      <li>Changed HTML lexer to use the same embedded source mechanism as the
+        wiki language handler, and changed to use the registered
+        CSS handler for STYLE element content.
+    </ul>
+    <h2>21 May 2009</h2>
+    <ul>
+      <li>Rewrote to improve performance on large files.
+        See <a href="http://mikesamuel.blogspot.com/2009/05/efficient-parsing-in-javascript.html">benchmarks</a>.</li>
+      <li>Fixed bugs with highlighting of Haskell line comments, Lisp
+        number literals, Lua strings, C preprocessor directives,
+        newlines in Wiki code on Windows, and newlines in IE6.</li>
+    </ul>
+    <h2>14 August 2009</h2>
+    <ul>
+      <li>Fixed prettifying of <code>&lt;code&gt;</code> blocks with embedded newlines.
+    </ul>
+    <h2>3 October 2009</h2>
+    <ul>
+      <li>Fixed prettifying of XML/HTML tags that contain uppercase letters.
+    </ul>
+    <h2>19 July 2010</h2>
+    <ul>
+      <li>Added support for line numbers.  Bug
+        <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=22"
+         >22</a></li>
+      <li>Added YAML support.  Bug
+        <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=123"
+         >123</a></li>
+      <li>Added VHDL support courtesy Le Poussin.</li>
+      <li>IE performance improvements.  Bug
+        <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=102"
+         >102</a> courtesy jacobly.</li>
+      <li>A variety of markup formatting fixes courtesy smain and thezbyg.</li>
+      <li>Fixed copy and paste in IE[678].
+      <li>Changed output to use <code>&amp;#160;</code> instead of
+        <code>&amp;nbsp;</code> so that the output works when embedded in XML.
+        Bug
+        <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=108"
+         >108</a>.</li>
+    </ul>
+  </body>
+</html>
diff --git a/docs/assets/vendor/prettify/COPYING b/docs/assets/vendor/prettify/COPYING
new file mode 100644
index 00000000..d6456956
--- /dev/null
+++ b/docs/assets/vendor/prettify/COPYING
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
diff --git a/docs/assets/vendor/prettify/README.html b/docs/assets/vendor/prettify/README.html
new file mode 100644
index 00000000..c6fe1a32
--- /dev/null
+++ b/docs/assets/vendor/prettify/README.html
@@ -0,0 +1,203 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+  <head>
+    <title>Javascript code prettifier</title>
+
+    <link href="src/prettify.css" type="text/css" rel="stylesheet" />
+
+    <script src="src/prettify.js" type="text/javascript"></script>
+
+    <style type="text/css">
+      body { margin-left: .5in }
+      h1, h2, h3, h4, .footer { margin-left: -.4in; }
+    </style>
+  </head>
+
+  <body onload="prettyPrint()" bgcolor="white">
+    <small style="float: right">Languages : <a href="README-zh-Hans.html">CH</a></small>
+    <h1>Javascript code prettifier</h1>
+
+    <h2>Setup</h2>
+    <ol>
+      <li><a href="http://code.google.com/p/google-code-prettify/downloads/list">Download</a> a distribution
+      <li>Include the script and stylesheets in your document
+        (you will need to make sure the css and js file are on your server, and
+         adjust the paths in the <tt>script</tt> and <tt>link</tt> tag)
+        <pre class="prettyprint">
+&lt;link href="prettify.css" type="text/css" rel="stylesheet" />
+&lt;script type="text/javascript" src="prettify.js">&lt;/script></pre>
+      <li>Add <code class="prettyprint lang-html">onload="prettyPrint()"</code> to your
+      document's body tag.
+      <li>Modify the stylesheet to get the coloring you prefer</li>
+    </ol>
+
+    <h2>Usage</h2>
+    <p>Put code snippets in
+    <tt>&lt;pre class="prettyprint"&gt;...&lt;/pre&gt;</tt>
+    or <tt>&lt;code class="prettyprint"&gt;...&lt;/code&gt;</tt>
+    and it will automatically be pretty printed.
+
+    <table summary="code examples">
+      <tr>
+        <th>The original
+        <th>Prettier
+      <tr>
+        <td><pre style="border: 1px solid #888;padding: 2px"
+             ><a name="voila1"></a>class Voila {
+public:
+  // Voila
+  static const string VOILA = "Voila";
+
+  // will not interfere with embedded <a href="#voila1">tags</a>.
+}</pre>
+
+        <td><pre class="prettyprint"><a name="voila2"></a>class Voila {
+public:
+  // Voila
+  static const string VOILA = "Voila";
+
+  // will not interfere with embedded <a href="#voila2">tags</a>.
+}</pre>
+    </table>
+
+    <h2>FAQ</h2>
+    <h3 id="langs">Which languages does it work for?</h3>
+    <p>The comments in <tt>prettify.js</tt> are authoritative but the lexer
+    should work on a number of languages including C and friends,
+    Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles.
+    It works passably on Ruby, PHP, VB, and Awk and a decent subset of Perl
+    and Ruby, but, because of commenting conventions, doesn't work on
+    Smalltalk, or CAML-like languages.</p>
+
+    <p>LISPy languages are supported via an extension:
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lisp.js"
+     ><code>lang-lisp.js</code></a>.</p>
+    <p>And similarly for
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-css.js"
+     ><code>CSS</code></a>,
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-hs.js"
+     ><code>Haskell</code></a>,
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lua.js"
+     ><code>Lua</code></a>,
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-ml.js"
+     ><code>OCAML, SML, F#</code></a>,
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-vb.js"
+     ><code>Visual Basic</code></a>,
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-sql.js"
+     ><code>SQL</code></a>,
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-proto.js"
+     ><code>Protocol Buffers</code></a>, and
+    <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-wiki.js"
+     ><code>WikiText</code></a>..
+
+    <p>If you'd like to add an extension for your favorite language, please
+    look at <tt>src/lang-lisp.js</tt> and file an
+    <a href="http://code.google.com/p/google-code-prettify/issues/list"
+     >issue</a> including your language extension, and a testcase.</p>
+
+    <h3>How do I specify which language my code is in?</h3>
+    <p>You don't need to specify the language since <code>prettyprint()</code>
+    will guess.  You can specify a language by specifying the language extension
+    along with the <code>prettyprint</code> class like so:</p>
+    <pre class="prettyprint lang-html"
+>&lt;pre class=&quot;prettyprint <b>lang-html</b>&quot;&gt;
+  The lang-* class specifies the language file extensions.
+  File extensions supported by default include
+    "bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html",
+    "java", "js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh",
+    "xhtml", "xml", "xsl".
+&lt;/pre&gt;</pre>
+
+    <h3>It doesn't work on <tt>&lt;obfuscated code sample&gt;</tt>?</h3>
+    <p>Yes.  Prettifying obfuscated code is like putting lipstick on a pig
+    &mdash; i.e. outside the scope of this tool.</p>
+
+    <h3>Which browsers does it work with?</h3>
+    <p>It's been tested with IE 6, Firefox 1.5 &amp; 2, and Safari 2.0.4.
+    Look at <a href="tests/prettify_test.html">the test page</a> to see if it
+    works in your browser.</p>
+
+    <h3>What's changed?</h3>
+    <p>See the <a href="CHANGES.html">change log</a></p>
+
+    <h3>Why doesn't Prettyprinting of strings work on WordPress?</h3>
+    <p>Apparently wordpress does "smart quoting" which changes close quotes.
+    This causes end quotes to not match up with open quotes.
+    <p>This breaks prettifying as well as copying and pasting of code samples.
+    See
+    <a href="http://wordpress.org/support/topic/125038"
+    >WordPress's help center</a> for info on how to stop smart quoting of code
+    snippets.</p>
+
+    <h3 id="linenums">How do I put line numbers in my code?</h3>
+    <p>You can use the <code>linenums</code> class to turn on line
+    numbering.  If your code doesn't start at line number 1, you can
+    add a colon and a line number to the end of that class as in
+    <code>linenums:52</code>.
+
+    <p>For example
+<pre class="prettyprint">&lt;pre class="prettyprint linenums:<b>4</b>"
+&gt;// This is line 4.
+foo();
+bar();
+baz();
+boo();
+far();
+faz();
+&lt;pre&gt;</pre>
+    produces
+<pre class="prettyprint linenums:4"
+>// This is line 4.
+foo();
+bar();
+baz();
+boo();
+far();
+faz();
+</pre>
+
+    <h3>How do I prevent a portion of markup from being marked as code?</h3>
+    <p>You can use the <code>nocode</code> class to identify a span of markup
+    that is not code.
+<pre class="prettyprint">&lt;pre class=prettyprint&gt;
+int x = foo();  /* This is a comment  &lt;span class="nocode"&gt;This is not code&lt;/span&gt;
+  Continuation of comment */
+int y = bar();
+&lt;/pre&gt;</pre>
+produces
+<pre class="prettyprint">
+int x = foo();  /* This is a comment  <span class="nocode">This is not code</span>
+  Continuation of comment */
+int y = bar();
+</pre>
+
+    <p>For a more complete example see the issue22
+    <a href="tests/prettify_test.html#issue22">testcase</a>.</p>
+
+    <h3>I get an error message "a is not a function" or "opt_whenDone is not a function"</h3>
+    <p>If you are calling <code>prettyPrint</code> via an event handler, wrap it in a function.
+    Instead of doing
+    <blockquote>
+      <code class="prettyprint lang-js"
+       >addEventListener('load', prettyPrint, false);</code>
+    </blockquote>
+    wrap it in a closure like
+    <blockquote>
+      <code class="prettyprint lang-js"
+       >addEventListener('load', function (event) { prettyPrint() }, false);</code>
+    </blockquote>
+    so that the browser does not pass an event object to <code>prettyPrint</code> which
+    will confuse it.
+
+    <br><br><br>
+
+    <div class="footer">
+<!-- Created: Tue Oct  3 17:51:56 PDT 2006 -->
+<!-- hhmts start -->
+Last modified: Wed Jul 19 13:56:00 PST 2010
+<!-- hhmts end -->
+    </div>
+  </body>
+</html>
diff --git a/docs/assets/vendor/prettify/prettify-min.css b/docs/assets/vendor/prettify/prettify-min.css
new file mode 100644
index 00000000..d44b3a22
--- /dev/null
+++ b/docs/assets/vendor/prettify/prettify-min.css
@@ -0,0 +1 @@
+.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
\ No newline at end of file
diff --git a/docs/assets/vendor/prettify/prettify-min.js b/docs/assets/vendor/prettify/prettify-min.js
new file mode 100644
index 00000000..4845d05d
--- /dev/null
+++ b/docs/assets/vendor/prettify/prettify-min.js
@@ -0,0 +1 @@
+window.PR_SHOULD_USE_CONTINUATION=true;var prettyPrintOne;var prettyPrint;(function(){var O=window;var j=["break,continue,do,else,for,if,return,while"];var v=[j,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"];var q=[v,"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"];var m=[q,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"];var y=[q,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"];var T=[y,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,let,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var,virtual,where"];var s="all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,throw,true,try,unless,until,when,while,yes";var x=[q,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"];var t="caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END";var J=[j,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"];var g=[j,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"];var I=[j,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"];var B=[m,T,x,t+J,g,I];var f=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)\b/;var D="str";var A="kwd";var k="com";var Q="typ";var H="lit";var M="pun";var G="pln";var n="tag";var F="dec";var K="src";var R="atn";var o="atv";var P="nocode";var N="(?:^^\\.?|[+-]|[!=]=?=?|\\#|%=?|&&?=?|\\(|\\*=?|[+\\-]=|->|\\/=?|::?|<<?=?|>>?>?=?|,|;|\\?|@|\\[|~|{|\\^\\^?=?|\\|\\|?=?|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\\s*";function l(ab){var af=0;var U=false;var ae=false;for(var X=0,W=ab.length;X<W;++X){var ag=ab[X];if(ag.ignoreCase){ae=true}else{if(/[a-z]/i.test(ag.source.replace(/\\u[0-9a-f]{4}|\\x[0-9a-f]{2}|\\[^ux]/gi,""))){U=true;ae=false;break}}}var aa={b:8,t:9,n:10,v:11,f:12,r:13};function ad(aj){var ai=aj.charCodeAt(0);if(ai!==92){return ai}var ah=aj.charAt(1);ai=aa[ah];if(ai){return ai}else{if("0"<=ah&&ah<="7"){return parseInt(aj.substring(1),8)}else{if(ah==="u"||ah==="x"){return parseInt(aj.substring(2),16)}else{return aj.charCodeAt(1)}}}}function V(ah){if(ah<32){return(ah<16?"\\x0":"\\x")+ah.toString(16)}var ai=String.fromCharCode(ah);return(ai==="\\"||ai==="-"||ai==="]"||ai==="^")?"\\"+ai:ai}function Z(an){var ar=an.substring(1,an.length-1).match(new RegExp("\\\\u[0-9A-Fa-f]{4}|\\\\x[0-9A-Fa-f]{2}|\\\\[0-3][0-7]{0,2}|\\\\[0-7]{1,2}|\\\\[\\s\\S]|-|[^-\\\\]","g"));var ah=[];var ap=ar[0]==="^";var ao=["["];if(ap){ao.push("^")}for(var at=ap?1:0,al=ar.length;at<al;++at){var aj=ar[at];if(/\\[bdsw]/i.test(aj)){ao.push(aj)}else{var ai=ad(aj);var am;if(at+2<al&&"-"===ar[at+1]){am=ad(ar[at+2]);at+=2}else{am=ai}ah.push([ai,am]);if(!(am<65||ai>122)){if(!(am<65||ai>90)){ah.push([Math.max(65,ai)|32,Math.min(am,90)|32])}if(!(am<97||ai>122)){ah.push([Math.max(97,ai)&~32,Math.min(am,122)&~32])}}}}ah.sort(function(aw,av){return(aw[0]-av[0])||(av[1]-aw[1])});var ak=[];var aq=[];for(var at=0;at<ah.length;++at){var au=ah[at];if(au[0]<=aq[1]+1){aq[1]=Math.max(aq[1],au[1])}else{ak.push(aq=au)}}for(var at=0;at<ak.length;++at){var au=ak[at];ao.push(V(au[0]));if(au[1]>au[0]){if(au[1]+1>au[0]){ao.push("-")}ao.push(V(au[1]))}}ao.push("]");return ao.join("")}function Y(an){var al=an.source.match(new RegExp("(?:\\[(?:[^\\x5C\\x5D]|\\\\[\\s\\S])*\\]|\\\\u[A-Fa-f0-9]{4}|\\\\x[A-Fa-f0-9]{2}|\\\\[0-9]+|\\\\[^ux0-9]|\\(\\?[:!=]|[\\(\\)\\^]|[^\\x5B\\x5C\\(\\)\\^]+)","g"));var aj=al.length;var ap=[];for(var am=0,ao=0;am<aj;++am){var ai=al[am];if(ai==="("){++ao}else{if("\\"===ai.charAt(0)){var ah=+ai.substring(1);if(ah){if(ah<=ao){ap[ah]=-1}else{al[am]=V(ah)}}}}}for(var am=1;am<ap.length;++am){if(-1===ap[am]){ap[am]=++af}}for(var am=0,ao=0;am<aj;++am){var ai=al[am];if(ai==="("){++ao;if(!ap[ao]){al[am]="(?:"}}else{if("\\"===ai.charAt(0)){var ah=+ai.substring(1);if(ah&&ah<=ao){al[am]="\\"+ap[ah]}}}}for(var am=0;am<aj;++am){if("^"===al[am]&&"^"!==al[am+1]){al[am]=""}}if(an.ignoreCase&&U){for(var am=0;am<aj;++am){var ai=al[am];var ak=ai.charAt(0);if(ai.length>=2&&ak==="["){al[am]=Z(ai)}else{if(ak!=="\\"){al[am]=ai.replace(/[a-zA-Z]/g,function(aq){var ar=aq.charCodeAt(0);return"["+String.fromCharCode(ar&~32,ar|32)+"]"})}}}}return al.join("")}var ac=[];for(var X=0,W=ab.length;X<W;++X){var ag=ab[X];if(ag.global||ag.multiline){throw new Error(""+ag)}ac.push("(?:"+Y(ag)+")")}return new RegExp(ac.join("|"),ae?"gi":"g")}function b(aa,Y){var W=/(?:^|\s)nocode(?:\s|$)/;var ab=[];var Z=0;var X=[];var V=0;function U(ac){switch(ac.nodeType){case 1:if(W.test(ac.className)){return}for(var af=ac.firstChild;af;af=af.nextSibling){U(af)}var ae=ac.nodeName.toLowerCase();if("br"===ae||"li"===ae){ab[V]="\n";X[V<<1]=Z++;X[(V++<<1)|1]=ac}break;case 3:case 4:var ad=ac.nodeValue;if(ad.length){if(!Y){ad=ad.replace(/[ \t\r\n]+/g," ")}else{ad=ad.replace(/\r\n?/g,"\n")}ab[V]=ad;X[V<<1]=Z;Z+=ad.length;X[(V++<<1)|1]=ac}break}}U(aa);return{sourceCode:ab.join("").replace(/\n$/,""),spans:X}}function C(U,W,Y,V){if(!W){return}var X={sourceCode:W,basePos:U};Y(X);V.push.apply(V,X.decorations)}var w=/\S/;function p(U){var X=undefined;for(var W=U.firstChild;W;W=W.nextSibling){var V=W.nodeType;X=(V===1)?(X?U:W):(V===3)?(w.test(W.nodeValue)?U:X):X}return X===U?undefined:X}function h(W,V){var U={};var X;(function(){var af=W.concat(V);var aj=[];var ai={};for(var ad=0,ab=af.length;ad<ab;++ad){var aa=af[ad];var ae=aa[3];if(ae){for(var ag=ae.length;--ag>=0;){U[ae.charAt(ag)]=aa}}var ah=aa[1];var ac=""+ah;if(!ai.hasOwnProperty(ac)){aj.push(ah);ai[ac]=null}}aj.push(/[\0-\uffff]/);X=l(aj)})();var Z=V.length;var Y=function(aj){var ab=aj.sourceCode,aa=aj.basePos;var af=[aa,G];var ah=0;var ap=ab.match(X)||[];var al={};for(var ag=0,at=ap.length;ag<at;++ag){var ai=ap[ag];var ar=al[ai];var ak=void 0;var ao;if(typeof ar==="string"){ao=false}else{var ac=U[ai.charAt(0)];if(ac){ak=ai.match(ac[1]);ar=ac[0]}else{for(var aq=0;aq<Z;++aq){ac=V[aq];ak=ai.match(ac[1]);if(ak){ar=ac[0];break}}if(!ak){ar=G}}ao=ar.length>=5&&"lang-"===ar.substring(0,5);if(ao&&!(ak&&typeof ak[1]==="string")){ao=false;ar=K}if(!ao){al[ai]=ar}}var ad=ah;ah+=ai.length;if(!ao){af.push(aa+ad,ar)}else{var an=ak[1];var am=ai.indexOf(an);var ae=am+an.length;if(ak[2]){ae=ai.length-ak[2].length;am=ae-an.length}var au=ar.substring(5);C(aa+ad,ai.substring(0,am),Y,af);C(aa+ad+am,an,r(au,an),af);C(aa+ad+ae,ai.substring(ae),Y,af)}}aj.decorations=af};return Y}function i(V){var Y=[],U=[];if(V.tripleQuotedStrings){Y.push([D,/^(?:\'\'\'(?:[^\'\\]|\\[\s\S]|\'{1,2}(?=[^\']))*(?:\'\'\'|$)|\"\"\"(?:[^\"\\]|\\[\s\S]|\"{1,2}(?=[^\"]))*(?:\"\"\"|$)|\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$))/,null,"'\""])}else{if(V.multiLineStrings){Y.push([D,/^(?:\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$)|\`(?:[^\\\`]|\\[\s\S])*(?:\`|$))/,null,"'\"`"])}else{Y.push([D,/^(?:\'(?:[^\\\'\r\n]|\\.)*(?:\'|$)|\"(?:[^\\\"\r\n]|\\.)*(?:\"|$))/,null,"\"'"])}}if(V.verbatimStrings){U.push([D,/^@\"(?:[^\"]|\"\")*(?:\"|$)/,null])}var ab=V.hashComments;if(ab){if(V.cStyleComments){if(ab>1){Y.push([k,/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,null,"#"])}else{Y.push([k,/^#(?:(?:define|e(?:l|nd)if|else|error|ifn?def|include|line|pragma|undef|warning)\b|[^\r\n]*)/,null,"#"])}U.push([D,/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h(?:h|pp|\+\+)?|[a-z]\w*)>/,null])}else{Y.push([k,/^#[^\r\n]*/,null,"#"])}}if(V.cStyleComments){U.push([k,/^\/\/[^\r\n]*/,null]);U.push([k,/^\/\*[\s\S]*?(?:\*\/|$)/,null])}if(V.regexLiterals){var aa=("/(?=[^/*])(?:[^/\\x5B\\x5C]|\\x5C[\\s\\S]|\\x5B(?:[^\\x5C\\x5D]|\\x5C[\\s\\S])*(?:\\x5D|$))+/");U.push(["lang-regex",new RegExp("^"+N+"("+aa+")")])}var X=V.types;if(X){U.push([Q,X])}var W=(""+V.keywords).replace(/^ | $/g,"");if(W.length){U.push([A,new RegExp("^(?:"+W.replace(/[\s,]+/g,"|")+")\\b"),null])}Y.push([G,/^\s+/,null," \r\n\t\xA0"]);var Z=/^.[^\s\w\.$@\'\"\`\/\\]*/;U.push([H,/^@[a-z_$][a-z_$@0-9]*/i,null],[Q,/^(?:[@_]?[A-Z]+[a-z][A-Za-z_$@0-9]*|\w+_t\b)/,null],[G,/^[a-z_$][a-z_$@0-9]*/i,null],[H,new RegExp("^(?:0x[a-f0-9]+|(?:\\d(?:_\\d+)*\\d*(?:\\.\\d*)?|\\.\\d\\+)(?:e[+\\-]?\\d+)?)[a-z]*","i"),null,"0123456789"],[G,/^\\[\s\S]?/,null],[M,Z,null]);return h(Y,U)}var L=i({keywords:B,hashComments:true,cStyleComments:true,multiLineStrings:true,regexLiterals:true});function S(W,ah,aa){var V=/(?:^|\s)nocode(?:\s|$)/;var ac=/\r\n?|\n/;var ad=W.ownerDocument;var ag=ad.createElement("li");while(W.firstChild){ag.appendChild(W.firstChild)}var X=[ag];function af(am){switch(am.nodeType){case 1:if(V.test(am.className)){break}if("br"===am.nodeName){ae(am);if(am.parentNode){am.parentNode.removeChild(am)}}else{for(var ao=am.firstChild;ao;ao=ao.nextSibling){af(ao)}}break;case 3:case 4:if(aa){var an=am.nodeValue;var ak=an.match(ac);if(ak){var aj=an.substring(0,ak.index);am.nodeValue=aj;var ai=an.substring(ak.index+ak[0].length);if(ai){var al=am.parentNode;al.insertBefore(ad.createTextNode(ai),am.nextSibling)}ae(am);if(!aj){am.parentNode.removeChild(am)}}}break}}function ae(al){while(!al.nextSibling){al=al.parentNode;if(!al){return}}function aj(am,at){var ar=at?am.cloneNode(false):am;var ap=am.parentNode;if(ap){var aq=aj(ap,1);var ao=am.nextSibling;aq.appendChild(ar);for(var an=ao;an;an=ao){ao=an.nextSibling;aq.appendChild(an)}}return ar}var ai=aj(al.nextSibling,0);for(var ak;(ak=ai.parentNode)&&ak.nodeType===1;){ai=ak}X.push(ai)}for(var Z=0;Z<X.length;++Z){af(X[Z])}if(ah===(ah|0)){X[0].setAttribute("value",ah)}var ab=ad.createElement("ol");ab.className="linenums";var Y=Math.max(0,((ah-1))|0)||0;for(var Z=0,U=X.length;Z<U;++Z){ag=X[Z];ag.className="L"+((Z+Y)%10);if(!ag.firstChild){ag.appendChild(ad.createTextNode("\xA0"))}ab.appendChild(ag)}W.appendChild(ab)}function E(af){var X=/\bMSIE\s(\d+)/.exec(navigator.userAgent);X=X&&+X[1]<=8;var ao=/\n/g;var an=af.sourceCode;var ap=an.length;var Y=0;var ad=af.spans;var V=ad.length;var aj=0;var aa=af.decorations;var ab=aa.length;var ac=0;aa[ab]=ap;var av,at;for(at=av=0;at<ab;){if(aa[at]!==aa[at+2]){aa[av++]=aa[at++];aa[av++]=aa[at++]}else{at+=2}}ab=av;for(at=av=0;at<ab;){var aw=aa[at];var ae=aa[at+1];var Z=at+2;while(Z+2<=ab&&aa[Z+1]===ae){Z+=2}aa[av++]=aw;aa[av++]=ae;at=Z}ab=aa.length=av;var au=af.sourceNode;var ak;if(au){ak=au.style.display;au.style.display="none"}try{var ah=null;while(aj<V){var ai=ad[aj];var U=ad[aj+2]||ap;var ar=aa[ac+2]||ap;var Z=Math.min(U,ar);var am=ad[aj+1];var W;if(am.nodeType!==1&&(W=an.substring(Y,Z))){if(X){W=W.replace(ao,"\r")}am.nodeValue=W;var al=am.ownerDocument;var aq=al.createElement("span");aq.className=aa[ac+1];var ag=am.parentNode;ag.replaceChild(aq,am);aq.appendChild(am);if(Y<U){ad[aj+1]=am=al.createTextNode(an.substring(Z,U));ag.insertBefore(am,aq.nextSibling)}}Y=Z;if(Y>=U){aj+=2}if(Y>=ar){ac+=2}}}finally{if(au){au.style.display=ak}}}var u={};function d(W,X){for(var U=X.length;--U>=0;){var V=X[U];if(!u.hasOwnProperty(V)){u[V]=W}else{if(O.console){console.warn("cannot override language handler %s",V)}}}}function r(V,U){if(!(V&&u.hasOwnProperty(V))){V=/^\s*</.test(U)?"default-markup":"default-code"}return u[V]}d(L,["default-code"]);d(h([],[[G,/^[^<?]+/],[F,/^<!\w[^>]*(?:>|$)/],[k,/^<\!--[\s\S]*?(?:-\->|$)/],["lang-",/^<\?([\s\S]+?)(?:\?>|$)/],["lang-",/^<%([\s\S]+?)(?:%>|$)/],[M,/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\s\S]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\s\S]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),["default-markup","htm","html","mxml","xhtml","xml","xsl"]);d(h([[G,/^[\s]+/,null," \t\r\n"],[o,/^(?:\"[^\"]*\"?|\'[^\']*\'?)/,null,"\"'"]],[[n,/^^<\/?[a-z](?:[\w.:-]*\w)?|\/?>$/i],[R,/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^>\'\"\s]*(?:[^>\'\"\s\/]|\/(?=\s)))/],[M,/^[=<>\/]+/],["lang-js",/^on\w+\s*=\s*\"([^\"]+)\"/i],["lang-js",/^on\w+\s*=\s*\'([^\']+)\'/i],["lang-js",/^on\w+\s*=\s*([^\"\'>\s]+)/i],["lang-css",/^style\s*=\s*\"([^\"]+)\"/i],["lang-css",/^style\s*=\s*\'([^\']+)\'/i],["lang-css",/^style\s*=\s*([^\"\'>\s]+)/i]]),["in.tag"]);d(h([],[[o,/^[\s\S]+/]]),["uq.val"]);d(i({keywords:m,hashComments:true,cStyleComments:true,types:f}),["c","cc","cpp","cxx","cyc","m"]);d(i({keywords:"null,true,false"}),["json"]);d(i({keywords:T,hashComments:true,cStyleComments:true,verbatimStrings:true,types:f}),["cs"]);d(i({keywords:y,cStyleComments:true}),["java"]);d(i({keywords:I,hashComments:true,multiLineStrings:true}),["bsh","csh","sh"]);d(i({keywords:J,hashComments:true,multiLineStrings:true,tripleQuotedStrings:true}),["cv","py"]);d(i({keywords:t,hashComments:true,multiLineStrings:true,regexLiterals:true}),["perl","pl","pm"]);d(i({keywords:g,hashComments:true,multiLineStrings:true,regexLiterals:true}),["rb"]);d(i({keywords:x,cStyleComments:true,regexLiterals:true}),["js"]);d(i({keywords:s,hashComments:3,cStyleComments:true,multilineStrings:true,tripleQuotedStrings:true,regexLiterals:true}),["coffee"]);d(h([],[[D,/^[\s\S]+/]]),["regex"]);function e(X){var W=X.langExtension;try{var U=b(X.sourceNode,X.pre);var V=U.sourceCode;X.sourceCode=V;X.spans=U.spans;X.basePos=0;r(W,V)(X);E(X)}catch(Y){if(O.console){console.log(Y&&Y.stack?Y.stack:Y)}}}function z(Y,X,W){var U=document.createElement("pre");U.innerHTML=Y;if(W){S(U,W,true)}var V={langExtension:X,numberLines:W,sourceNode:U,pre:1};e(V);return U.innerHTML}function c(aj){function ab(al){return document.getElementsByTagName(al)}var ah=[ab("pre"),ab("code"),ab("xmp")];var V=[];for(var ae=0;ae<ah.length;++ae){for(var ac=0,Y=ah[ae].length;ac<Y;++ac){V.push(ah[ae][ac])}}ah=null;var Z=Date;if(!Z.now){Z={now:function(){return +(new Date)}}}var aa=0;var U;var af=/\blang(?:uage)?-([\w.]+)(?!\S)/;var ak=/\bprettyprint\b/;var W=/\bprettyprinted\b/;var ag=/pre|xmp/i;var ai=/^code$/i;var ad=/^(?:pre|code|xmp)$/i;function X(){var ar=(O.PR_SHOULD_USE_CONTINUATION?Z.now()+250:Infinity);for(;aa<V.length&&Z.now()<ar;aa++){var at=V[aa];var au=at.className;if(ak.test(au)&&!W.test(au)){var aw=false;for(var ao=at.parentNode;ao;ao=ao.parentNode){var ax=ao.tagName;if(ad.test(ax)&&ao.className&&ak.test(ao.className)){aw=true;break}}if(!aw){at.className+=" prettyprinted";var aq=au.match(af);var am;if(!aq&&(am=p(at))&&ai.test(am.tagName)){aq=am.className.match(af)}if(aq){aq=aq[1]}var ap;if(ag.test(at.tagName)){ap=1}else{var an=at.currentStyle;var al=(an?an.whiteSpace:(document.defaultView&&document.defaultView.getComputedStyle)?document.defaultView.getComputedStyle(at,null).getPropertyValue("white-space"):0);ap=al&&"pre"===al.substring(0,3)}var av=at.className.match(/\blinenums\b(?::(\d+))?/);av=av?av[1]&&av[1].length?+av[1]:true:false;if(av){S(at,av,ap)}U={langExtension:aq,sourceNode:at,numberLines:av,pre:ap};e(U)}}}if(aa<V.length){setTimeout(X,250)}else{if(aj){aj()}}}X()}var a=O.PR={createSimpleLexer:h,registerLangHandler:d,sourceDecorator:i,PR_ATTRIB_NAME:R,PR_ATTRIB_VALUE:o,PR_COMMENT:k,PR_DECLARATION:F,PR_KEYWORD:A,PR_LITERAL:H,PR_NOCODE:P,PR_PLAIN:G,PR_PUNCTUATION:M,PR_SOURCE:K,PR_STRING:D,PR_TAG:n,PR_TYPE:Q,prettyPrintOne:O.prettyPrintOne=z,prettyPrint:O.prettyPrint=c};if(typeof define==="function"&&define.amd){define("google-code-prettify",[],function(){return a})}})();PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_DECLARATION,/^<!\w[^>]*(?:>|$)/],[PR.PR_COMMENT,/^<\!--[\s\S]*?(?:-\->|$)/],[PR.PR_PUNCTUATION,/^(?:<[%?]|[%?]>)/],["lang-",/^<\?([\s\S]+?)(?:\?>|$)/],["lang-",/^<%([\s\S]+?)(?:%>|$)/],["lang-",/^<xmp\b[^>]*>([\s\S]+?)<\/xmp\b[^>]*>/i],["lang-handlebars",/^<script\b[^>]*type\s*=\s*['"]?text\/x-handlebars-template['"]?\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-js",/^<script\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\s\S]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i],[PR.PR_DECLARATION,/^{{[#^>/]?\s*[\w.][^}]*}}/],[PR.PR_DECLARATION,/^{{&?\s*[\w.][^}]*}}/],[PR.PR_DECLARATION,/^{{{>?\s*[\w.][^}]*}}}/],[PR.PR_COMMENT,/^{{![^}]*}}/]]),["handlebars","hbs"]);PR.registerLangHandler(PR.createSimpleLexer([[PR.PR_PLAIN,/^[ \t\r\n\f]+/,null," \t\r\n\f"]],[[PR.PR_STRING,/^\"(?:[^\n\r\f\\\"]|\\(?:\r\n?|\n|\f)|\\[\s\S])*\"/,null],[PR.PR_STRING,/^\'(?:[^\n\r\f\\\']|\\(?:\r\n?|\n|\f)|\\[\s\S])*\'/,null],["lang-css-str",/^url\(([^\)\"\']*)\)/i],[PR.PR_KEYWORD,/^(?:url|rgb|\!important|@import|@page|@media|@charset|inherit)(?=[^\-\w]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|(?:\\[0-9a-f]+ ?))(?:[_a-z0-9\-]|\\(?:\\[0-9a-f]+ ?))*)\s*:/i],[PR.PR_COMMENT,/^\/\*[^*]*\*+(?:[^\/*][^*]*\*+)*\//],[PR.PR_COMMENT,/^(?:<!--|-->)/],[PR.PR_LITERAL,/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],[PR.PR_LITERAL,/^#(?:[0-9a-f]{3}){1,2}/i],[PR.PR_PLAIN,/^-?(?:[_a-z]|(?:\\[\da-f]+ ?))(?:[_a-z\d\-]|\\(?:\\[\da-f]+ ?))*/i],[PR.PR_PUNCTUATION,/^[^\s\w\'\"]+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_KEYWORD,/^-?(?:[_a-z]|(?:\\[\da-f]+ ?))(?:[_a-z\d\-]|\\(?:\\[\da-f]+ ?))*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_STRING,/^[^\)\"\']+/]]),["css-str"]);
\ No newline at end of file
diff --git a/docs/classes/Roles.html b/docs/classes/Roles.html
new file mode 100644
index 00000000..f1970951
--- /dev/null
+++ b/docs/classes/Roles.html
@@ -0,0 +1,5185 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Roles - The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+    <link rel="icon" href="../assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="../assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="../classes/Roles.html">Roles</a></li>
+                                <li><a href="../classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="../modules/Roles.html">Roles</a></li>
+                                <li><a href="../modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+<h1>Roles Class</h1>
+<div class="box meta">
+
+
+        <div class="foundat">
+            Defined in: <a href="../files/roles_roles_common_async.js.html#l41"><code>roles&#x2F;roles_common_async.js:41</code></a>
+        </div>
+
+            Module: <a href="../modules/Roles.html">Roles</a>
+
+</div>
+
+
+<div class="box intro">
+    
+</div>
+
+
+<div id="classdocs" class="tabview">
+    <ul class="api-class-tabs">
+        <li class="api-class-tab index"><a href="#index">Index</a></li>
+
+            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
+            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
+    </ul>
+
+    <div>
+        <div id="index" class="api-class-tabpanel index">
+            <h2 class="off-left">Item Index</h2>
+
+                <div class="index-section methods">
+                    <h3>Methods</h3>
+
+                    <ul class="index-list methods">
+                            <li class="index-item method private">
+                                <a href="#method__addRoleToParent">_addRoleToParent</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__addRoleToParentAsync">_addRoleToParentAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__addUserToRole">_addUserToRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__addUserToRoleAsync">_addUserToRoleAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__checkRoleName">_checkRoleName</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__checkRoleName">_checkRoleName</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__checkRoleName">_checkRoleName</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__checkScopeName">_checkScopeName</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__getInheritedRoleNames">_getInheritedRoleNames</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__getInheritedRoleNames">_getInheritedRoleNames</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__getParentRoleNames">_getParentRoleNames</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__getParentRoleNamesAsync">_getParentRoleNamesAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__getUsersInRoleCursor">_getUsersInRoleCursor</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__getUsersInRoleCursor">_getUsersInRoleCursor</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__normalizeOptions">_normalizeOptions</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__normalizeOptions">_normalizeOptions</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__normalizeScopeName">_normalizeScopeName</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__normalizeScopeName">_normalizeScopeName</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__removeRoleFromParent">_removeRoleFromParent</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__removeRoleFromParentAsync">_removeRoleFromParentAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__removeUserFromRole">_removeUserFromRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method private">
+                                <a href="#method__removeUserFromRoleAsync">_removeUserFromRoleAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_addRolesToParent">addRolesToParent</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_addRolesToParentAsync">addRolesToParentAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_addUsersToRoles">addUsersToRoles</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_addUsersToRolesAsync">addUsersToRolesAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_createRole">createRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_createRoleAsync">createRoleAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_deleteRole">deleteRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_deleteRoleAsync">deleteRoleAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getAllRoles">getAllRoles</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getAllRoles">getAllRoles</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method deprecated">
+                                <a href="#method_getGroupsForUser">getGroupsForUser</a>
+
+                                    <span class="flag static">static</span>
+                                    <span class="flag deprecated">deprecated</span>
+                            </li>
+                            <li class="index-item method deprecated">
+                                <a href="#method_getGroupsForUserAsync">getGroupsForUserAsync</a>
+
+                                    <span class="flag static">static</span>
+                                    <span class="flag deprecated">deprecated</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getRolesForUser">getRolesForUser</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getRolesForUserAsync">getRolesForUserAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getScopesForUser">getScopesForUser</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getScopesForUserAsync">getScopesForUserAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getUserAssignmentsForRole">getUserAssignmentsForRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getUserAssignmentsForRole">getUserAssignmentsForRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getUsersInRole">getUsersInRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_getUsersInRoleAsync">getUsersInRoleAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_isParentOf">isParentOf</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_isParentOfAsync">isParentOfAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_removeRolesFromParent">removeRolesFromParent</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_removeRolesFromParentAsync">removeRolesFromParentAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_removeScope">removeScope</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_removeScopeAsync">removeScopeAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_removeUsersFromRoles">removeUsersFromRoles</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_removeUsersFromRolesAsync">removeUsersFromRolesAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_renameRole">renameRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_renameRoleAsync">renameRoleAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_renameScope">renameScope</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_renameScopeAsync">renameScopeAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_setUserRoles">setUserRoles</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_setUserRolesAsync">setUserRolesAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_userIsInRole">userIsInRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                            <li class="index-item method">
+                                <a href="#method_userIsInRoleAsync">userIsInRoleAsync</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                    </ul>
+                </div>
+
+                <div class="index-section properties">
+                    <h3>Properties</h3>
+
+                    <ul class="index-list properties">
+                            <li class="index-item property deprecated">
+                                <a href="#property_GLOBAL_GROUP">GLOBAL_GROUP</a>
+
+                                    <span class="flag static">static</span>
+                                    <span class="flag deprecated">deprecated</span>
+                            </li>
+                            <li class="index-item property deprecated">
+                                <a href="#property_GLOBAL_GROUP">GLOBAL_GROUP</a>
+
+                                    <span class="flag static">static</span>
+                                    <span class="flag deprecated">deprecated</span>
+                            </li>
+                    </ul>
+                </div>
+
+
+        </div>
+
+            <div id="methods" class="api-class-tabpanel">
+                <h2 class="off-left">Methods</h2>
+
+<div id="method__addRoleToParent" class="method item private">
+    <h3 class="name"><code>_addRoleToParent</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l205"><code>roles&#x2F;roles_client.js:205</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__addRoleToParentAsync" class="method item private">
+    <h3 class="name"><code>_addRoleToParentAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l277"><code>roles&#x2F;roles_common_async.js:277</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method__addUserToRole" class="method item private">
+    <h3 class="name"><code>_addUserToRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>userId</code>
+                </li>
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>options</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l437"><code>roles&#x2F;roles_client.js:437</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Add one user to one role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">userId</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The user ID.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of the role to add the user to. The role have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">options</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>ifExists</code>: if <code>true</code>, do not throw an exception if the role does not exist</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__addUserToRoleAsync" class="method item private">
+    <h3 class="name"><code>_addUserToRoleAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>userId</code>
+                </li>
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>options</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l555"><code>roles&#x2F;roles_common_async.js:555</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Add one user to one role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">userId</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The user ID.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of the role to add the user to. The role have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">options</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>ifExists</code>: if <code>true</code>, do not throw an exception if the role does not exist</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method__checkRoleName" class="method item private">
+    <h3 class="name"><code>_checkRoleName</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l989"><code>roles&#x2F;roles_client.js:989</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Throw an exception if <code>roleName</code> is an invalid role name.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>A role name to match against.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__checkRoleName" class="method item private">
+    <h3 class="name"><code>_checkRoleName</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>scopeName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l1083"><code>roles&#x2F;roles_client.js:1083</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Throw an exception if <code>scopeName</code> is an invalid scope name.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">scopeName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>A scope name to match against.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__checkRoleName" class="method item private">
+    <h3 class="name"><code>_checkRoleName</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1208"><code>roles&#x2F;roles_common_async.js:1208</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Throw an exception if <code>roleName</code> is an invalid role name.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>A role name to match against.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__checkScopeName" class="method item private">
+    <h3 class="name"><code>_checkScopeName</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>scopeName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1309"><code>roles&#x2F;roles_common_async.js:1309</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Throw an exception if <code>scopeName</code> is an invalid scope name.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">scopeName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>A scope name to match against.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__getInheritedRoleNames" class="method item private">
+    <h3 class="name"><code>_getInheritedRoleNames</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>role</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l520"><code>roles&#x2F;roles_client.js:520</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Returns an array of role names the given role name is a parent of.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">role</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>The role object</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles._getInheritedRoleNames({ _id: 'admin', children; [] })</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method__getInheritedRoleNames" class="method item private">
+    <h3 class="name"><code>_getInheritedRoleNames</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>role</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l683"><code>roles&#x2F;roles_common_async.js:683</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Returns an array of role names the given role name is a parent of.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">role</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>The role object</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles._getInheritedRoleNames({ _id: 'admin', children; [] })</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method__getParentRoleNames" class="method item private">
+    <h3 class="name"><code>_getParentRoleNames</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>role</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l491"><code>roles&#x2F;roles_client.js:491</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Returns an array of role names the given role name is a child of.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">role</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>The role object</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles._getParentRoleNames({ _id: 'admin', children; [] })</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method__getParentRoleNamesAsync" class="method item private">
+    <h3 class="name"><code>_getParentRoleNamesAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>role</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l651"><code>roles&#x2F;roles_common_async.js:651</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Returns an array of role names the given role name is a child of.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">role</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>The role object</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles._getParentRoleNamesAsync({ _id: 'admin', children; [] })</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method__getUsersInRoleCursor" class="method item private">
+    <h3 class="name"><code>_getUsersInRoleCursor</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[filter]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Object</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l844"><code>roles&#x2F;roles_client.js:844</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles. If array, ids of users are
+returned which have at least one of the roles
+assigned but need not have <em>all</em> roles.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope to restrict roles to; user's global
+roles will also be checked</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[filter]</code>
+                        <span class="type">Object</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options which are passed directly
+through to <code>RoleAssignmentCollection.find(query, options)</code></p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Object</span>:
+                    <p>Cursor to the assignment documents</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method__getUsersInRoleCursor" class="method item private">
+    <h3 class="name"><code>_getUsersInRoleCursor</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[filter]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Object</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1041"><code>roles&#x2F;roles_common_async.js:1041</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles. If array, ids of users are
+returned which have at least one of the roles
+assigned but need not have <em>all</em> roles.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope to restrict roles to; user's global
+roles will also be checked</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[filter]</code>
+                        <span class="type">Object</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options which are passed directly
+through to <code>RoleAssignmentCollection.find(query, options)</code></p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Object</span>:
+                    <p>Cursor to the assignment documents</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method__normalizeOptions" class="method item private">
+    <h3 class="name"><code>_normalizeOptions</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>options</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Object</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l1044"><code>roles&#x2F;roles_client.js:1044</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Normalize options.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">options</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>Options to normalize.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Object</span>:
+                    <p>Normalized options.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method__normalizeOptions" class="method item private">
+    <h3 class="name"><code>_normalizeOptions</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>options</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Object</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1268"><code>roles&#x2F;roles_common_async.js:1268</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Normalize options.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">options</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>Options to normalize.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Object</span>:
+                    <p>Normalized options.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method__normalizeScopeName" class="method item private">
+    <h3 class="name"><code>_normalizeScopeName</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>scopeName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">String</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l1065"><code>roles&#x2F;roles_client.js:1065</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Normalize scope name.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">scopeName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>A scope name to normalize.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">String</span>:
+                    <p>Normalized scope name.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method__normalizeScopeName" class="method item private">
+    <h3 class="name"><code>_normalizeScopeName</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>scopeName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">String</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1291"><code>roles&#x2F;roles_common_async.js:1291</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Normalize scope name.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">scopeName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>A scope name to normalize.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">String</span>:
+                    <p>Normalized scope name.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method__removeRoleFromParent" class="method item private">
+    <h3 class="name"><code>_removeRoleFromParent</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l274"><code>roles&#x2F;roles_client.js:274</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__removeRoleFromParentAsync" class="method item private">
+    <h3 class="name"><code>_removeRoleFromParentAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l362"><code>roles&#x2F;roles_common_async.js:362</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method__removeUserFromRole" class="method item private">
+    <h3 class="name"><code>_removeUserFromRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>userId</code>
+                </li>
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>options</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l593"><code>roles&#x2F;roles_client.js:593</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove one user from one role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">userId</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The user ID.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of the role to add the user to. The role have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">options</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method__removeUserFromRoleAsync" class="method item private">
+    <h3 class="name"><code>_removeUserFromRoleAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>userId</code>
+                </li>
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code>options</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+        <span class="flag private">private</span>
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l763"><code>roles&#x2F;roles_common_async.js:763</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove one user from one role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">userId</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The user ID.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of the role to add the user to. The role have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">options</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_addRolesToParent" class="method item">
+    <h3 class="name"><code>addRolesToParent</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>rolesNames</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l185"><code>roles&#x2F;roles_client.js:185</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Add role parent to roles.</p>
+<p>Previous parents are kept (role can have multiple parents). For users which have the
+parent role set, new subroles are added automatically.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">rolesNames</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of role(s).</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method_addRolesToParentAsync" class="method item">
+    <h3 class="name"><code>addRolesToParentAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>rolesNames</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l256"><code>roles&#x2F;roles_common_async.js:256</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Add role parent to roles.</p>
+<p>Previous parents are kept (role can have multiple parents). For users which have the
+parent role set, new subroles are added automatically.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">rolesNames</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of role(s).</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_addUsersToRoles" class="method item">
+    <h3 class="name"><code>addUsersToRoles</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>users</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l323"><code>roles&#x2F;roles_client.js:323</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Add users to roles.</p>
+<p>Adds roles to existing roles for each user.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">users</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>User ID(s) or object(s) with an <code>_id</code> field.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of roles to add users to. Roles have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>ifExists</code>: if <code>true</code>, do not throw an exception if the role does not exist</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles.addUsersToRoles(userId, 'admin')
+Roles.addUsersToRoles(userId, ['view-secrets'], 'example.com')
+Roles.addUsersToRoles([user1, user2], ['user','editor'])
+Roles.addUsersToRoles([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method_addUsersToRolesAsync" class="method item">
+    <h3 class="name"><code>addUsersToRolesAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>users</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l433"><code>roles&#x2F;roles_common_async.js:433</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Add users to roles.</p>
+<p>Adds roles to existing roles for each user.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">users</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>User ID(s) or object(s) with an <code>_id</code> field.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of roles to add users to. Roles have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>ifExists</code>: if <code>true</code>, do not throw an exception if the role does not exist</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+                    <p>Alternatively, it can be a scope name string.</p>
+
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles.addUsersToRolesAsync(userId, 'admin')
+Roles.addUsersToRolesAsync(userId, ['view-secrets'], 'example.com')
+Roles.addUsersToRolesAsync([user1, user2], ['user','editor'])
+Roles.addUsersToRolesAsync([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method_createRole" class="method item">
+    <h3 class="name"><code>createRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">String</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l49"><code>roles&#x2F;roles_client.js:49</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Create a new role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>unlessExists</code>: if <code>true</code>, exception will not be thrown in the role already exists</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">String</span>:
+                    <p>ID of the new role or null.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_createRoleAsync" class="method item">
+    <h3 class="name"><code>createRoleAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise<String></span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l73"><code>roles&#x2F;roles_common_async.js:73</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Create a new role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>unlessExists</code>: if <code>true</code>, exception will not be thrown in the role already exists</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise<String></span>:
+                    <p>ID of the new role or null.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_deleteRole" class="method item">
+    <h3 class="name"><code>deleteRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l76"><code>roles&#x2F;roles_client.js:76</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Delete an existing role.</p>
+<p>If the role is set for any user, it is automatically unset.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method_deleteRoleAsync" class="method item">
+    <h3 class="name"><code>deleteRoleAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roleName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l118"><code>roles&#x2F;roles_common_async.js:118</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Delete an existing role.</p>
+<p>If the role is set for any user, it is automatically unset.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getAllRoles" class="method item">
+    <h3 class="name"><code>getAllRoles</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>queryOptions</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Cursor</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l767"><code>roles&#x2F;roles_client.js:767</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve cursor of all existing roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">queryOptions</code>
+                        <span class="type">Object</span>
+
+
+                    <div class="param-description">
+                        <p>Options which are passed directly
+through to <code>RolesCollection.find(query, options)</code>.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Cursor</span>:
+                    <p>Cursor of existing roles.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getAllRoles" class="method item">
+    <h3 class="name"><code>getAllRoles</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code class="optional">[queryOptions]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Cursor</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l956"><code>roles&#x2F;roles_common_async.js:956</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve cursor of all existing roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name optional">[queryOptions]</code>
+                        <span class="type">Object</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options which are passed directly
+through to <code>RolesCollection.find(query, options)</code>.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Cursor</span>:
+                    <p>Cursor of existing roles.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getGroupsForUser" class="method item deprecated">
+    <h3 class="name"><code>getGroupsForUser</code></h3>
+
+        <span class="paren">()</span>
+
+
+        <span class="flag deprecated">deprecated</span>
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l892"><code>roles&#x2F;roles_client.js:892</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Deprecated. Use <code>getScopesForUser</code> instead.</p>
+
+    </div>
+
+
+
+
+</div>
+<div id="method_getGroupsForUserAsync" class="method item deprecated">
+    <h3 class="name"><code>getGroupsForUserAsync</code></h3>
+
+        <span class="paren">()</span>
+
+        <span class="returns-inline">
+            <span class="type">Promise<Array></span>
+        </span>
+
+        <span class="flag deprecated">deprecated</span>
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1097"><code>roles&#x2F;roles_common_async.js:1097</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Deprecated. Use <code>getScopesForUser</code> instead.</p>
+
+    </div>
+
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise<Array></span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getRolesForUser" class="method item">
+    <h3 class="name"><code>getRolesForUser</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>user</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Array</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l691"><code>roles&#x2F;roles_client.js:691</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve user's roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">user</code>
+                        <span class="type">String | Object</span>
+
+
+                    <div class="param-description">
+                        <p>User ID or an actual user object.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of scope to provide roles for; if not specified, global roles are returned</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> and <code>onlyAssigned</code> options are ignored)</li>
+<li><code>onlyScoped</code>: if set, only roles in the specified scope are returned</li>
+<li><code>onlyAssigned</code>: return only assigned roles and not automatically inferred (like subroles)</li>
+<li><code>fullObjects</code>: return full roles objects (<code>true</code>) or just names (<code>false</code>) (<code>onlyAssigned</code> option is ignored) (default <code>false</code>)
+If you have a use-case for this option, please file a feature-request. You shouldn't need to use it as it's
+result strongly dependent on the internal data structure of this plugin.</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Array</span>:
+                    <p>Array of user's roles, unsorted.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getRolesForUserAsync" class="method item">
+    <h3 class="name"><code>getRolesForUserAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>user</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise<Array></span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l871"><code>roles&#x2F;roles_common_async.js:871</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve user's roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">user</code>
+                        <span class="type">String | Object</span>
+
+
+                    <div class="param-description">
+                        <p>User ID or an actual user object.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of scope to provide roles for; if not specified, global roles are returned</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> and <code>onlyAssigned</code> options are ignored)</li>
+<li><code>onlyScoped</code>: if set, only roles in the specified scope are returned</li>
+<li><code>onlyAssigned</code>: return only assigned roles and not automatically inferred (like subroles)</li>
+<li><code>fullObjects</code>: return full roles objects (<code>true</code>) or just names (<code>false</code>) (<code>onlyAssigned</code> option is ignored) (default <code>false</code>)
+If you have a use-case for this option, please file a feature-request. You shouldn't need to use it as it's
+result strongly dependent on the internal data structure of this plugin.</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise<Array></span>:
+                    <p>Array of user's roles, unsorted.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getScopesForUser" class="method item">
+    <h3 class="name"><code>getScopesForUser</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>user</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[roles]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Array</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l908"><code>roles&#x2F;roles_client.js:908</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve users scopes, if any.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">user</code>
+                        <span class="type">String | Object</span>
+
+
+                    <div class="param-description">
+                        <p>User ID or an actual user object.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[roles]</code>
+                        <span class="type">Array | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Name of roles to restrict scopes to.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Array</span>:
+                    <p>Array of user's scopes, unsorted.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getScopesForUserAsync" class="method item">
+    <h3 class="name"><code>getScopesForUserAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>user</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[roles]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise<Array></span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1117"><code>roles&#x2F;roles_common_async.js:1117</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve users scopes, if any.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">user</code>
+                        <span class="type">String | Object</span>
+
+
+                    <div class="param-description">
+                        <p>User ID or an actual user object.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[roles]</code>
+                        <span class="type">Array | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Name of roles to restrict scopes to.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise<Array></span>:
+                    <p>Array of user's scopes, unsorted.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getUserAssignmentsForRole" class="method item">
+    <h3 class="name"><code>getUserAssignmentsForRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Cursor</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l812"><code>roles&#x2F;roles_client.js:812</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve all assignments of a user which are for the target role.</p>
+<p>Options:</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles. If array, users
+returned will have at least one of the roles
+specified but need not have <em>all</em> roles.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope to restrict roles to; user's global
+roles will also be checked</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+<li><code>queryOptions</code>: options which are passed directly
+through to <code>RoleAssignmentCollection.find(query, options)</code></li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Cursor</span>:
+                    <p>Cursor of user assignments for roles.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getUserAssignmentsForRole" class="method item">
+    <h3 class="name"><code>getUserAssignmentsForRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Cursor</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1006"><code>roles&#x2F;roles_common_async.js:1006</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve all assignments of a user which are for the target role.</p>
+<p>Options:</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles. If array, users
+returned will have at least one of the roles
+specified but need not have <em>all</em> roles.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope to restrict roles to; user's global
+roles will also be checked</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+<li><code>queryOptions</code>: options which are passed directly
+through to <code>RoleAssignmentCollection.find(query, options)</code></li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Cursor</span>:
+                    <p>Cursor of user assignments for roles.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getUsersInRole" class="method item">
+    <h3 class="name"><code>getUsersInRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[queryOptions]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Cursor</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l782"><code>roles&#x2F;roles_client.js:782</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve all users who are in target role.</p>
+<p>Options:</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles. If array, users
+returned will have at least one of the roles
+specified but need not have <em>all</em> roles.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope to restrict roles to; user's global
+roles will also be checked</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+<li><code>onlyScoped</code>: if set, only roles in the specified scope are returned</li>
+<li><code>queryOptions</code>: options which are passed directly
+through to <code>Meteor.users.find(query, options)</code></li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[queryOptions]</code>
+                        <span class="type">Object</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options which are passed directly
+through to <code>Meteor.users.find(query, options)</code></p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Cursor</span>:
+                    <p>Cursor of users in roles.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_getUsersInRoleAsync" class="method item">
+    <h3 class="name"><code>getUsersInRoleAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[queryOptions]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise<Cursor></span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l971"><code>roles&#x2F;roles_common_async.js:971</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Retrieve all users who are in target role.</p>
+<p>Options:</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles. If array, users
+returned will have at least one of the roles
+specified but need not have <em>all</em> roles.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope to restrict roles to; user's global
+roles will also be checked</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+<li><code>onlyScoped</code>: if set, only roles in the specified scope are returned</li>
+<li><code>queryOptions</code>: options which are passed directly
+through to <code>Meteor.users.find(query, options)</code></li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[queryOptions]</code>
+                        <span class="type">Object</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options which are passed directly
+through to <code>Meteor.users.find(query, options)</code></p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise<Cursor></span>:
+                    <p>Cursor of users in roles.</p>
+
+            </div>
+        </div>
+
+
+</div>
+<div id="method_isParentOf" class="method item">
+    <h3 class="name"><code>isParentOf</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>parentRoleName</code>
+                </li>
+                <li class="arg">
+                        <code>childRoleName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l1003"><code>roles&#x2F;roles_client.js:1003</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Find out if a role is an ancestor of another role.</p>
+<p>WARNING: If you check this on the client, please make sure all roles are published.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">parentRoleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The role you want to research.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">childRoleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The role you expect to be among the children of parentRoleName.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method_isParentOfAsync" class="method item">
+    <h3 class="name"><code>isParentOfAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>parentRoleName</code>
+                </li>
+                <li class="arg">
+                        <code>childRoleName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1226"><code>roles&#x2F;roles_common_async.js:1226</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Find out if a role is an ancestor of another role.</p>
+<p>WARNING: If you check this on the client, please make sure all roles are published.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">parentRoleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The role you want to research.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">childRoleName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The role you expect to be among the children of parentRoleName.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_removeRolesFromParent" class="method item">
+    <h3 class="name"><code>removeRolesFromParent</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>rolesNames</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l254"><code>roles&#x2F;roles_client.js:254</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove role parent from roles.</p>
+<p>Other parents are kept (role can have multiple parents). For users which have the
+parent role set, removed subrole is removed automatically.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">rolesNames</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of role(s).</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method_removeRolesFromParentAsync" class="method item">
+    <h3 class="name"><code>removeRolesFromParentAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>rolesNames</code>
+                </li>
+                <li class="arg">
+                        <code>parentName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l341"><code>roles&#x2F;roles_common_async.js:341</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove role parent from roles.</p>
+<p>Other parents are kept (role can have multiple parents). For users which have the
+parent role set, removed subrole is removed automatically.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">rolesNames</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of role(s).</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">parentName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of parent role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_removeScope" class="method item">
+    <h3 class="name"><code>removeScope</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>name</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l974"><code>roles&#x2F;roles_client.js:974</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove a scope.</p>
+<p>Roles assigned with a given scope are removed.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">name</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The name of a scope.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method_removeScopeAsync" class="method item">
+    <h3 class="name"><code>removeScopeAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>name</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1192"><code>roles&#x2F;roles_common_async.js:1192</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove a scope.</p>
+<p>Roles assigned with a given scope are removed.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">name</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>The name of a scope.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_removeUsersFromRoles" class="method item">
+    <h3 class="name"><code>removeUsersFromRoles</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>users</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l547"><code>roles&#x2F;roles_client.js:547</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove users from assigned roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">users</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>User ID(s) or object(s) with an <code>_id</code> field.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of roles to remove users from. Roles have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles.removeUsersFromRoles(userId, 'admin')
+Roles.removeUsersFromRoles([userId, user2], ['editor'])
+Roles.removeUsersFromRoles(userId, ['user'], 'group1')</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method_removeUsersFromRolesAsync" class="method item">
+    <h3 class="name"><code>removeUsersFromRolesAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>users</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l716"><code>roles&#x2F;roles_common_async.js:716</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Remove users from assigned roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">users</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>User ID(s) or object(s) with an <code>_id</code> field.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of roles to remove users from. Roles have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+                    <p>Alternatively, it can be a scope name string.</p>
+
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>await Roles.removeUsersFromRolesAsync(userId, 'admin')
+await Roles.removeUsersFromRolesAsync([userId, user2], ['editor'])
+await Roles.removeUsersFromRolesAsync(userId, ['user'], 'group1')</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method_renameRole" class="method item">
+    <h3 class="name"><code>renameRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>oldName</code>
+                </li>
+                <li class="arg">
+                        <code>newName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l126"><code>roles&#x2F;roles_client.js:126</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Rename an existing role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">oldName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Old name of a role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">newName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>New name of a role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method_renameRoleAsync" class="method item">
+    <h3 class="name"><code>renameRoleAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>oldName</code>
+                </li>
+                <li class="arg">
+                        <code>newName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l184"><code>roles&#x2F;roles_common_async.js:184</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Rename an existing role.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">oldName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Old name of a role.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">newName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>New name of a role.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_renameScope" class="method item">
+    <h3 class="name"><code>renameScope</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>oldName</code>
+                </li>
+                <li class="arg">
+                        <code>newName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l945"><code>roles&#x2F;roles_client.js:945</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Rename a scope.</p>
+<p>Roles assigned with a given scope are changed to be under the new scope.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">oldName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Old name of a scope.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">newName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>New name of a scope.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+</div>
+<div id="method_renameScopeAsync" class="method item">
+    <h3 class="name"><code>renameScopeAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>oldName</code>
+                </li>
+                <li class="arg">
+                        <code>newName</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l1158"><code>roles&#x2F;roles_common_async.js:1158</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Rename a scope.</p>
+<p>Roles assigned with a given scope are changed to be under the new scope.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">oldName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Old name of a scope.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">newName</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>New name of a scope.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+            </div>
+        </div>
+
+
+</div>
+<div id="method_setUserRoles" class="method item">
+    <h3 class="name"><code>setUserRoles</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>users</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l375"><code>roles&#x2F;roles_client.js:375</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Set users' roles.</p>
+<p>Replaces all existing roles with a new set of roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">users</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>User ID(s) or object(s) with an <code>_id</code> field.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of roles to add users to. Roles have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>anyScope</code>: if <code>true</code>, remove all roles the user has, of any scope, if <code>false</code>, only the one in the same scope</li>
+<li><code>ifExists</code>: if <code>true</code>, do not throw an exception if the role does not exist</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>Roles.setUserRoles(userId, 'admin')
+Roles.setUserRoles(userId, ['view-secrets'], 'example.com')
+Roles.setUserRoles([user1, user2], ['user','editor'])
+Roles.setUserRoles([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method_setUserRolesAsync" class="method item">
+    <h3 class="name"><code>setUserRolesAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>users</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l489"><code>roles&#x2F;roles_common_async.js:489</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Set users' roles.</p>
+<p>Replaces all existing roles with a new set of roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">users</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>User ID(s) or object(s) with an <code>_id</code> field.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name(s) of roles to add users to. Roles have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope, or <code>null</code> for the global role</li>
+<li><code>anyScope</code>: if <code>true</code>, remove all roles the user has, of any scope, if <code>false</code>, only the one in the same scope</li>
+<li><code>ifExists</code>: if <code>true</code>, do not throw an exception if the role does not exist</li>
+</ul>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise</span>:
+                    <p>Alternatively, it can be a scope name string.</p>
+
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>await Roles.setUserRolesAsync(userId, 'admin')
+await Roles.setUserRolesAsync(userId, ['view-secrets'], 'example.com')
+await Roles.setUserRolesAsync([user1, user2], ['user','editor'])
+await Roles.setUserRolesAsync([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method_userIsInRole" class="method item">
+    <h3 class="name"><code>userIsInRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>user</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Boolean</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l623"><code>roles&#x2F;roles_client.js:623</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Check if user has specified roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">user</code>
+                        <span class="type">String | Object</span>
+
+
+                    <div class="param-description">
+                        <p>User ID or an actual user object.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles to check against. If array,
+will return <code>true</code> if user is in <em>any</em> role.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope; if supplied, limits check to just that scope
+the user's global roles will always be checked whether scope is specified or not</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Boolean</span>:
+                    <p><code>true</code> if user is in <em>any</em> of the target roles</p>
+
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>// global roles
+Roles.userIsInRole(user, 'admin')
+Roles.userIsInRole(user, ['admin','editor'])
+Roles.userIsInRole(userId, 'admin')
+Roles.userIsInRole(userId, ['admin','editor'])
+
+// scope roles (global roles are still checked)
+Roles.userIsInRole(user, 'admin', 'group1')
+Roles.userIsInRole(userId, ['admin','editor'], 'group1')
+Roles.userIsInRole(userId, ['admin','editor'], {scope: 'group1'})</code></pre>
+
+            </div>
+        </div>
+</div>
+<div id="method_userIsInRoleAsync" class="method item">
+    <h3 class="name"><code>userIsInRoleAsync</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>user</code>
+                </li>
+                <li class="arg">
+                        <code>roles</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[options]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Promise<Boolean></span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l794"><code>roles&#x2F;roles_common_async.js:794</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>Check if user has specified roles.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">user</code>
+                        <span class="type">String | Object</span>
+
+
+                    <div class="param-description">
+                        <p>User ID or an actual user object.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name">roles</code>
+                        <span class="type">Array | String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or an array of roles to check against. If array,
+will return <code>true</code> if user is in <em>any</em> role.
+Roles do not have to exist.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[options]</code>
+                        <span class="type">Object | String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Options:</p>
+<ul>
+<li><code>scope</code>: name of the scope; if supplied, limits check to just that scope
+the user's global roles will always be checked whether scope is specified or not</li>
+<li><code>anyScope</code>: if set, role can be in any scope (<code>scope</code> option is ignored)</li>
+</ul>
+<p>Alternatively, it can be a scope name string.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Promise<Boolean></span>:
+                    <p><code>true</code> if user is in <em>any</em> of the target roles</p>
+
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>// global roles
+await Roles.userIsInRoleAsync(user, 'admin')
+await Roles.userIsInRoleAsync(user, ['admin','editor'])
+await Roles.userIsInRoleAsync(userId, 'admin')
+await Roles.userIsInRoleAsync(userId, ['admin','editor'])
+
+// scope roles (global roles are still checked)
+await Roles.userIsInRoleAsync(user, 'admin', 'group1')
+await Roles.userIsInRoleAsync(userId, ['admin','editor'], 'group1')
+await Roles.userIsInRoleAsync(userId, ['admin','editor'], {scope: 'group1'})</code></pre>
+
+            </div>
+        </div>
+</div>
+            </div>
+
+            <div id="properties" class="api-class-tabpanel">
+                <h2 class="off-left">Properties</h2>
+
+<div id="property_GLOBAL_GROUP" class="property item deprecated">
+    <h3 class="name"><code>GLOBAL_GROUP</code></h3>
+    <span class="type">Unknown</span>
+
+        <span class="flag deprecated">deprecated</span>
+
+
+
+        <span class="flag static">static</span>
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_client.js.html#l40"><code>roles&#x2F;roles_client.js:40</code></a>
+        </p>
+
+
+    </div>
+
+    <div class="description">
+        <p>Used as a global group (now scope) name. Not used anymore.</p>
+
+    </div>
+
+
+
+</div>
+<div id="property_GLOBAL_GROUP" class="property item deprecated">
+    <h3 class="name"><code>GLOBAL_GROUP</code></h3>
+    <span class="type">Unknown</span>
+
+        <span class="flag deprecated">deprecated</span>
+
+
+
+        <span class="flag static">static</span>
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_roles_common_async.js.html#l64"><code>roles&#x2F;roles_common_async.js:64</code></a>
+        </p>
+
+
+    </div>
+
+    <div class="description">
+        <p>Used as a global group (now scope) name. Not used anymore.</p>
+
+    </div>
+
+
+
+</div>
+            </div>
+
+
+    </div>
+</div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/classes/UIHelpers.html b/docs/classes/UIHelpers.html
new file mode 100644
index 00000000..2efd2572
--- /dev/null
+++ b/docs/classes/UIHelpers.html
@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>UIHelpers - The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+    <link rel="icon" href="../assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="../assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="../classes/Roles.html">Roles</a></li>
+                                <li><a href="../classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="../modules/Roles.html">Roles</a></li>
+                                <li><a href="../modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+<h1>UIHelpers Class</h1>
+<div class="box meta">
+
+
+
+            Module: <a href="../modules/UIHelpers.html">UIHelpers</a>
+
+</div>
+
+
+<div class="box intro">
+    
+</div>
+
+
+<div id="classdocs" class="tabview">
+    <ul class="api-class-tabs">
+        <li class="api-class-tab index"><a href="#index">Index</a></li>
+
+            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
+    </ul>
+
+    <div>
+        <div id="index" class="api-class-tabpanel index">
+            <h2 class="off-left">Item Index</h2>
+
+                <div class="index-section methods">
+                    <h3>Methods</h3>
+
+                    <ul class="index-list methods">
+                            <li class="index-item method">
+                                <a href="#method_isInRole">isInRole</a>
+
+                                    <span class="flag static">static</span>
+                            </li>
+                    </ul>
+                </div>
+
+
+
+        </div>
+
+            <div id="methods" class="api-class-tabpanel">
+                <h2 class="off-left">Methods</h2>
+
+<div id="method_isInRole" class="method item">
+    <h3 class="name"><code>isInRole</code></h3>
+
+        <div class="args">
+            <span class="paren">(</span><ul class="args-list inline commas">
+                <li class="arg">
+                        <code>role</code>
+                </li>
+                <li class="arg">
+                        <code class="optional">[scope]</code>
+                </li>
+            </ul><span class="paren">)</span>
+        </div>
+
+        <span class="returns-inline">
+            <span class="type">Boolean</span>
+        </span>
+
+
+
+
+        <span class="flag static">static</span>
+
+
+
+    <div class="meta">
+                <p>
+                Defined in
+        <a href="../files/roles_client_uiHelpers.js.html#l23"><code>roles&#x2F;client&#x2F;uiHelpers.js:23</code></a>
+        </p>
+
+
+
+    </div>
+
+    <div class="description">
+        <p>UI helper to check if current user is in at least one
+of the target roles.  For use in client-side templates.</p>
+
+    </div>
+
+        <div class="params">
+            <h4>Parameters:</h4>
+
+            <ul class="params-list">
+                <li class="param">
+                        <code class="param-name">role</code>
+                        <span class="type">String</span>
+
+
+                    <div class="param-description">
+                        <p>Name of role or comma-seperated list of roles.</p>
+
+                    </div>
+
+                </li>
+                <li class="param">
+                        <code class="param-name optional">[scope]</code>
+                        <span class="type">String</span>
+                        <span class="flag optional" title="This parameter is optional.">optional</span>
+
+
+                    <div class="param-description">
+                        <p>Optional, name of scope to check.</p>
+
+                    </div>
+
+                </li>
+            </ul>
+        </div>
+
+        <div class="returns">
+            <h4>Returns:</h4>
+
+            <div class="returns-description">
+                        <span class="type">Boolean</span>:
+                    <p><code>true</code> if current user is in at least one of the target roles.</p>
+
+            </div>
+        </div>
+
+
+        <div class="example">
+            <h4>Example:</h4>
+
+            <div class="example-content">
+                <pre class="code prettyprint"><code>{{#if isInRole 'admin'}}
+{{/if}}
+
+{{#if isInRole 'editor,user'}}
+{{/if}}
+
+{{#if isInRole 'editor,user' 'scope1'}}
+{{/if}}</code></pre>
+
+            </div>
+        </div>
+</div>
+            </div>
+
+
+
+    </div>
+</div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/classes/index.html b/docs/classes/index.html
new file mode 100644
index 00000000..487fe15b
--- /dev/null
+++ b/docs/classes/index.html
@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+    <head>
+        <title>Redirector</title>
+        <meta http-equiv="refresh" content="0;url=../">
+    </head>
+    <body>
+        <a href="../">Click here to redirect</a>
+    </body>
+</html>
diff --git a/docs/data.json b/docs/data.json
new file mode 100644
index 00000000..7988adc5
--- /dev/null
+++ b/docs/data.json
@@ -0,0 +1,1743 @@
+{
+    "project": {
+        "name": "The meteor-roles API",
+        "description": "The meteor-roles API: an authorization package for Meteor",
+        "version": "v4.0.0"
+    },
+    "files": {
+        "roles/client/uiHelpers.js": {
+            "name": "roles/client/uiHelpers.js",
+            "modules": {
+                "UIHelpers": 1
+            },
+            "classes": {},
+            "fors": {
+                "UIHelpers": 1
+            },
+            "namespaces": {}
+        },
+        "roles/roles_client.js": {
+            "name": "roles/roles_client.js",
+            "modules": {
+                "Roles": 1
+            },
+            "classes": {},
+            "fors": {},
+            "namespaces": {}
+        },
+        "roles/roles_common_async.js": {
+            "name": "roles/roles_common_async.js",
+            "modules": {},
+            "classes": {
+                "Roles": 1
+            },
+            "fors": {},
+            "namespaces": {}
+        }
+    },
+    "modules": {
+        "UIHelpers": {
+            "name": "UIHelpers",
+            "submodules": {},
+            "elements": {},
+            "classes": {
+                "UIHelpers": 1
+            },
+            "fors": {
+                "UIHelpers": 1
+            },
+            "namespaces": {},
+            "tag": "module",
+            "file": "roles/client/uiHelpers.js",
+            "line": 3,
+            "description": "Convenience functions for use on client.\n\nNOTE: You must restrict user actions on the server-side; any\nclient-side checks are strictly for convenience and must not be\ntrusted."
+        },
+        "Roles": {
+            "name": "Roles",
+            "submodules": {},
+            "elements": {},
+            "classes": {
+                "Roles": 1
+            },
+            "fors": {},
+            "namespaces": {},
+            "tag": "module",
+            "file": "roles/roles_common_async.js",
+            "line": 41,
+            "description": "Provides functions related to user authorization. Compatible with built-in Meteor accounts packages.\n\nRoles are accessible through `Meteor.roles` collection and documents consist of:\n - `_id`: role name\n - `children`: list of subdocuments:\n   - `_id`\n\nChildren list elements are subdocuments so that they can be easier extended in the future or by plugins.\n\nRoles can have multiple parents and can be children (subroles) of multiple roles.\n\nExample: `{_id: 'admin', children: [{_id: 'editor'}]}`\n\nThe assignment of a role to a user is stored in a collection, accessible through `RoleAssignmentCollection`.\nIt's documents consist of\n - `_id`: Internal MongoDB id\n - `role`: A role object which got assigned. Usually only contains the `_id` property\n - `user`: A user object, usually only contains the `_id` property\n - `scope`: scope name\n - `inheritedRoles`: A list of all the roles objects inherited by the assigned role."
+        }
+    },
+    "classes": {
+        "UIHelpers": {
+            "name": "UIHelpers",
+            "shortname": "UIHelpers",
+            "classitems": [],
+            "plugins": [],
+            "extensions": [],
+            "plugin_for": [],
+            "extension_for": [],
+            "module": "UIHelpers",
+            "namespace": ""
+        },
+        "Roles": {
+            "name": "Roles",
+            "shortname": "Roles",
+            "classitems": [],
+            "plugins": [],
+            "extensions": [],
+            "plugin_for": [],
+            "extension_for": [],
+            "module": "Roles",
+            "namespace": "",
+            "file": "roles/roles_common_async.js",
+            "line": 41
+        }
+    },
+    "elements": {},
+    "classitems": [
+        {
+            "file": "roles/client/uiHelpers.js",
+            "line": 23,
+            "description": "UI helper to check if current user is in at least one\nof the target roles.  For use in client-side templates.",
+            "example": [
+                "\n    {{#if isInRole 'admin'}}\n    {{/if}}\n\n    {{#if isInRole 'editor,user'}}\n    {{/if}}\n\n    {{#if isInRole 'editor,user' 'scope1'}}\n    {{/if}}"
+            ],
+            "itemtype": "method",
+            "name": "isInRole",
+            "params": [
+                {
+                    "name": "role",
+                    "description": "Name of role or comma-seperated list of roles.",
+                    "type": "String"
+                },
+                {
+                    "name": "scope",
+                    "description": "Optional, name of scope to check.",
+                    "type": "String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "`true` if current user is in at least one of the target roles.",
+                "type": "Boolean"
+            },
+            "static": 1,
+            "class": "UIHelpers",
+            "module": "UIHelpers"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 40,
+            "description": "Used as a global group (now scope) name. Not used anymore.",
+            "itemtype": "property",
+            "name": "GLOBAL_GROUP",
+            "static": 1,
+            "deprecated": true,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 49,
+            "description": "Create a new role.",
+            "itemtype": "method",
+            "name": "createRole",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `unlessExists`: if `true`, exception will not be thrown in the role already exists",
+                    "type": "Object",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "ID of the new role or null.",
+                "type": "String"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 76,
+            "description": "Delete an existing role.\n\nIf the role is set for any user, it is automatically unset.",
+            "itemtype": "method",
+            "name": "deleteRole",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 126,
+            "description": "Rename an existing role.",
+            "itemtype": "method",
+            "name": "renameRole",
+            "params": [
+                {
+                    "name": "oldName",
+                    "description": "Old name of a role.",
+                    "type": "String"
+                },
+                {
+                    "name": "newName",
+                    "description": "New name of a role.",
+                    "type": "String"
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 185,
+            "description": "Add role parent to roles.\n\nPrevious parents are kept (role can have multiple parents). For users which have the\nparent role set, new subroles are added automatically.",
+            "itemtype": "method",
+            "name": "addRolesToParent",
+            "params": [
+                {
+                    "name": "rolesNames",
+                    "description": "Name(s) of role(s).",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 205,
+            "itemtype": "method",
+            "name": "_addRoleToParent",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 254,
+            "description": "Remove role parent from roles.\n\nOther parents are kept (role can have multiple parents). For users which have the\nparent role set, removed subrole is removed automatically.",
+            "itemtype": "method",
+            "name": "removeRolesFromParent",
+            "params": [
+                {
+                    "name": "rolesNames",
+                    "description": "Name(s) of role(s).",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 274,
+            "itemtype": "method",
+            "name": "_removeRoleFromParent",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 323,
+            "description": "Add users to roles.\n\nAdds roles to existing roles for each user.",
+            "example": [
+                "\n    Roles.addUsersToRoles(userId, 'admin')\n    Roles.addUsersToRoles(userId, ['view-secrets'], 'example.com')\n    Roles.addUsersToRoles([user1, user2], ['user','editor'])\n    Roles.addUsersToRoles([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')"
+            ],
+            "itemtype": "method",
+            "name": "addUsersToRoles",
+            "params": [
+                {
+                    "name": "users",
+                    "description": "User ID(s) or object(s) with an `_id` field.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name(s) of roles to add users to. Roles have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `ifExists`: if `true`, do not throw an exception if the role does not exist\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 375,
+            "description": "Set users' roles.\n\nReplaces all existing roles with a new set of roles.",
+            "example": [
+                "\n    Roles.setUserRoles(userId, 'admin')\n    Roles.setUserRoles(userId, ['view-secrets'], 'example.com')\n    Roles.setUserRoles([user1, user2], ['user','editor'])\n    Roles.setUserRoles([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')"
+            ],
+            "itemtype": "method",
+            "name": "setUserRoles",
+            "params": [
+                {
+                    "name": "users",
+                    "description": "User ID(s) or object(s) with an `_id` field.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name(s) of roles to add users to. Roles have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `anyScope`: if `true`, remove all roles the user has, of any scope, if `false`, only the one in the same scope\n  - `ifExists`: if `true`, do not throw an exception if the role does not exist\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 437,
+            "description": "Add one user to one role.",
+            "itemtype": "method",
+            "name": "_addUserToRole",
+            "params": [
+                {
+                    "name": "userId",
+                    "description": "The user ID.",
+                    "type": "String"
+                },
+                {
+                    "name": "roleName",
+                    "description": "Name of the role to add the user to. The role have to exist.",
+                    "type": "String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `ifExists`: if `true`, do not throw an exception if the role does not exist",
+                    "type": "Object"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 491,
+            "description": "Returns an array of role names the given role name is a child of.",
+            "example": [
+                "\n    Roles._getParentRoleNames({ _id: 'admin', children; [] })"
+            ],
+            "itemtype": "method",
+            "name": "_getParentRoleNames",
+            "params": [
+                {
+                    "name": "role",
+                    "description": "The role object",
+                    "type": "Object"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 520,
+            "description": "Returns an array of role names the given role name is a parent of.",
+            "example": [
+                "\n    Roles._getInheritedRoleNames({ _id: 'admin', children; [] })"
+            ],
+            "itemtype": "method",
+            "name": "_getInheritedRoleNames",
+            "params": [
+                {
+                    "name": "role",
+                    "description": "The role object",
+                    "type": "Object"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 547,
+            "description": "Remove users from assigned roles.",
+            "example": [
+                "\n    Roles.removeUsersFromRoles(userId, 'admin')\n    Roles.removeUsersFromRoles([userId, user2], ['editor'])\n    Roles.removeUsersFromRoles(userId, ['user'], 'group1')"
+            ],
+            "itemtype": "method",
+            "name": "removeUsersFromRoles",
+            "params": [
+                {
+                    "name": "users",
+                    "description": "User ID(s) or object(s) with an `_id` field.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name(s) of roles to remove users from. Roles have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 593,
+            "description": "Remove one user from one role.",
+            "itemtype": "method",
+            "name": "_removeUserFromRole",
+            "params": [
+                {
+                    "name": "userId",
+                    "description": "The user ID.",
+                    "type": "String"
+                },
+                {
+                    "name": "roleName",
+                    "description": "Name of the role to add the user to. The role have to exist.",
+                    "type": "String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)",
+                    "type": "Object"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 623,
+            "description": "Check if user has specified roles.",
+            "example": [
+                "\n    // global roles\n    Roles.userIsInRole(user, 'admin')\n    Roles.userIsInRole(user, ['admin','editor'])\n    Roles.userIsInRole(userId, 'admin')\n    Roles.userIsInRole(userId, ['admin','editor'])\n\n    // scope roles (global roles are still checked)\n    Roles.userIsInRole(user, 'admin', 'group1')\n    Roles.userIsInRole(userId, ['admin','editor'], 'group1')\n    Roles.userIsInRole(userId, ['admin','editor'], {scope: 'group1'})"
+            ],
+            "itemtype": "method",
+            "name": "userIsInRole",
+            "params": [
+                {
+                    "name": "user",
+                    "description": "User ID or an actual user object.",
+                    "type": "String|Object"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles to check against. If array,\n                            will return `true` if user is in _any_ role.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope; if supplied, limits check to just that scope\n    the user's global roles will always be checked whether scope is specified or not\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "`true` if user is in _any_ of the target roles",
+                "type": "Boolean"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 691,
+            "description": "Retrieve user's roles.",
+            "itemtype": "method",
+            "name": "getRolesForUser",
+            "params": [
+                {
+                    "name": "user",
+                    "description": "User ID or an actual user object.",
+                    "type": "String|Object"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of scope to provide roles for; if not specified, global roles are returned\n  - `anyScope`: if set, role can be in any scope (`scope` and `onlyAssigned` options are ignored)\n  - `onlyScoped`: if set, only roles in the specified scope are returned\n  - `onlyAssigned`: return only assigned roles and not automatically inferred (like subroles)\n  - `fullObjects`: return full roles objects (`true`) or just names (`false`) (`onlyAssigned` option is ignored) (default `false`)\n    If you have a use-case for this option, please file a feature-request. You shouldn't need to use it as it's\n    result strongly dependent on the internal data structure of this plugin.\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Array of user's roles, unsorted.",
+                "type": "Array"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 767,
+            "description": "Retrieve cursor of all existing roles.",
+            "itemtype": "method",
+            "name": "getAllRoles",
+            "params": [
+                {
+                    "name": "queryOptions",
+                    "description": "Options which are passed directly\n                               through to `RolesCollection.find(query, options)`.",
+                    "type": "Object"
+                }
+            ],
+            "return": {
+                "description": "Cursor of existing roles.",
+                "type": "Cursor"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 782,
+            "description": "Retrieve all users who are in target role.\n\nOptions:",
+            "itemtype": "method",
+            "name": "getUsersInRole",
+            "params": [
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles. If array, users\n                            returned will have at least one of the roles\n                            specified but need not have _all_ roles.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope to restrict roles to; user's global\n    roles will also be checked\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n  - `onlyScoped`: if set, only roles in the specified scope are returned\n  - `queryOptions`: options which are passed directly\n    through to `Meteor.users.find(query, options)`\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                },
+                {
+                    "name": "queryOptions",
+                    "description": "Options which are passed directly\n                               through to `Meteor.users.find(query, options)`",
+                    "type": "Object",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Cursor of users in roles.",
+                "type": "Cursor"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 812,
+            "description": "Retrieve all assignments of a user which are for the target role.\n\nOptions:",
+            "itemtype": "method",
+            "name": "getUserAssignmentsForRole",
+            "params": [
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles. If array, users\n                            returned will have at least one of the roles\n                            specified but need not have _all_ roles.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope to restrict roles to; user's global\n    roles will also be checked\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n  - `queryOptions`: options which are passed directly\n    through to `RoleAssignmentCollection.find(query, options)`\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Cursor of user assignments for roles.",
+                "type": "Cursor"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 844,
+            "itemtype": "method",
+            "name": "_getUsersInRoleCursor",
+            "params": [
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles. If array, ids of users are\n                            returned which have at least one of the roles\n                            assigned but need not have _all_ roles.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope to restrict roles to; user's global\n    roles will also be checked\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                },
+                {
+                    "name": "filter",
+                    "description": "Options which are passed directly\n                               through to `RoleAssignmentCollection.find(query, options)`",
+                    "type": "Object",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Cursor to the assignment documents",
+                "type": "Object"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 892,
+            "description": "Deprecated. Use `getScopesForUser` instead.",
+            "itemtype": "method",
+            "name": "getGroupsForUser",
+            "static": 1,
+            "deprecated": true,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 908,
+            "description": "Retrieve users scopes, if any.",
+            "itemtype": "method",
+            "name": "getScopesForUser",
+            "params": [
+                {
+                    "name": "user",
+                    "description": "User ID or an actual user object.",
+                    "type": "String|Object"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name of roles to restrict scopes to.",
+                    "type": "Array|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Array of user's scopes, unsorted.",
+                "type": "Array"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 945,
+            "description": "Rename a scope.\n\nRoles assigned with a given scope are changed to be under the new scope.",
+            "itemtype": "method",
+            "name": "renameScope",
+            "params": [
+                {
+                    "name": "oldName",
+                    "description": "Old name of a scope.",
+                    "type": "String"
+                },
+                {
+                    "name": "newName",
+                    "description": "New name of a scope.",
+                    "type": "String"
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 974,
+            "description": "Remove a scope.\n\nRoles assigned with a given scope are removed.",
+            "itemtype": "method",
+            "name": "removeScope",
+            "params": [
+                {
+                    "name": "name",
+                    "description": "The name of a scope.",
+                    "type": "String"
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 989,
+            "description": "Throw an exception if `roleName` is an invalid role name.",
+            "itemtype": "method",
+            "name": "_checkRoleName",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "A role name to match against.",
+                    "type": "String"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 1003,
+            "description": "Find out if a role is an ancestor of another role.\n\nWARNING: If you check this on the client, please make sure all roles are published.",
+            "itemtype": "method",
+            "name": "isParentOf",
+            "params": [
+                {
+                    "name": "parentRoleName",
+                    "description": "The role you want to research.",
+                    "type": "String"
+                },
+                {
+                    "name": "childRoleName",
+                    "description": "The role you expect to be among the children of parentRoleName.",
+                    "type": "String"
+                }
+            ],
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 1044,
+            "description": "Normalize options.",
+            "itemtype": "method",
+            "name": "_normalizeOptions",
+            "params": [
+                {
+                    "name": "options",
+                    "description": "Options to normalize.",
+                    "type": "Object"
+                }
+            ],
+            "return": {
+                "description": "Normalized options.",
+                "type": "Object"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 1065,
+            "description": "Normalize scope name.",
+            "itemtype": "method",
+            "name": "_normalizeScopeName",
+            "params": [
+                {
+                    "name": "scopeName",
+                    "description": "A scope name to normalize.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "Normalized scope name.",
+                "type": "String"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_client.js",
+            "line": 1083,
+            "description": "Throw an exception if `scopeName` is an invalid scope name.",
+            "itemtype": "method",
+            "name": "_checkRoleName",
+            "params": [
+                {
+                    "name": "scopeName",
+                    "description": "A scope name to match against.",
+                    "type": "String"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 50,
+            "description": "Helper, resolves async some",
+            "params": [
+                {
+                    "name": "arr",
+                    "description": "",
+                    "type": "*"
+                },
+                {
+                    "name": "predicate",
+                    "description": "",
+                    "type": "*"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise<Boolean>"
+            },
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 64,
+            "description": "Used as a global group (now scope) name. Not used anymore.",
+            "itemtype": "property",
+            "name": "GLOBAL_GROUP",
+            "static": 1,
+            "deprecated": true,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 73,
+            "description": "Create a new role.",
+            "itemtype": "method",
+            "name": "createRoleAsync",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `unlessExists`: if `true`, exception will not be thrown in the role already exists",
+                    "type": "Object",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "ID of the new role or null.",
+                "type": "Promise<String>"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 118,
+            "description": "Delete an existing role.\n\nIf the role is set for any user, it is automatically unset.",
+            "itemtype": "method",
+            "name": "deleteRoleAsync",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 184,
+            "description": "Rename an existing role.",
+            "itemtype": "method",
+            "name": "renameRoleAsync",
+            "params": [
+                {
+                    "name": "oldName",
+                    "description": "Old name of a role.",
+                    "type": "String"
+                },
+                {
+                    "name": "newName",
+                    "description": "New name of a role.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 256,
+            "description": "Add role parent to roles.\n\nPrevious parents are kept (role can have multiple parents). For users which have the\nparent role set, new subroles are added automatically.",
+            "itemtype": "method",
+            "name": "addRolesToParentAsync",
+            "params": [
+                {
+                    "name": "rolesNames",
+                    "description": "Name(s) of role(s).",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 277,
+            "itemtype": "method",
+            "name": "_addRoleToParentAsync",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 341,
+            "description": "Remove role parent from roles.\n\nOther parents are kept (role can have multiple parents). For users which have the\nparent role set, removed subrole is removed automatically.",
+            "itemtype": "method",
+            "name": "removeRolesFromParentAsync",
+            "params": [
+                {
+                    "name": "rolesNames",
+                    "description": "Name(s) of role(s).",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 362,
+            "itemtype": "method",
+            "name": "_removeRoleFromParentAsync",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "Name of role.",
+                    "type": "String"
+                },
+                {
+                    "name": "parentName",
+                    "description": "Name of parent role.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 433,
+            "description": "Add users to roles.\n\nAdds roles to existing roles for each user.",
+            "example": [
+                "\n    Roles.addUsersToRolesAsync(userId, 'admin')\n    Roles.addUsersToRolesAsync(userId, ['view-secrets'], 'example.com')\n    Roles.addUsersToRolesAsync([user1, user2], ['user','editor'])\n    Roles.addUsersToRolesAsync([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')"
+            ],
+            "itemtype": "method",
+            "name": "addUsersToRolesAsync",
+            "params": [
+                {
+                    "name": "users",
+                    "description": "User ID(s) or object(s) with an `_id` field.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name(s) of roles to add users to. Roles have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `ifExists`: if `true`, do not throw an exception if the role does not exist",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Alternatively, it can be a scope name string.",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 489,
+            "description": "Set users' roles.\n\nReplaces all existing roles with a new set of roles.",
+            "example": [
+                "\n    await Roles.setUserRolesAsync(userId, 'admin')\n    await Roles.setUserRolesAsync(userId, ['view-secrets'], 'example.com')\n    await Roles.setUserRolesAsync([user1, user2], ['user','editor'])\n    await Roles.setUserRolesAsync([user1, user2], ['glorious-admin', 'perform-action'], 'example.org')"
+            ],
+            "itemtype": "method",
+            "name": "setUserRolesAsync",
+            "params": [
+                {
+                    "name": "users",
+                    "description": "User ID(s) or object(s) with an `_id` field.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name(s) of roles to add users to. Roles have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `anyScope`: if `true`, remove all roles the user has, of any scope, if `false`, only the one in the same scope\n  - `ifExists`: if `true`, do not throw an exception if the role does not exist",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Alternatively, it can be a scope name string.",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 555,
+            "description": "Add one user to one role.",
+            "itemtype": "method",
+            "name": "_addUserToRoleAsync",
+            "params": [
+                {
+                    "name": "userId",
+                    "description": "The user ID.",
+                    "type": "String"
+                },
+                {
+                    "name": "roleName",
+                    "description": "Name of the role to add the user to. The role have to exist.",
+                    "type": "String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `ifExists`: if `true`, do not throw an exception if the role does not exist",
+                    "type": "Object"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 651,
+            "description": "Returns an array of role names the given role name is a child of.",
+            "example": [
+                "\n    Roles._getParentRoleNamesAsync({ _id: 'admin', children; [] })"
+            ],
+            "itemtype": "method",
+            "name": "_getParentRoleNamesAsync",
+            "params": [
+                {
+                    "name": "role",
+                    "description": "The role object",
+                    "type": "Object"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 683,
+            "description": "Returns an array of role names the given role name is a parent of.",
+            "example": [
+                "\n    Roles._getInheritedRoleNames({ _id: 'admin', children; [] })"
+            ],
+            "itemtype": "method",
+            "name": "_getInheritedRoleNames",
+            "params": [
+                {
+                    "name": "role",
+                    "description": "The role object",
+                    "type": "Object"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 716,
+            "description": "Remove users from assigned roles.",
+            "example": [
+                "\n    await Roles.removeUsersFromRolesAsync(userId, 'admin')\n    await Roles.removeUsersFromRolesAsync([userId, user2], ['editor'])\n    await Roles.removeUsersFromRolesAsync(userId, ['user'], 'group1')"
+            ],
+            "itemtype": "method",
+            "name": "removeUsersFromRolesAsync",
+            "params": [
+                {
+                    "name": "users",
+                    "description": "User ID(s) or object(s) with an `_id` field.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name(s) of roles to remove users from. Roles have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Alternatively, it can be a scope name string.",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 763,
+            "description": "Remove one user from one role.",
+            "itemtype": "method",
+            "name": "_removeUserFromRoleAsync",
+            "params": [
+                {
+                    "name": "userId",
+                    "description": "The user ID.",
+                    "type": "String"
+                },
+                {
+                    "name": "roleName",
+                    "description": "Name of the role to add the user to. The role have to exist.",
+                    "type": "String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope, or `null` for the global role\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)",
+                    "type": "Object"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 794,
+            "description": "Check if user has specified roles.",
+            "example": [
+                "\n    // global roles\n    await Roles.userIsInRoleAsync(user, 'admin')\n    await Roles.userIsInRoleAsync(user, ['admin','editor'])\n    await Roles.userIsInRoleAsync(userId, 'admin')\n    await Roles.userIsInRoleAsync(userId, ['admin','editor'])\n\n    // scope roles (global roles are still checked)\n    await Roles.userIsInRoleAsync(user, 'admin', 'group1')\n    await Roles.userIsInRoleAsync(userId, ['admin','editor'], 'group1')\n    await Roles.userIsInRoleAsync(userId, ['admin','editor'], {scope: 'group1'})"
+            ],
+            "itemtype": "method",
+            "name": "userIsInRoleAsync",
+            "params": [
+                {
+                    "name": "user",
+                    "description": "User ID or an actual user object.",
+                    "type": "String|Object"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles to check against. If array,\n                            will return `true` if user is in _any_ role.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope; if supplied, limits check to just that scope\n    the user's global roles will always be checked whether scope is specified or not\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "`true` if user is in _any_ of the target roles",
+                "type": "Promise<Boolean>"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 871,
+            "description": "Retrieve user's roles.",
+            "itemtype": "method",
+            "name": "getRolesForUserAsync",
+            "params": [
+                {
+                    "name": "user",
+                    "description": "User ID or an actual user object.",
+                    "type": "String|Object"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of scope to provide roles for; if not specified, global roles are returned\n  - `anyScope`: if set, role can be in any scope (`scope` and `onlyAssigned` options are ignored)\n  - `onlyScoped`: if set, only roles in the specified scope are returned\n  - `onlyAssigned`: return only assigned roles and not automatically inferred (like subroles)\n  - `fullObjects`: return full roles objects (`true`) or just names (`false`) (`onlyAssigned` option is ignored) (default `false`)\n    If you have a use-case for this option, please file a feature-request. You shouldn't need to use it as it's\n    result strongly dependent on the internal data structure of this plugin.\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Array of user's roles, unsorted.",
+                "type": "Promise<Array>"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 956,
+            "description": "Retrieve cursor of all existing roles.",
+            "itemtype": "method",
+            "name": "getAllRoles",
+            "params": [
+                {
+                    "name": "queryOptions",
+                    "description": "Options which are passed directly\n                               through to `RolesCollection.find(query, options)`.",
+                    "type": "Object",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Cursor of existing roles.",
+                "type": "Cursor"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 971,
+            "description": "Retrieve all users who are in target role.\n\nOptions:",
+            "itemtype": "method",
+            "name": "getUsersInRoleAsync",
+            "params": [
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles. If array, users\n                            returned will have at least one of the roles\n                            specified but need not have _all_ roles.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope to restrict roles to; user's global\n    roles will also be checked\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n  - `onlyScoped`: if set, only roles in the specified scope are returned\n  - `queryOptions`: options which are passed directly\n    through to `Meteor.users.find(query, options)`\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                },
+                {
+                    "name": "queryOptions",
+                    "description": "Options which are passed directly\n                               through to `Meteor.users.find(query, options)`",
+                    "type": "Object",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Cursor of users in roles.",
+                "type": "Promise<Cursor>"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1006,
+            "description": "Retrieve all assignments of a user which are for the target role.\n\nOptions:",
+            "itemtype": "method",
+            "name": "getUserAssignmentsForRole",
+            "params": [
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles. If array, users\n                            returned will have at least one of the roles\n                            specified but need not have _all_ roles.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope to restrict roles to; user's global\n    roles will also be checked\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n  - `queryOptions`: options which are passed directly\n    through to `RoleAssignmentCollection.find(query, options)`\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Cursor of user assignments for roles.",
+                "type": "Cursor"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1041,
+            "itemtype": "method",
+            "name": "_getUsersInRoleCursor",
+            "params": [
+                {
+                    "name": "roles",
+                    "description": "Name of role or an array of roles. If array, ids of users are\n                            returned which have at least one of the roles\n                            assigned but need not have _all_ roles.\n                            Roles do not have to exist.",
+                    "type": "Array|String"
+                },
+                {
+                    "name": "options",
+                    "description": "Options:\n  - `scope`: name of the scope to restrict roles to; user's global\n    roles will also be checked\n  - `anyScope`: if set, role can be in any scope (`scope` option is ignored)\n\nAlternatively, it can be a scope name string.",
+                    "type": "Object|String",
+                    "optional": true
+                },
+                {
+                    "name": "filter",
+                    "description": "Options which are passed directly\n                               through to `RoleAssignmentCollection.find(query, options)`",
+                    "type": "Object",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Cursor to the assignment documents",
+                "type": "Object"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1097,
+            "description": "Deprecated. Use `getScopesForUser` instead.",
+            "itemtype": "method",
+            "name": "getGroupsForUserAsync",
+            "return": {
+                "description": "",
+                "type": "Promise<Array>"
+            },
+            "static": 1,
+            "deprecated": true,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1117,
+            "description": "Retrieve users scopes, if any.",
+            "itemtype": "method",
+            "name": "getScopesForUserAsync",
+            "params": [
+                {
+                    "name": "user",
+                    "description": "User ID or an actual user object.",
+                    "type": "String|Object"
+                },
+                {
+                    "name": "roles",
+                    "description": "Name of roles to restrict scopes to.",
+                    "type": "Array|String",
+                    "optional": true
+                }
+            ],
+            "return": {
+                "description": "Array of user's scopes, unsorted.",
+                "type": "Promise<Array>"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1158,
+            "description": "Rename a scope.\n\nRoles assigned with a given scope are changed to be under the new scope.",
+            "itemtype": "method",
+            "name": "renameScopeAsync",
+            "params": [
+                {
+                    "name": "oldName",
+                    "description": "Old name of a scope.",
+                    "type": "String"
+                },
+                {
+                    "name": "newName",
+                    "description": "New name of a scope.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1192,
+            "description": "Remove a scope.\n\nRoles assigned with a given scope are removed.",
+            "itemtype": "method",
+            "name": "removeScopeAsync",
+            "params": [
+                {
+                    "name": "name",
+                    "description": "The name of a scope.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1208,
+            "description": "Throw an exception if `roleName` is an invalid role name.",
+            "itemtype": "method",
+            "name": "_checkRoleName",
+            "params": [
+                {
+                    "name": "roleName",
+                    "description": "A role name to match against.",
+                    "type": "String"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1226,
+            "description": "Find out if a role is an ancestor of another role.\n\nWARNING: If you check this on the client, please make sure all roles are published.",
+            "itemtype": "method",
+            "name": "isParentOfAsync",
+            "params": [
+                {
+                    "name": "parentRoleName",
+                    "description": "The role you want to research.",
+                    "type": "String"
+                },
+                {
+                    "name": "childRoleName",
+                    "description": "The role you expect to be among the children of parentRoleName.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "",
+                "type": "Promise"
+            },
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1268,
+            "description": "Normalize options.",
+            "itemtype": "method",
+            "name": "_normalizeOptions",
+            "params": [
+                {
+                    "name": "options",
+                    "description": "Options to normalize.",
+                    "type": "Object"
+                }
+            ],
+            "return": {
+                "description": "Normalized options.",
+                "type": "Object"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1291,
+            "description": "Normalize scope name.",
+            "itemtype": "method",
+            "name": "_normalizeScopeName",
+            "params": [
+                {
+                    "name": "scopeName",
+                    "description": "A scope name to normalize.",
+                    "type": "String"
+                }
+            ],
+            "return": {
+                "description": "Normalized scope name.",
+                "type": "String"
+            },
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        },
+        {
+            "file": "roles/roles_common_async.js",
+            "line": 1309,
+            "description": "Throw an exception if `scopeName` is an invalid scope name.",
+            "itemtype": "method",
+            "name": "_checkScopeName",
+            "params": [
+                {
+                    "name": "scopeName",
+                    "description": "A scope name to match against.",
+                    "type": "String"
+                }
+            ],
+            "access": "private",
+            "tagname": "",
+            "static": 1,
+            "class": "Roles",
+            "module": "Roles"
+        }
+    ],
+    "warnings": [
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:50"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:118"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:184"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:256"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:277"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:341"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:362"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:433"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:489"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:555"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:651"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:683"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:716"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:763"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:1097"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:1158"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:1192"
+        },
+        {
+            "message": "replacing incorrect tag: returns with return",
+            "line": " roles/roles_common_async.js:1226"
+        },
+        {
+            "message": "Missing item type\nHelper, resolves async some",
+            "line": " roles/roles_common_async.js:50"
+        }
+    ]
+}
\ No newline at end of file
diff --git a/docs/elements/index.html b/docs/elements/index.html
new file mode 100644
index 00000000..487fe15b
--- /dev/null
+++ b/docs/elements/index.html
@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+    <head>
+        <title>Redirector</title>
+        <meta http-equiv="refresh" content="0;url=../">
+    </head>
+    <body>
+        <a href="../">Click here to redirect</a>
+    </body>
+</html>
diff --git a/docs/files/index.html b/docs/files/index.html
new file mode 100644
index 00000000..487fe15b
--- /dev/null
+++ b/docs/files/index.html
@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+    <head>
+        <title>Redirector</title>
+        <meta http-equiv="refresh" content="0;url=../">
+    </head>
+    <body>
+        <a href="../">Click here to redirect</a>
+    </body>
+</html>
diff --git a/docs/files/roles_client_uiHelpers.js.html b/docs/files/roles_client_uiHelpers.js.html
new file mode 100644
index 00000000..b1ee4b3c
--- /dev/null
+++ b/docs/files/roles_client_uiHelpers.js.html
@@ -0,0 +1,193 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>roles/client/uiHelpers.js - The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+    <link rel="icon" href="../assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="../assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="../classes/Roles.html">Roles</a></li>
+                                <li><a href="../classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="../modules/Roles.html">Roles</a></li>
+                                <li><a href="../modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+<h1 class="file-heading">File: roles/client/uiHelpers.js</h1>
+
+<div class="file">
+    <pre class="code prettyprint linenums">
+/* global Meteor, Roles, Match, Package */
+
+/**
+ * Convenience functions for use on client.
+ *
+ * NOTE: You must restrict user actions on the server-side; any
+ * client-side checks are strictly for convenience and must not be
+ * trusted.
+ *
+ * @module UIHelpers
+ */
+
+// //////////////////////////////////////////////////////////
+// UI helpers
+//
+// Use a semi-private variable rather than declaring UI
+// helpers directly so that we can unit test the helpers.
+// XXX For some reason, the UI helpers are not registered
+// before the tests run.
+//
+Roles._uiHelpers = {
+
+  /**
+   * UI helper to check if current user is in at least one
+   * of the target roles.  For use in client-side templates.
+   *
+   * @example
+   *     {{#if isInRole &#x27;admin&#x27;}}
+   *     {{/if}}
+   *
+   *     {{#if isInRole &#x27;editor,user&#x27;}}
+   *     {{/if}}
+   *
+   *     {{#if isInRole &#x27;editor,user&#x27; &#x27;scope1&#x27;}}
+   *     {{/if}}
+   *
+   * @method isInRole
+   * @param {String} role Name of role or comma-seperated list of roles.
+   * @param {String} [scope] Optional, name of scope to check.
+   * @return {Boolean} &#x60;true&#x60; if current user is in at least one of the target roles.
+   * @static
+   * @for UIHelpers
+   */
+  isInRole: function (role, scope) {
+    const user = Meteor.user()
+    const comma = (role || &#x27;&#x27;).indexOf(&#x27;,&#x27;)
+    let roles
+
+    if (!user) return false
+    if (!Match.test(role, String)) return false
+
+    if (comma !== -1) {
+      roles = role.split(&#x27;,&#x27;).reduce(function (memo, r) {
+        if (!r) {
+          return memo
+        }
+        memo.push(r)
+        return memo
+      }, [])
+    } else {
+      roles = [role]
+    }
+
+    if (Match.test(scope, String)) {
+      return Roles.userIsInRole(user, roles, scope)
+    }
+
+    return Roles.userIsInRole(user, roles)
+  }
+}
+
+// //////////////////////////////////////////////////////////
+// Register UI helpers
+//
+
+if (Roles.debug &amp;&amp; console.debug) {
+  console.debug(&#x27;[roles] Roles.debug =&#x27;, Roles.debug)
+}
+
+if (typeof Package.blaze !== &#x27;undefined&#x27; &amp;&amp;
+    typeof Package.blaze.Blaze !== &#x27;undefined&#x27; &amp;&amp;
+    typeof Package.blaze.Blaze.registerHelper === &#x27;function&#x27;) {
+  Object.entries(Roles._uiHelpers).forEach(([name, func]) =&gt; {
+    if (Roles.debug &amp;&amp; console.debug) {
+      console.debug(&#x27;[roles] registering Blaze helper \&#x27;&#x27; + name + &#x27;\&#x27;&#x27;)
+    }
+    Package.blaze.Blaze.registerHelper(name, func)
+  })
+}
+
+    </pre>
+</div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/files/roles_roles_client.js.html b/docs/files/roles_roles_client.js.html
new file mode 100644
index 00000000..565e49d2
--- /dev/null
+++ b/docs/files/roles_roles_client.js.html
@@ -0,0 +1,1206 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>roles/roles_client.js - The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+    <link rel="icon" href="../assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="../assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="../classes/Roles.html">Roles</a></li>
+                                <li><a href="../classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="../modules/Roles.html">Roles</a></li>
+                                <li><a href="../modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+<h1 class="file-heading">File: roles/roles_client.js</h1>
+
+<div class="file">
+    <pre class="code prettyprint linenums">
+/* global Roles */
+import { Meteor } from &#x27;meteor/meteor&#x27;
+
+/**
+ * Provides functions related to user authorization. Compatible with built-in Meteor accounts packages.
+ *
+ * Roles are accessible through &#x60;Meteor.roles&#x60; collection and documents consist of:
+ *  - &#x60;_id&#x60;: role name
+ *  - &#x60;children&#x60;: list of subdocuments:
+ *    - &#x60;_id&#x60;
+ *
+ * Children list elements are subdocuments so that they can be easier extended in the future or by plugins.
+ *
+ * Roles can have multiple parents and can be children (subroles) of multiple roles.
+ *
+ * Example: &#x60;{_id: &#x27;admin&#x27;, children: [{_id: &#x27;editor&#x27;}]}&#x60;
+ *
+ * The assignment of a role to a user is stored in a collection, accessible through &#x60;RoleAssignmentCollection&#x60;.
+ * It&#x27;s documents consist of
+ *  - &#x60;_id&#x60;: Internal MongoDB id
+ *  - &#x60;role&#x60;: A role object which got assigned. Usually only contains the &#x60;_id&#x60; property
+ *  - &#x60;user&#x60;: A user object, usually only contains the &#x60;_id&#x60; property
+ *  - &#x60;scope&#x60;: scope name
+ *  - &#x60;inheritedRoles&#x60;: A list of all the roles objects inherited by the assigned role.
+ *
+ * @module Roles
+ */
+
+/**
+ * @class Roles
+ */
+if (typeof Roles === &#x27;undefined&#x27;) {
+  Roles = {} // eslint-disable-line no-global-assign
+}
+
+let getGroupsForUserDeprecationWarning = false
+
+Object.assign(Roles, {
+
+  /**
+   * Used as a global group (now scope) name. Not used anymore.
+   *
+   * @property GLOBAL_GROUP
+   * @static
+   * @deprecated
+   */
+  GLOBAL_GROUP: null,
+
+  /**
+   * Create a new role.
+   *
+   * @method createRole
+   * @param {String} roleName Name of role.
+   * @param {Object} [options] Options:
+   *   - &#x60;unlessExists&#x60;: if &#x60;true&#x60;, exception will not be thrown in the role already exists
+   * @return {String} ID of the new role or null.
+   * @static
+   */
+  createRole: function (roleName, options) {
+    Roles._checkRoleName(roleName)
+
+    options = Object.assign({
+      unlessExists: false
+    }, options)
+
+    const result = Meteor.roles.upsert({ _id: roleName }, { $setOnInsert: { children: [] } })
+
+    if (!result.insertedId) {
+      if (options.unlessExists) return null
+      throw new Error(&#x27;Role \&#x27;&#x27; + roleName + &#x27;\&#x27; already exists.&#x27;)
+    }
+
+    return result.insertedId
+  },
+
+  /**
+   * Delete an existing role.
+   *
+   * If the role is set for any user, it is automatically unset.
+   *
+   * @method deleteRole
+   * @param {String} roleName Name of role.
+   * @static
+   */
+  deleteRole: function (roleName) {
+    let roles
+    let inheritedRoles
+
+    Roles._checkRoleName(roleName)
+
+    // Remove all assignments
+    Meteor.roleAssignment.remove({
+      &#x27;role._id&#x27;: roleName
+    })
+
+    do {
+      // For all roles who have it as a dependency ...
+      roles = Roles._getParentRoleNames(Meteor.roles.findOne({ _id: roleName }))
+
+      for (const r of Meteor.roles.find({ _id: { $in: roles } }).fetch()) {
+        Meteor.roles.update({
+          _id: r._id
+        }, {
+          $pull: {
+            children: {
+              _id: roleName
+            }
+          }
+        })
+
+        inheritedRoles = Roles._getInheritedRoleNames(Meteor.roles.findOne({ _id: r._id }))
+        Meteor.roleAssignment.update({
+          &#x27;role._id&#x27;: r._id
+        }, {
+          $set: {
+            inheritedRoles: [r._id, ...inheritedRoles].map(r2 =&gt; ({ _id: r2 }))
+          }
+        }, { multi: true })
+      }
+    } while (roles.length &gt; 0)
+
+    // And finally remove the role itself
+    Meteor.roles.remove({ _id: roleName })
+  },
+
+  /**
+   * Rename an existing role.
+   *
+   * @method renameRole
+   * @param {String} oldName Old name of a role.
+   * @param {String} newName New name of a role.
+   * @static
+   */
+  renameRole: function (oldName, newName) {
+    let count
+
+    Roles._checkRoleName(oldName)
+    Roles._checkRoleName(newName)
+
+    if (oldName === newName) return
+
+    const role = Meteor.roles.findOne({ _id: oldName })
+
+    if (!role) {
+      throw new Error(&#x27;Role \&#x27;&#x27; + oldName + &#x27;\&#x27; does not exist.&#x27;)
+    }
+
+    role._id = newName
+
+    Meteor.roles.insert(role)
+
+    do {
+      count = Meteor.roleAssignment.update({
+        &#x27;role._id&#x27;: oldName
+      }, {
+        $set: {
+          &#x27;role._id&#x27;: newName
+        }
+      }, { multi: true })
+    } while (count &gt; 0)
+
+    do {
+      count = Meteor.roleAssignment.update({
+        &#x27;inheritedRoles._id&#x27;: oldName
+      }, {
+        $set: {
+          &#x27;inheritedRoles.$._id&#x27;: newName
+        }
+      }, { multi: true })
+    } while (count &gt; 0)
+
+    do {
+      count = Meteor.roles.update({
+        &#x27;children._id&#x27;: oldName
+      }, {
+        $set: {
+          &#x27;children.$._id&#x27;: newName
+        }
+      }, { multi: true })
+    } while (count &gt; 0)
+
+    Meteor.roles.remove({ _id: oldName })
+  },
+
+  /**
+   * Add role parent to roles.
+   *
+   * Previous parents are kept (role can have multiple parents). For users which have the
+   * parent role set, new subroles are added automatically.
+   *
+   * @method addRolesToParent
+   * @param {Array|String} rolesNames Name(s) of role(s).
+   * @param {String} parentName Name of parent role.
+   * @static
+   */
+  addRolesToParent: function (rolesNames, parentName) {
+    // ensure arrays
+    if (!Array.isArray(rolesNames)) rolesNames = [rolesNames]
+
+    for (const roleName of rolesNames) {
+      Roles._addRoleToParent(roleName, parentName)
+    }
+  },
+
+  /**
+   * @method _addRoleToParent
+   * @param {String} roleName Name of role.
+   * @param {String} parentName Name of parent role.
+   * @private
+   * @static
+   */
+  _addRoleToParent: function (roleName, parentName) {
+    Roles._checkRoleName(roleName)
+    Roles._checkRoleName(parentName)
+
+    // query to get role&#x27;s children
+    const role = Meteor.roles.findOne({ _id: roleName })
+
+    if (!role) {
+      throw new Error(&#x27;Role \&#x27;&#x27; + roleName + &#x27;\&#x27; does not exist.&#x27;)
+    }
+
+    // detect cycles
+    if (Roles._getInheritedRoleNames(role).includes(parentName)) {
+      throw new Error(&#x27;Roles \&#x27;&#x27; + roleName + &#x27;\&#x27; and \&#x27;&#x27; + parentName + &#x27;\&#x27; would form a cycle.&#x27;)
+    }
+
+    const count = Meteor.roles.update({
+      _id: parentName,
+      &#x27;children._id&#x27;: {
+        $ne: role._id
+      }
+    }, {
+      $push: {
+        children: {
+          _id: role._id
+        }
+      }
+    })
+
+    // if there was no change, parent role might not exist, or role is
+    // already a subrole; in any case we do not have anything more to do
+    if (!count) return
+
+    Meteor.roleAssignment.update({
+      &#x27;inheritedRoles._id&#x27;: parentName
+    }, {
+      $push: {
+        inheritedRoles: { $each: [role._id, ...Roles._getInheritedRoleNames(role)].map(r =&gt; ({ _id: r })) }
+      }
+    }, { multi: true })
+  },
+
+  /**
+   * Remove role parent from roles.
+   *
+   * Other parents are kept (role can have multiple parents). For users which have the
+   * parent role set, removed subrole is removed automatically.
+   *
+   * @method removeRolesFromParent
+   * @param {Array|String} rolesNames Name(s) of role(s).
+   * @param {String} parentName Name of parent role.
+   * @static
+   */
+  removeRolesFromParent: function (rolesNames, parentName) {
+    // ensure arrays
+    if (!Array.isArray(rolesNames)) rolesNames = [rolesNames]
+
+    for (const roleName of rolesNames) {
+      Roles._removeRoleFromParent(roleName, parentName)
+    }
+  },
+
+  /**
+   * @method _removeRoleFromParent
+   * @param {String} roleName Name of role.
+   * @param {String} parentName Name of parent role.
+   * @private
+   * @static
+   */
+  _removeRoleFromParent: function (roleName, parentName) {
+    Roles._checkRoleName(roleName)
+    Roles._checkRoleName(parentName)
+
+    // check for role existence
+    // this would not really be needed, but we are trying to match addRolesToParent
+    const role = Meteor.roles.findOne({ _id: roleName }, { fields: { _id: 1 } })
+
+    if (!role) {
+      throw new Error(&#x27;Role \&#x27;&#x27; + roleName + &#x27;\&#x27; does not exist.&#x27;)
+    }
+
+    const count = Meteor.roles.update({
+      _id: parentName
+    }, {
+      $pull: {
+        children: {
+          _id: role._id
+        }
+      }
+    })
+
+    // if there was no change, parent role might not exist, or role was
+    // already not a subrole; in any case we do not have anything more to do
+    if (!count) return
+
+    // For all roles who have had it as a dependency ...
+    const roles = [...Roles._getParentRoleNames(Meteor.roles.findOne({ _id: parentName })), parentName]
+
+    for (const r of Meteor.roles.find({ _id: { $in: roles } }).fetch()) {
+      const inheritedRoles = Roles._getInheritedRoleNames(Meteor.roles.findOne({ _id: r._id }))
+      Meteor.roleAssignment.update({
+        &#x27;role._id&#x27;: r._id,
+        &#x27;inheritedRoles._id&#x27;: role._id
+      }, {
+        $set: {
+          inheritedRoles: [r._id, ...inheritedRoles].map(r2 =&gt; ({ _id: r2 }))
+        }
+      }, { multi: true })
+    }
+  },
+
+  /**
+   * Add users to roles.
+   *
+   * Adds roles to existing roles for each user.
+   *
+   * @example
+   *     Roles.addUsersToRoles(userId, &#x27;admin&#x27;)
+   *     Roles.addUsersToRoles(userId, [&#x27;view-secrets&#x27;], &#x27;example.com&#x27;)
+   *     Roles.addUsersToRoles([user1, user2], [&#x27;user&#x27;,&#x27;editor&#x27;])
+   *     Roles.addUsersToRoles([user1, user2], [&#x27;glorious-admin&#x27;, &#x27;perform-action&#x27;], &#x27;example.org&#x27;)
+   *
+   * @method addUsersToRoles
+   * @param {Array|String} users User ID(s) or object(s) with an &#x60;_id&#x60; field.
+   * @param {Array|String} roles Name(s) of roles to add users to. Roles have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;ifExists&#x60;: if &#x60;true&#x60;, do not throw an exception if the role does not exist
+   *
+   * Alternatively, it can be a scope name string.
+   * @static
+   */
+  addUsersToRoles: function (users, roles, options) {
+    let id
+
+    if (!users) throw new Error(&#x27;Missing \&#x27;users\&#x27; param.&#x27;)
+    if (!roles) throw new Error(&#x27;Missing \&#x27;roles\&#x27; param.&#x27;)
+
+    options = Roles._normalizeOptions(options)
+
+    // ensure arrays
+    if (!Array.isArray(users)) users = [users]
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign({
+      ifExists: false
+    }, options)
+
+    for (const user of users) {
+      if (typeof user === &#x27;object&#x27;) {
+        id = user._id
+      } else {
+        id = user
+      }
+
+      for (const role of roles) {
+        Roles._addUserToRole(id, role, options)
+      }
+    }
+  },
+
+  /**
+   * Set users&#x27; roles.
+   *
+   * Replaces all existing roles with a new set of roles.
+   *
+   * @example
+   *     Roles.setUserRoles(userId, &#x27;admin&#x27;)
+   *     Roles.setUserRoles(userId, [&#x27;view-secrets&#x27;], &#x27;example.com&#x27;)
+   *     Roles.setUserRoles([user1, user2], [&#x27;user&#x27;,&#x27;editor&#x27;])
+   *     Roles.setUserRoles([user1, user2], [&#x27;glorious-admin&#x27;, &#x27;perform-action&#x27;], &#x27;example.org&#x27;)
+   *
+   * @method setUserRoles
+   * @param {Array|String} users User ID(s) or object(s) with an &#x60;_id&#x60; field.
+   * @param {Array|String} roles Name(s) of roles to add users to. Roles have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;anyScope&#x60;: if &#x60;true&#x60;, remove all roles the user has, of any scope, if &#x60;false&#x60;, only the one in the same scope
+   *   - &#x60;ifExists&#x60;: if &#x60;true&#x60;, do not throw an exception if the role does not exist
+   *
+   * Alternatively, it can be a scope name string.
+   * @static
+   */
+  setUserRoles: function (users, roles, options) {
+    let id
+
+    if (!users) throw new Error(&#x27;Missing \&#x27;users\&#x27; param.&#x27;)
+    if (!roles) throw new Error(&#x27;Missing \&#x27;roles\&#x27; param.&#x27;)
+
+    options = Roles._normalizeOptions(options)
+
+    // ensure arrays
+    if (!Array.isArray(users)) users = [users]
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign({
+      ifExists: false,
+      anyScope: false
+    }, options)
+
+    for (const user of users) {
+      if (typeof user === &#x27;object&#x27;) {
+        id = user._id
+      } else {
+        id = user
+      }
+      // we first clear all roles for the user
+      const selector = { &#x27;user._id&#x27;: id }
+      if (!options.anyScope) {
+        selector.scope = options.scope
+      }
+
+      Meteor.roleAssignment.remove(selector)
+
+      // and then add all
+      for (const role of roles) {
+        Roles._addUserToRole(id, role, options)
+      }
+    }
+  },
+
+  /**
+   * Add one user to one role.
+   *
+   * @method _addUserToRole
+   * @param {String} userId The user ID.
+   * @param {String} roleName Name of the role to add the user to. The role have to exist.
+   * @param {Object} options Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;ifExists&#x60;: if &#x60;true&#x60;, do not throw an exception if the role does not exist
+   * @private
+   * @static
+   */
+  _addUserToRole: function (userId, roleName, options) {
+    Roles._checkRoleName(roleName)
+    Roles._checkScopeName(options.scope)
+
+    if (!userId) {
+      return
+    }
+
+    const role = Meteor.roles.findOne({ _id: roleName }, { fields: { children: 1 } })
+
+    if (!role) {
+      if (options.ifExists) {
+        return []
+      } else {
+        throw new Error(&#x27;Role \&#x27;&#x27; + roleName + &#x27;\&#x27; does not exist.&#x27;)
+      }
+    }
+
+    // This might create duplicates, because we don&#x27;t have a unique index, but that&#x27;s all right. In case there are two, withdrawing the role will effectively kill them both.
+    const res = Meteor.roleAssignment.upsert({
+      &#x27;user._id&#x27;: userId,
+      &#x27;role._id&#x27;: roleName,
+      scope: options.scope
+    }, {
+      $setOnInsert: {
+        user: { _id: userId },
+        role: { _id: roleName },
+        scope: options.scope
+      }
+    })
+
+    if (res.insertedId) {
+      Meteor.roleAssignment.update({ _id: res.insertedId }, {
+        $set: {
+          inheritedRoles: [roleName, ...Roles._getInheritedRoleNames(role)].map(r =&gt; ({ _id: r }))
+        }
+      })
+    }
+
+    return res
+  },
+
+  /**
+   * Returns an array of role names the given role name is a child of.
+   *
+   * @example
+   *     Roles._getParentRoleNames({ _id: &#x27;admin&#x27;, children; [] })
+   *
+   * @method _getParentRoleNames
+   * @param {object} role The role object
+   * @private
+   * @static
+   */
+  _getParentRoleNames: function (role) {
+    if (!role) {
+      return []
+    }
+
+    const parentRoles = new Set([role._id])
+
+    for (const roleName of parentRoles) {
+      Meteor.roles.find({ &#x27;children._id&#x27;: roleName }).fetch().forEach(parentRole =&gt; {
+        parentRoles.add(parentRole._id)
+      })
+    }
+
+    parentRoles.delete(role._id)
+
+    return [...parentRoles]
+  },
+
+  /**
+   * Returns an array of role names the given role name is a parent of.
+   *
+   * @example
+   *     Roles._getInheritedRoleNames({ _id: &#x27;admin&#x27;, children; [] })
+   *
+   * @method _getInheritedRoleNames
+   * @param {object} role The role object
+   * @private
+   * @static
+   */
+  _getInheritedRoleNames: function (role) {
+    const inheritedRoles = new Set()
+    const nestedRoles = new Set([role])
+
+    for (const r of nestedRoles) {
+      const roles = Meteor.roles.find({ _id: { $in: r.children.map(r =&gt; r._id) } }, { fields: { children: 1 } }).fetch()
+
+      for (const r2 of roles) {
+        inheritedRoles.add(r2._id)
+        nestedRoles.add(r2)
+      }
+    }
+
+    return [...inheritedRoles]
+  },
+
+  /**
+   * Remove users from assigned roles.
+   *
+   * @example
+   *     Roles.removeUsersFromRoles(userId, &#x27;admin&#x27;)
+   *     Roles.removeUsersFromRoles([userId, user2], [&#x27;editor&#x27;])
+   *     Roles.removeUsersFromRoles(userId, [&#x27;user&#x27;], &#x27;group1&#x27;)
+   *
+   * @method removeUsersFromRoles
+   * @param {Array|String} users User ID(s) or object(s) with an &#x60;_id&#x60; field.
+   * @param {Array|String} roles Name(s) of roles to remove users from. Roles have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *
+   * Alternatively, it can be a scope name string.
+   * @static
+   */
+  removeUsersFromRoles: function (users, roles, options) {
+    if (!users) throw new Error(&#x27;Missing \&#x27;users\&#x27; param.&#x27;)
+    if (!roles) throw new Error(&#x27;Missing \&#x27;roles\&#x27; param.&#x27;)
+
+    options = Roles._normalizeOptions(options)
+
+    // ensure arrays
+    if (!Array.isArray(users)) users = [users]
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    for (const user of users) {
+      if (!user) continue
+
+      for (const role of roles) {
+        let id
+        if (typeof user === &#x27;object&#x27;) {
+          id = user._id
+        } else {
+          id = user
+        }
+
+        Roles._removeUserFromRole(id, role, options)
+      }
+    }
+  },
+
+  /**
+   * Remove one user from one role.
+   *
+   * @method _removeUserFromRole
+   * @param {String} userId The user ID.
+   * @param {String} roleName Name of the role to add the user to. The role have to exist.
+   * @param {Object} options Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   * @private
+   * @static
+   */
+  _removeUserFromRole: function (userId, roleName, options) {
+    Roles._checkRoleName(roleName)
+    Roles._checkScopeName(options.scope)
+
+    if (!userId) return
+
+    const selector = {
+      &#x27;user._id&#x27;: userId,
+      &#x27;role._id&#x27;: roleName
+    }
+
+    if (!options.anyScope) {
+      selector.scope = options.scope
+    }
+
+    Meteor.roleAssignment.remove(selector)
+  },
+
+  /**
+   * Check if user has specified roles.
+   *
+   * @example
+   *     // global roles
+   *     Roles.userIsInRole(user, &#x27;admin&#x27;)
+   *     Roles.userIsInRole(user, [&#x27;admin&#x27;,&#x27;editor&#x27;])
+   *     Roles.userIsInRole(userId, &#x27;admin&#x27;)
+   *     Roles.userIsInRole(userId, [&#x27;admin&#x27;,&#x27;editor&#x27;])
+   *
+   *     // scope roles (global roles are still checked)
+   *     Roles.userIsInRole(user, &#x27;admin&#x27;, &#x27;group1&#x27;)
+   *     Roles.userIsInRole(userId, [&#x27;admin&#x27;,&#x27;editor&#x27;], &#x27;group1&#x27;)
+   *     Roles.userIsInRole(userId, [&#x27;admin&#x27;,&#x27;editor&#x27;], {scope: &#x27;group1&#x27;})
+   *
+   * @method userIsInRole
+   * @param {String|Object} user User ID or an actual user object.
+   * @param {Array|String} roles Name of role or an array of roles to check against. If array,
+   *                             will return &#x60;true&#x60; if user is in _any_ role.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope; if supplied, limits check to just that scope
+   *     the user&#x27;s global roles will always be checked whether scope is specified or not
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *
+   * Alternatively, it can be a scope name string.
+   * @return {Boolean} &#x60;true&#x60; if user is in _any_ of the target roles
+   * @static
+   */
+  userIsInRole: function (user, roles, options) {
+    let id
+    options = Roles._normalizeOptions(options)
+
+    // ensure array to simplify code
+    if (!Array.isArray(roles)) roles = [roles]
+
+    roles = roles.filter(r =&gt; r != null)
+
+    if (!roles.length) return false
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign({
+      anyScope: false
+    }, options)
+
+    if (user &amp;&amp; typeof user === &#x27;object&#x27;) {
+      id = user._id
+    } else {
+      id = user
+    }
+
+    if (!id) return false
+    if (typeof id !== &#x27;string&#x27;) return false
+
+    const selector = { &#x27;user._id&#x27;: id }
+
+    if (!options.anyScope) {
+      selector.scope = { $in: [options.scope, null] }
+    }
+
+    return roles.some((roleName) =&gt; {
+      selector[&#x27;inheritedRoles._id&#x27;] = roleName
+
+      return Meteor.roleAssignment.find(selector, { limit: 1 }).count() &gt; 0
+    })
+  },
+
+  /**
+   * Retrieve user&#x27;s roles.
+   *
+   * @method getRolesForUser
+   * @param {String|Object} user User ID or an actual user object.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of scope to provide roles for; if not specified, global roles are returned
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; and &#x60;onlyAssigned&#x60; options are ignored)
+   *   - &#x60;onlyScoped&#x60;: if set, only roles in the specified scope are returned
+   *   - &#x60;onlyAssigned&#x60;: return only assigned roles and not automatically inferred (like subroles)
+   *   - &#x60;fullObjects&#x60;: return full roles objects (&#x60;true&#x60;) or just names (&#x60;false&#x60;) (&#x60;onlyAssigned&#x60; option is ignored) (default &#x60;false&#x60;)
+   *     If you have a use-case for this option, please file a feature-request. You shouldn&#x27;t need to use it as it&#x27;s
+   *     result strongly dependent on the internal data structure of this plugin.
+   *
+   * Alternatively, it can be a scope name string.
+   * @return {Array} Array of user&#x27;s roles, unsorted.
+   * @static
+   */
+  getRolesForUser: function (user, options) {
+    let id
+
+    options = Roles._normalizeOptions(options)
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign({
+      fullObjects: false,
+      onlyAssigned: false,
+      anyScope: false,
+      onlyScoped: false
+    }, options)
+
+    if (user &amp;&amp; typeof user === &#x27;object&#x27;) {
+      id = user._id
+    } else {
+      id = user
+    }
+
+    if (!id) return []
+
+    const selector = { &#x27;user._id&#x27;: id }
+    const filter = { fields: { &#x27;inheritedRoles._id&#x27;: 1 } }
+
+    if (!options.anyScope) {
+      selector.scope = { $in: [options.scope] }
+
+      if (!options.onlyScoped) {
+        selector.scope.$in.push(null)
+      }
+    }
+
+    if (options.onlyAssigned) {
+      delete filter.fields[&#x27;inheritedRoles._id&#x27;]
+      filter.fields[&#x27;role._id&#x27;] = 1
+    }
+
+    if (options.fullObjects) {
+      delete filter.fields
+    }
+
+    const roles = Meteor.roleAssignment.find(selector, filter).fetch()
+
+    if (options.fullObjects) {
+      return roles
+    }
+
+    return [...new Set(roles.reduce((rev, current) =&gt; {
+      if (current.inheritedRoles) {
+        return rev.concat(current.inheritedRoles.map(r =&gt; r._id))
+      } else if (current.role) {
+        rev.push(current.role._id)
+      }
+      return rev
+    }, []))]
+  },
+
+  /**
+   * Retrieve cursor of all existing roles.
+   *
+   * @method getAllRoles
+   * @param {Object} queryOptions Options which are passed directly
+   *                                through to &#x60;RolesCollection.find(query, options)&#x60;.
+   * @return {Cursor} Cursor of existing roles.
+   * @static
+   */
+  getAllRoles: function (queryOptions) {
+    queryOptions = queryOptions || { sort: { _id: 1 } }
+
+    return Meteor.roles.find({}, queryOptions)
+  },
+
+  /**
+   * Retrieve all users who are in target role.
+   *
+   * Options:
+   *
+   * @method getUsersInRole
+   * @param {Array|String} roles Name of role or an array of roles. If array, users
+   *                             returned will have at least one of the roles
+   *                             specified but need not have _all_ roles.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope to restrict roles to; user&#x27;s global
+   *     roles will also be checked
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *   - &#x60;onlyScoped&#x60;: if set, only roles in the specified scope are returned
+   *   - &#x60;queryOptions&#x60;: options which are passed directly
+   *     through to &#x60;Meteor.users.find(query, options)&#x60;
+   *
+   * Alternatively, it can be a scope name string.
+   * @param {Object} [queryOptions] Options which are passed directly
+   *                                through to &#x60;Meteor.users.find(query, options)&#x60;
+   * @return {Cursor} Cursor of users in roles.
+   * @static
+   */
+  getUsersInRole: function (roles, options, queryOptions) {
+    const ids = Roles.getUserAssignmentsForRole(roles, options).fetch().map(a =&gt; a.user._id)
+
+    return Meteor.users.find({ _id: { $in: ids } }, ((options &amp;&amp; options.queryOptions) || queryOptions) || {})
+  },
+
+  /**
+   * Retrieve all assignments of a user which are for the target role.
+   *
+   * Options:
+   *
+   * @method getUserAssignmentsForRole
+   * @param {Array|String} roles Name of role or an array of roles. If array, users
+   *                             returned will have at least one of the roles
+   *                             specified but need not have _all_ roles.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope to restrict roles to; user&#x27;s global
+   *     roles will also be checked
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *   - &#x60;queryOptions&#x60;: options which are passed directly
+   *     through to &#x60;RoleAssignmentCollection.find(query, options)&#x60;
+   *
+   * Alternatively, it can be a scope name string.
+   * @return {Cursor} Cursor of user assignments for roles.
+   * @static
+   */
+  getUserAssignmentsForRole: function (roles, options) {
+    options = Roles._normalizeOptions(options)
+
+    options = Object.assign({
+      anyScope: false,
+      queryOptions: {}
+    }, options)
+
+    return Roles._getUsersInRoleCursor(roles, options, options.queryOptions)
+  },
+
+  /**
+   * @method _getUsersInRoleCursor
+   * @param {Array|String} roles Name of role or an array of roles. If array, ids of users are
+   *                             returned which have at least one of the roles
+   *                             assigned but need not have _all_ roles.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope to restrict roles to; user&#x27;s global
+   *     roles will also be checked
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *
+   * Alternatively, it can be a scope name string.
+   * @param {Object} [filter] Options which are passed directly
+   *                                through to &#x60;RoleAssignmentCollection.find(query, options)&#x60;
+   * @return {Object} Cursor to the assignment documents
+   * @private
+   * @static
+   */
+  _getUsersInRoleCursor: function (roles, options, filter) {
+    options = Roles._normalizeOptions(options)
+
+    options = Object.assign({
+      anyScope: false,
+      onlyScoped: false
+    }, options)
+
+    // ensure array to simplify code
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    filter = Object.assign({
+      fields: { &#x27;user._id&#x27;: 1 }
+    }, filter)
+
+    const selector = { &#x27;inheritedRoles._id&#x27;: { $in: roles } }
+
+    if (!options.anyScope) {
+      selector.scope = { $in: [options.scope] }
+
+      if (!options.onlyScoped) {
+        selector.scope.$in.push(null)
+      }
+    }
+
+    return Meteor.roleAssignment.find(selector, filter)
+  },
+
+  /**
+   * Deprecated. Use &#x60;getScopesForUser&#x60; instead.
+   *
+   * @method getGroupsForUser
+   * @static
+   * @deprecated
+   */
+  getGroupsForUser: function (...args) {
+    if (!getGroupsForUserDeprecationWarning) {
+      getGroupsForUserDeprecationWarning = true
+      console &amp;&amp; console.warn(&#x27;getGroupsForUser has been deprecated. Use getScopesForUser instead.&#x27;)
+    }
+
+    return Roles.getScopesForUser(...args)
+  },
+
+  /**
+   * Retrieve users scopes, if any.
+   *
+   * @method getScopesForUser
+   * @param {String|Object} user User ID or an actual user object.
+   * @param {Array|String} [roles] Name of roles to restrict scopes to.
+   *
+   * @return {Array} Array of user&#x27;s scopes, unsorted.
+   * @static
+   */
+  getScopesForUser: function (user, roles) {
+    let id
+
+    if (roles &amp;&amp; !Array.isArray(roles)) roles = [roles]
+
+    if (user &amp;&amp; typeof user === &#x27;object&#x27;) {
+      id = user._id
+    } else {
+      id = user
+    }
+
+    if (!id) return []
+
+    const selector = {
+      &#x27;user._id&#x27;: id,
+      scope: { $ne: null }
+    }
+
+    if (roles) {
+      selector[&#x27;inheritedRoles._id&#x27;] = { $in: roles }
+    }
+
+    const scopes = Meteor.roleAssignment.find(selector, { fields: { scope: 1 } }).fetch().map(obi =&gt; obi.scope)
+
+    return [...new Set(scopes)]
+  },
+
+  /**
+   * Rename a scope.
+   *
+   * Roles assigned with a given scope are changed to be under the new scope.
+   *
+   * @method renameScope
+   * @param {String} oldName Old name of a scope.
+   * @param {String} newName New name of a scope.
+   * @static
+   */
+  renameScope: function (oldName, newName) {
+    let count
+
+    Roles._checkScopeName(oldName)
+    Roles._checkScopeName(newName)
+
+    if (oldName === newName) return
+
+    do {
+      count = Meteor.roleAssignment.update({
+        scope: oldName
+      }, {
+        $set: {
+          scope: newName
+        }
+      }, { multi: true })
+    } while (count &gt; 0)
+  },
+
+  /**
+   * Remove a scope.
+   *
+   * Roles assigned with a given scope are removed.
+   *
+   * @method removeScope
+   * @param {String} name The name of a scope.
+   * @static
+   */
+  removeScope: function (name) {
+    Roles._checkScopeName(name)
+
+    Meteor.roleAssignment.remove({ scope: name })
+  },
+
+  /**
+   * Throw an exception if &#x60;roleName&#x60; is an invalid role name.
+   *
+   * @method _checkRoleName
+   * @param {String} roleName A role name to match against.
+   * @private
+   * @static
+   */
+  _checkRoleName: function (roleName) {
+    if (!roleName || typeof roleName !== &#x27;string&#x27; || roleName.trim() !== roleName) {
+      throw new Error(&#x27;Invalid role name \&#x27;&#x27; + roleName + &#x27;\&#x27;.&#x27;)
+    }
+  },
+
+  /**
+   * Find out if a role is an ancestor of another role.
+   *
+   * WARNING: If you check this on the client, please make sure all roles are published.
+   *
+   * @method isParentOf
+   * @param {String} parentRoleName The role you want to research.
+   * @param {String} childRoleName The role you expect to be among the children of parentRoleName.
+   * @static
+   */
+  isParentOf: function (parentRoleName, childRoleName) {
+    if (parentRoleName === childRoleName) {
+      return true
+    }
+
+    if (parentRoleName == null || childRoleName == null) {
+      return false
+    }
+
+    Roles._checkRoleName(parentRoleName)
+    Roles._checkRoleName(childRoleName)
+
+    let rolesToCheck = [parentRoleName]
+    while (rolesToCheck.length !== 0) {
+      const roleName = rolesToCheck.pop()
+
+      if (roleName === childRoleName) {
+        return true
+      }
+
+      const role = Meteor.roles.findOne({ _id: roleName })
+
+      // This should not happen, but this is a problem to address at some other time.
+      if (!role) continue
+
+      rolesToCheck = rolesToCheck.concat(role.children.map(r =&gt; r._id))
+    }
+
+    return false
+  },
+
+  /**
+   * Normalize options.
+   *
+   * @method _normalizeOptions
+   * @param {Object} options Options to normalize.
+   * @return {Object} Normalized options.
+   * @private
+   * @static
+   */
+  _normalizeOptions: function (options) {
+    options = options === undefined ? {} : options
+
+    if (options === null || typeof options === &#x27;string&#x27;) {
+      options = { scope: options }
+    }
+
+    options.scope = Roles._normalizeScopeName(options.scope)
+
+    return options
+  },
+
+  /**
+   * Normalize scope name.
+   *
+   * @method _normalizeScopeName
+   * @param {String} scopeName A scope name to normalize.
+   * @return {String} Normalized scope name.
+   * @private
+   * @static
+   */
+  _normalizeScopeName: function (scopeName) {
+    // map undefined and null to null
+    if (scopeName == null) {
+      return null
+    } else {
+      return scopeName
+    }
+  },
+
+  /**
+   * Throw an exception if &#x60;scopeName&#x60; is an invalid scope name.
+   *
+   * @method _checkRoleName
+   * @param {String} scopeName A scope name to match against.
+   * @private
+   * @static
+   */
+  _checkScopeName: function (scopeName) {
+    if (scopeName === null) return
+
+    if (
+      !scopeName ||
+      typeof scopeName !== &#x27;string&#x27; ||
+      scopeName.trim() !== scopeName
+    ) {
+      throw new Error(&#x60;Invalid scope name &#x27;${scopeName}&#x27;.&#x60;)
+    }
+  }
+})
+
+    </pre>
+</div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/files/roles_roles_common_async.js.html b/docs/files/roles_roles_common_async.js.html
new file mode 100644
index 00000000..9d6b35f8
--- /dev/null
+++ b/docs/files/roles_roles_common_async.js.html
@@ -0,0 +1,1432 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>roles/roles_common_async.js - The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+    <link rel="icon" href="../assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="../assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="../classes/Roles.html">Roles</a></li>
+                                <li><a href="../classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="../modules/Roles.html">Roles</a></li>
+                                <li><a href="../modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+<h1 class="file-heading">File: roles/roles_common_async.js</h1>
+
+<div class="file">
+    <pre class="code prettyprint linenums">
+/* global Roles */
+import { Meteor } from &#x27;meteor/meteor&#x27;
+import { Mongo } from &#x27;meteor/mongo&#x27;
+
+/**
+ * Provides functions related to user authorization. Compatible with built-in Meteor accounts packages.
+ *
+ * Roles are accessible throgh &#x60;Meteor.roles&#x60; collection and documents consist of:
+ *  - &#x60;_id&#x60;: role name
+ *  - &#x60;children&#x60;: list of subdocuments:
+ *    - &#x60;_id&#x60;
+ *
+ * Children list elements are subdocuments so that they can be easier extended in the future or by plugins.
+ *
+ * Roles can have multiple parents and can be children (subroles) of multiple roles.
+ *
+ * Example: &#x60;{_id: &#x27;admin&#x27;, children: [{_id: &#x27;editor&#x27;}]}&#x60;
+ *
+ * The assignment of a role to a user is stored in a collection, accessible through &#x60;Meteor.roleAssignment&#x60;.
+ * It&#x27;s documents consist of
+ *  - &#x60;_id&#x60;: Internal MongoDB id
+ *  - &#x60;role&#x60;: A role object which got assigned. Usually only contains the &#x60;_id&#x60; property
+ *  - &#x60;user&#x60;: A user object, usually only contains the &#x60;_id&#x60; property
+ *  - &#x60;scope&#x60;: scope name
+ *  - &#x60;inheritedRoles&#x60;: A list of all the roles objects inherited by the assigned role.
+ *
+ * @module Roles
+ */
+export const RolesCollection = new Mongo.Collection(&#x27;roles&#x27;)
+
+if (!Meteor.roles) {
+  Meteor.roles = RolesCollection
+}
+
+export const RoleAssignmentCollection = new Mongo.Collection(&#x27;role-assignment&#x27;)
+
+if (!Meteor.roleAssignment) {
+  Meteor.roleAssignment = RoleAssignmentCollection
+}
+
+/**
+ * @class Roles
+ */
+if (typeof Roles === &#x27;undefined&#x27;) {
+  Roles = {} // eslint-disable-line no-global-assign
+}
+
+let getGroupsForUserDeprecationWarning = false
+
+/**
+ * Helper, resolves async some
+ * @param {*} arr
+ * @param {*} predicate
+ * @returns {Promise&lt;Boolean&gt;}
+ */
+const asyncSome = async (arr, predicate) =&gt; {
+  for (const e of arr) {
+    if (await predicate(e)) return true
+  }
+  return false
+}
+
+Object.assign(Roles, {
+  /**
+   * Used as a global group (now scope) name. Not used anymore.
+   *
+   * @property GLOBAL_GROUP
+   * @static
+   * @deprecated
+   */
+  GLOBAL_GROUP: null,
+
+  /**
+   * Create a new role.
+   *
+   * @method createRoleAsync
+   * @param {String} roleName Name of role.
+   * @param {Object} [options] Options:
+   *   - &#x60;unlessExists&#x60;: if &#x60;true&#x60;, exception will not be thrown in the role already exists
+   * @return {Promise&lt;String&gt;} ID of the new role or null.
+   * @static
+   */
+  createRoleAsync: async function (roleName, options) {
+    Roles._checkRoleName(roleName)
+
+    options = Object.assign(
+      {
+        unlessExists: false
+      },
+      options
+    )
+
+    let insertedId = null
+
+    const existingRole = await Meteor.roles.findOneAsync({ _id: roleName })
+
+    if (existingRole) {
+      await Meteor.roles.updateAsync(
+        { _id: roleName },
+        { $setOnInsert: { children: [] } }
+      )
+      return null
+    } else {
+      insertedId = await Meteor.roles.insertAsync({
+        _id: roleName,
+        children: []
+      })
+    }
+
+    if (!insertedId) {
+      if (options.unlessExists) return null
+      throw new Error(&quot;Role &#x27;&quot; + roleName + &quot;&#x27; already exists.&quot;)
+    }
+
+    return insertedId
+  },
+
+  /**
+   * Delete an existing role.
+   *
+   * If the role is set for any user, it is automatically unset.
+   *
+   * @method deleteRoleAsync
+   * @param {String} roleName Name of role.
+   * @returns {Promise}
+   * @static
+   */
+  deleteRoleAsync: async function (roleName) {
+    let roles
+    let inheritedRoles
+
+    Roles._checkRoleName(roleName)
+
+    // Remove all assignments
+    await Meteor.roleAssignment.removeAsync({
+      &#x27;role._id&#x27;: roleName
+    })
+
+    do {
+      // For all roles who have it as a dependency ...
+      roles = await Roles._getParentRoleNamesAsync(
+        await Meteor.roles.findOneAsync({ _id: roleName })
+      )
+
+      for (const r of await Meteor.roles
+        .find({ _id: { $in: roles } })
+        .fetchAsync()) {
+        await Meteor.roles.updateAsync(
+          {
+            _id: r._id
+          },
+          {
+            $pull: {
+              children: {
+                _id: roleName
+              }
+            }
+          }
+        )
+
+        inheritedRoles = await Roles._getInheritedRoleNamesAsync(
+          await Meteor.roles.findOneAsync({ _id: r._id })
+        )
+        await Meteor.roleAssignment.updateAsync(
+          {
+            &#x27;role._id&#x27;: r._id
+          },
+          {
+            $set: {
+              inheritedRoles: [r._id, ...inheritedRoles].map((r2) =&gt; ({
+                _id: r2
+              }))
+            }
+          },
+          { multi: true }
+        )
+      }
+    } while (roles.length &gt; 0)
+
+    // And finally remove the role itself
+    await Meteor.roles.removeAsync({ _id: roleName })
+  },
+
+  /**
+   * Rename an existing role.
+   *
+   * @method renameRoleAsync
+   * @param {String} oldName Old name of a role.
+   * @param {String} newName New name of a role.
+   * @returns {Promise}
+   * @static
+   */
+  renameRoleAsync: async function (oldName, newName) {
+    let count
+
+    Roles._checkRoleName(oldName)
+    Roles._checkRoleName(newName)
+
+    if (oldName === newName) return
+
+    const role = await Meteor.roles.findOneAsync({ _id: oldName })
+
+    if (!role) {
+      throw new Error(&quot;Role &#x27;&quot; + oldName + &quot;&#x27; does not exist.&quot;)
+    }
+
+    role._id = newName
+
+    await Meteor.roles.insertAsync(role)
+
+    do {
+      count = await Meteor.roleAssignment.updateAsync(
+        {
+          &#x27;role._id&#x27;: oldName
+        },
+        {
+          $set: {
+            &#x27;role._id&#x27;: newName
+          }
+        },
+        { multi: true }
+      )
+    } while (count &gt; 0)
+
+    do {
+      count = await Meteor.roleAssignment.updateAsync(
+        {
+          &#x27;inheritedRoles._id&#x27;: oldName
+        },
+        {
+          $set: {
+            &#x27;inheritedRoles.$._id&#x27;: newName
+          }
+        },
+        { multi: true }
+      )
+    } while (count &gt; 0)
+
+    do {
+      count = await Meteor.roles.updateAsync(
+        {
+          &#x27;children._id&#x27;: oldName
+        },
+        {
+          $set: {
+            &#x27;children.$._id&#x27;: newName
+          }
+        },
+        { multi: true }
+      )
+    } while (count &gt; 0)
+
+    await Meteor.roles.removeAsync({ _id: oldName })
+  },
+
+  /**
+   * Add role parent to roles.
+   *
+   * Previous parents are kept (role can have multiple parents). For users which have the
+   * parent role set, new subroles are added automatically.
+   *
+   * @method addRolesToParentAsync
+   * @param {Array|String} rolesNames Name(s) of role(s).
+   * @param {String} parentName Name of parent role.
+   * @returns {Promise}
+   * @static
+   */
+  addRolesToParentAsync: async function (rolesNames, parentName) {
+    // ensure arrays
+    if (!Array.isArray(rolesNames)) rolesNames = [rolesNames]
+
+    for (const roleName of rolesNames) {
+      await Roles._addRoleToParentAsync(roleName, parentName)
+    }
+  },
+
+  /**
+   * @method _addRoleToParentAsync
+   * @param {String} roleName Name of role.
+   * @param {String} parentName Name of parent role.
+   * @returns {Promise}
+   * @private
+   * @static
+   */
+  _addRoleToParentAsync: async function (roleName, parentName) {
+    Roles._checkRoleName(roleName)
+    Roles._checkRoleName(parentName)
+
+    // query to get role&#x27;s children
+    const role = await Meteor.roles.findOneAsync({ _id: roleName })
+
+    if (!role) {
+      throw new Error(&#x60;Role &#x27;${roleName}&#x27; does not exist.&#x60;)
+    }
+
+    // detect cycles
+    if ((await Roles._getInheritedRoleNamesAsync(role)).includes(parentName)) {
+      throw new Error(
+        &#x60;Roles &#x27;${roleName}&#x27; and &#x27;${parentName}&#x27; would form a cycle.&#x60;
+      )
+    }
+
+    const count = await Meteor.roles.updateAsync(
+      {
+        _id: parentName,
+        &#x27;children._id&#x27;: {
+          $ne: role._id
+        }
+      },
+      {
+        $push: {
+          children: {
+            _id: role._id
+          }
+        }
+      }
+    )
+
+    // if there was no change, parent role might not exist, or role is
+    // already a sub-role; in any case we do not have anything more to do
+    if (!count) return
+
+    await Meteor.roleAssignment.updateAsync(
+      {
+        &#x27;inheritedRoles._id&#x27;: parentName
+      },
+      {
+        $push: {
+          inheritedRoles: {
+            $each: [
+              role._id,
+              ...(await Roles._getInheritedRoleNamesAsync(role))
+            ].map((r) =&gt; ({ _id: r }))
+          }
+        }
+      },
+      { multi: true }
+    )
+  },
+
+  /**
+   * Remove role parent from roles.
+   *
+   * Other parents are kept (role can have multiple parents). For users which have the
+   * parent role set, removed subrole is removed automatically.
+   *
+   * @method removeRolesFromParentAsync
+   * @param {Array|String} rolesNames Name(s) of role(s).
+   * @param {String} parentName Name of parent role.
+   * @returns {Promise}
+   * @static
+   */
+  removeRolesFromParentAsync: async function (rolesNames, parentName) {
+    // ensure arrays
+    if (!Array.isArray(rolesNames)) rolesNames = [rolesNames]
+
+    for (const roleName of rolesNames) {
+      await Roles._removeRoleFromParentAsync(roleName, parentName)
+    }
+  },
+
+  /**
+   * @method _removeRoleFromParentAsync
+   * @param {String} roleName Name of role.
+   * @param {String} parentName Name of parent role.
+   * @returns {Promise}
+   * @private
+   * @static
+   */
+  _removeRoleFromParentAsync: async function (roleName, parentName) {
+    Roles._checkRoleName(roleName)
+    Roles._checkRoleName(parentName)
+
+    // check for role existence
+    // this would not really be needed, but we are trying to match addRolesToParent
+    const role = await Meteor.roles.findOneAsync(
+      { _id: roleName },
+      { fields: { _id: 1 } }
+    )
+
+    if (!role) {
+      throw new Error(&#x60;Role &#x27;${roleName}&#x27; does not exist.&#x60;)
+    }
+
+    const count = await Meteor.roles.updateAsync(
+      {
+        _id: parentName
+      },
+      {
+        $pull: {
+          children: {
+            _id: role._id
+          }
+        }
+      }
+    )
+
+    // if there was no change, parent role might not exist, or role was
+    // already not a subrole; in any case we do not have anything more to do
+    if (!count) return
+
+    // For all roles who have had it as a dependency ...
+    const roles = [
+      ...(await Roles._getParentRoleNamesAsync(
+        await Meteor.roles.findOneAsync({ _id: parentName })
+      )),
+      parentName
+    ]
+
+    for (const r of await Meteor.roles
+      .find({ _id: { $in: roles } })
+      .fetchAsync()) {
+      const inheritedRoles = await Roles._getInheritedRoleNamesAsync(
+        await Meteor.roles.findOneAsync({ _id: r._id })
+      )
+      await Meteor.roleAssignment.updateAsync(
+        {
+          &#x27;role._id&#x27;: r._id,
+          &#x27;inheritedRoles._id&#x27;: role._id
+        },
+        {
+          $set: {
+            inheritedRoles: [r._id, ...inheritedRoles].map((r2) =&gt; ({
+              _id: r2
+            }))
+          }
+        },
+        { multi: true }
+      )
+    }
+  },
+
+  /**
+   * Add users to roles.
+   *
+   * Adds roles to existing roles for each user.
+   *
+   * @example
+   *     Roles.addUsersToRolesAsync(userId, &#x27;admin&#x27;)
+   *     Roles.addUsersToRolesAsync(userId, [&#x27;view-secrets&#x27;], &#x27;example.com&#x27;)
+   *     Roles.addUsersToRolesAsync([user1, user2], [&#x27;user&#x27;,&#x27;editor&#x27;])
+   *     Roles.addUsersToRolesAsync([user1, user2], [&#x27;glorious-admin&#x27;, &#x27;perform-action&#x27;], &#x27;example.org&#x27;)
+   *
+   * @method addUsersToRolesAsync
+   * @param {Array|String} users User ID(s) or object(s) with an &#x60;_id&#x60; field.
+   * @param {Array|String} roles Name(s) of roles to add users to. Roles have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;ifExists&#x60;: if &#x60;true&#x60;, do not throw an exception if the role does not exist
+   * @returns {Promise}
+   *
+   * Alternatively, it can be a scope name string.
+   * @static
+   */
+  addUsersToRolesAsync: async function (users, roles, options) {
+    let id
+
+    if (!users) throw new Error(&quot;Missing &#x27;users&#x27; param.&quot;)
+    if (!roles) throw new Error(&quot;Missing &#x27;roles&#x27; param.&quot;)
+
+    options = Roles._normalizeOptions(options)
+
+    // ensure arrays
+    if (!Array.isArray(users)) users = [users]
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign(
+      {
+        ifExists: false
+      },
+      options
+    )
+
+    for (const user of users) {
+      if (typeof user === &#x27;object&#x27;) {
+        id = user._id
+      } else {
+        id = user
+      }
+
+      for (const role of roles) {
+        await Roles._addUserToRoleAsync(id, role, options)
+      }
+    }
+  },
+
+  /**
+   * Set users&#x27; roles.
+   *
+   * Replaces all existing roles with a new set of roles.
+   *
+   * @example
+   *     await Roles.setUserRolesAsync(userId, &#x27;admin&#x27;)
+   *     await Roles.setUserRolesAsync(userId, [&#x27;view-secrets&#x27;], &#x27;example.com&#x27;)
+   *     await Roles.setUserRolesAsync([user1, user2], [&#x27;user&#x27;,&#x27;editor&#x27;])
+   *     await Roles.setUserRolesAsync([user1, user2], [&#x27;glorious-admin&#x27;, &#x27;perform-action&#x27;], &#x27;example.org&#x27;)
+   *
+   * @method setUserRolesAsync
+   * @param {Array|String} users User ID(s) or object(s) with an &#x60;_id&#x60; field.
+   * @param {Array|String} roles Name(s) of roles to add users to. Roles have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;anyScope&#x60;: if &#x60;true&#x60;, remove all roles the user has, of any scope, if &#x60;false&#x60;, only the one in the same scope
+   *   - &#x60;ifExists&#x60;: if &#x60;true&#x60;, do not throw an exception if the role does not exist
+   * @returns {Promise}
+   *
+   * Alternatively, it can be a scope name string.
+   * @static
+   */
+  setUserRolesAsync: async function (users, roles, options) {
+    let id
+
+    if (!users) throw new Error(&quot;Missing &#x27;users&#x27; param.&quot;)
+    if (!roles) throw new Error(&quot;Missing &#x27;roles&#x27; param.&quot;)
+
+    options = Roles._normalizeOptions(options)
+
+    // ensure arrays
+    if (!Array.isArray(users)) users = [users]
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign(
+      {
+        ifExists: false,
+        anyScope: false
+      },
+      options
+    )
+
+    for (const user of users) {
+      if (typeof user === &#x27;object&#x27;) {
+        id = user._id
+      } else {
+        id = user
+      }
+      // we first clear all roles for the user
+      const selector = { &#x27;user._id&#x27;: id }
+      if (!options.anyScope) {
+        selector.scope = options.scope
+      }
+
+      await Meteor.roleAssignment.removeAsync(selector)
+
+      // and then add all
+      for (const role of roles) {
+        await Roles._addUserToRoleAsync(id, role, options)
+      }
+    }
+  },
+
+  /**
+   * Add one user to one role.
+   *
+   * @method _addUserToRoleAsync
+   * @param {String} userId The user ID.
+   * @param {String} roleName Name of the role to add the user to. The role have to exist.
+   * @param {Object} options Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;ifExists&#x60;: if &#x60;true&#x60;, do not throw an exception if the role does not exist
+   * @returns {Promise}
+   * @private
+   * @static
+   */
+  _addUserToRoleAsync: async function (userId, roleName, options) {
+    Roles._checkRoleName(roleName)
+    Roles._checkScopeName(options.scope)
+
+    if (!userId) {
+      return
+    }
+
+    const role = await Meteor.roles.findOneAsync(
+      { _id: roleName },
+      { fields: { children: 1 } }
+    )
+
+    if (!role) {
+      if (options.ifExists) {
+        return []
+      } else {
+        throw new Error(&quot;Role &#x27;&quot; + roleName + &quot;&#x27; does not exist.&quot;)
+      }
+    }
+
+    // This might create duplicates, because we don&#x27;t have a unique index, but that&#x27;s all right. In case there are two, withdrawing the role will effectively kill them both.
+    // TODO revisit this
+    /* const res = await RoleAssignmentCollection.upsertAsync(
+      {
+        &quot;user._id&quot;: userId,
+        &quot;role._id&quot;: roleName,
+        scope: options.scope,
+      },
+      {
+        $setOnInsert: {
+          user: { _id: userId },
+          role: { _id: roleName },
+          scope: options.scope,
+        },
+      }
+    ); */
+    const existingAssignment = await Meteor.roleAssignment.findOneAsync({
+      &#x27;user._id&#x27;: userId,
+      &#x27;role._id&#x27;: roleName,
+      scope: options.scope
+    })
+
+    let insertedId
+    let res
+    if (existingAssignment) {
+      await Meteor.roleAssignment.updateAsync(existingAssignment._id, {
+        $set: {
+          user: { _id: userId },
+          role: { _id: roleName },
+          scope: options.scope
+        }
+      })
+
+      res = await Meteor.roleAssignment.findOneAsync(existingAssignment._id)
+    } else {
+      insertedId = await Meteor.roleAssignment.insertAsync({
+        user: { _id: userId },
+        role: { _id: roleName },
+        scope: options.scope
+      })
+    }
+
+    if (insertedId) {
+      await Meteor.roleAssignment.updateAsync(
+        { _id: insertedId },
+        {
+          $set: {
+            inheritedRoles: [
+              roleName,
+              ...(await Roles._getInheritedRoleNamesAsync(role))
+            ].map((r) =&gt; ({ _id: r }))
+          }
+        }
+      )
+
+      res = await Meteor.roleAssignment.findOneAsync({ _id: insertedId })
+    }
+    res.insertedId = insertedId // For backward compatibility
+
+    return res
+  },
+
+  /**
+   * Returns an array of role names the given role name is a child of.
+   *
+   * @example
+   *     Roles._getParentRoleNamesAsync({ _id: &#x27;admin&#x27;, children; [] })
+   *
+   * @method _getParentRoleNamesAsync
+   * @param {object} role The role object
+   * @returns {Promise}
+   * @private
+   * @static
+   */
+  _getParentRoleNamesAsync: async function (role) {
+    if (!role) {
+      return []
+    }
+
+    const parentRoles = new Set([role._id])
+
+    for (const roleName of parentRoles) {
+      for (const parentRole of await Meteor.roles
+        .find({ &#x27;children._id&#x27;: roleName })
+        .fetchAsync()) {
+        parentRoles.add(parentRole._id)
+      }
+    }
+
+    parentRoles.delete(role._id)
+
+    return [...parentRoles]
+  },
+
+  /**
+   * Returns an array of role names the given role name is a parent of.
+   *
+   * @example
+   *     Roles._getInheritedRoleNames({ _id: &#x27;admin&#x27;, children; [] })
+   *
+   * @method _getInheritedRoleNames
+   * @param {object} role The role object
+   * @returns {Promise}
+   * @private
+   * @static
+   */
+  _getInheritedRoleNamesAsync: async function (role) {
+    const inheritedRoles = new Set()
+    const nestedRoles = new Set([role])
+
+    for (const r of nestedRoles) {
+      const roles = await Meteor.roles
+        .find(
+          { _id: { $in: r.children.map((r) =&gt; r._id) } },
+          { fields: { children: 1 } }
+        )
+        .fetchAsync()
+
+      for (const r2 of roles) {
+        inheritedRoles.add(r2._id)
+        nestedRoles.add(r2)
+      }
+    }
+
+    return [...inheritedRoles]
+  },
+
+  /**
+   * Remove users from assigned roles.
+   *
+   * @example
+   *     await Roles.removeUsersFromRolesAsync(userId, &#x27;admin&#x27;)
+   *     await Roles.removeUsersFromRolesAsync([userId, user2], [&#x27;editor&#x27;])
+   *     await Roles.removeUsersFromRolesAsync(userId, [&#x27;user&#x27;], &#x27;group1&#x27;)
+   *
+   * @method removeUsersFromRolesAsync
+   * @param {Array|String} users User ID(s) or object(s) with an &#x60;_id&#x60; field.
+   * @param {Array|String} roles Name(s) of roles to remove users from. Roles have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   * @returns {Promise}
+   *
+   * Alternatively, it can be a scope name string.
+   * @static
+   */
+  removeUsersFromRolesAsync: async function (users, roles, options) {
+    if (!users) throw new Error(&quot;Missing &#x27;users&#x27; param.&quot;)
+    if (!roles) throw new Error(&quot;Missing &#x27;roles&#x27; param.&quot;)
+
+    options = Roles._normalizeOptions(options)
+
+    // ensure arrays
+    if (!Array.isArray(users)) users = [users]
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    for (const user of users) {
+      if (!user) return
+
+      for (const role of roles) {
+        let id
+        if (typeof user === &#x27;object&#x27;) {
+          id = user._id
+        } else {
+          id = user
+        }
+
+        await Roles._removeUserFromRoleAsync(id, role, options)
+      }
+    }
+  },
+
+  /**
+   * Remove one user from one role.
+   *
+   * @method _removeUserFromRoleAsync
+   * @param {String} userId The user ID.
+   * @param {String} roleName Name of the role to add the user to. The role have to exist.
+   * @param {Object} options Options:
+   *   - &#x60;scope&#x60;: name of the scope, or &#x60;null&#x60; for the global role
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   * @returns {Promise}
+   * @private
+   * @static
+   */
+  _removeUserFromRoleAsync: async function (userId, roleName, options) {
+    Roles._checkRoleName(roleName)
+    Roles._checkScopeName(options.scope)
+
+    if (!userId) return
+
+    const selector = {
+      &#x27;user._id&#x27;: userId,
+      &#x27;role._id&#x27;: roleName
+    }
+
+    if (!options.anyScope) {
+      selector.scope = options.scope
+    }
+
+    await Meteor.roleAssignment.removeAsync(selector)
+  },
+
+  /**
+   * Check if user has specified roles.
+   *
+   * @example
+   *     // global roles
+   *     await Roles.userIsInRoleAsync(user, &#x27;admin&#x27;)
+   *     await Roles.userIsInRoleAsync(user, [&#x27;admin&#x27;,&#x27;editor&#x27;])
+   *     await Roles.userIsInRoleAsync(userId, &#x27;admin&#x27;)
+   *     await Roles.userIsInRoleAsync(userId, [&#x27;admin&#x27;,&#x27;editor&#x27;])
+   *
+   *     // scope roles (global roles are still checked)
+   *     await Roles.userIsInRoleAsync(user, &#x27;admin&#x27;, &#x27;group1&#x27;)
+   *     await Roles.userIsInRoleAsync(userId, [&#x27;admin&#x27;,&#x27;editor&#x27;], &#x27;group1&#x27;)
+   *     await Roles.userIsInRoleAsync(userId, [&#x27;admin&#x27;,&#x27;editor&#x27;], {scope: &#x27;group1&#x27;})
+   *
+   * @method userIsInRoleAsync
+   * @param {String|Object} user User ID or an actual user object.
+   * @param {Array|String} roles Name of role or an array of roles to check against. If array,
+   *                             will return &#x60;true&#x60; if user is in _any_ role.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope; if supplied, limits check to just that scope
+   *     the user&#x27;s global roles will always be checked whether scope is specified or not
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *
+   * Alternatively, it can be a scope name string.
+   * @return {Promise&lt;Boolean&gt;} &#x60;true&#x60; if user is in _any_ of the target roles
+   * @static
+   */
+  userIsInRoleAsync: async function (user, roles, options) {
+    let id
+
+    options = Roles._normalizeOptions(options)
+
+    // ensure array to simplify code
+    if (!Array.isArray(roles)) roles = [roles]
+
+    roles = roles.filter((r) =&gt; r != null)
+
+    if (!roles.length) return false
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign(
+      {
+        anyScope: false
+      },
+      options
+    )
+
+    if (user &amp;&amp; typeof user === &#x27;object&#x27;) {
+      id = user._id
+    } else {
+      id = user
+    }
+
+    if (!id) return false
+    if (typeof id !== &#x27;string&#x27;) return false
+
+    const selector = {
+      &#x27;user._id&#x27;: id
+    }
+
+    if (!options.anyScope) {
+      selector.scope = { $in: [options.scope, null] }
+    }
+
+    const res = await asyncSome(roles, async (roleName) =&gt; {
+      selector[&#x27;inheritedRoles._id&#x27;] = roleName
+      const out =
+        (await Meteor.roleAssignment.countDocuments(selector, { limit: 1 })) &gt; 0
+      return out
+    })
+
+    return res
+  },
+
+  /**
+   * Retrieve user&#x27;s roles.
+   *
+   * @method getRolesForUserAsync
+   * @param {String|Object} user User ID or an actual user object.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of scope to provide roles for; if not specified, global roles are returned
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; and &#x60;onlyAssigned&#x60; options are ignored)
+   *   - &#x60;onlyScoped&#x60;: if set, only roles in the specified scope are returned
+   *   - &#x60;onlyAssigned&#x60;: return only assigned roles and not automatically inferred (like subroles)
+   *   - &#x60;fullObjects&#x60;: return full roles objects (&#x60;true&#x60;) or just names (&#x60;false&#x60;) (&#x60;onlyAssigned&#x60; option is ignored) (default &#x60;false&#x60;)
+   *     If you have a use-case for this option, please file a feature-request. You shouldn&#x27;t need to use it as it&#x27;s
+   *     result strongly dependent on the internal data structure of this plugin.
+   *
+   * Alternatively, it can be a scope name string.
+   * @return {Promise&lt;Array&gt;} Array of user&#x27;s roles, unsorted.
+   * @static
+   */
+  getRolesForUserAsync: async function (user, options) {
+    let id
+
+    options = Roles._normalizeOptions(options)
+
+    Roles._checkScopeName(options.scope)
+
+    options = Object.assign({
+      fullObjects: false,
+      onlyAssigned: false,
+      anyScope: false,
+      onlyScoped: false
+    }, options)
+
+    if (user &amp;&amp; typeof user === &#x27;object&#x27;) {
+      id = user._id
+    } else {
+      id = user
+    }
+
+    if (!id) return []
+
+    const selector = {
+      &#x27;user._id&#x27;: id
+    }
+
+    const filter = {
+      fields: { &#x27;inheritedRoles._id&#x27;: 1 }
+    }
+
+    if (!options.anyScope) {
+      selector.scope = { $in: [options.scope] }
+
+      if (!options.onlyScoped) {
+        selector.scope.$in.push(null)
+      }
+    }
+
+    if (options.onlyAssigned) {
+      delete filter.fields[&#x27;inheritedRoles._id&#x27;]
+      filter.fields[&#x27;role._id&#x27;] = 1
+    }
+
+    if (options.fullObjects) {
+      delete filter.fields
+    }
+
+    const roles = await Meteor.roleAssignment.find(selector, filter).fetchAsync()
+
+    if (options.fullObjects) {
+      return roles
+    }
+
+    return [
+      ...new Set(
+        roles.reduce((rev, current) =&gt; {
+          if (current.inheritedRoles) {
+            return rev.concat(current.inheritedRoles.map((r) =&gt; r._id))
+          } else if (current.role) {
+            rev.push(current.role._id)
+          }
+          return rev
+        }, [])
+      )
+    ]
+  },
+
+  /**
+   * Retrieve cursor of all existing roles.
+   *
+   * @method getAllRoles
+   * @param {Object} [queryOptions] Options which are passed directly
+   *                                through to &#x60;RolesCollection.find(query, options)&#x60;.
+   * @return {Cursor} Cursor of existing roles.
+   * @static
+   */
+  getAllRoles: function (queryOptions) {
+    queryOptions = queryOptions || { sort: { _id: 1 } }
+
+    return Meteor.roles.find({}, queryOptions)
+  },
+
+  /**
+   * Retrieve all users who are in target role.
+   *
+   * Options:
+   *
+   * @method getUsersInRoleAsync
+   * @param {Array|String} roles Name of role or an array of roles. If array, users
+   *                             returned will have at least one of the roles
+   *                             specified but need not have _all_ roles.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope to restrict roles to; user&#x27;s global
+   *     roles will also be checked
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *   - &#x60;onlyScoped&#x60;: if set, only roles in the specified scope are returned
+   *   - &#x60;queryOptions&#x60;: options which are passed directly
+   *     through to &#x60;Meteor.users.find(query, options)&#x60;
+   *
+   * Alternatively, it can be a scope name string.
+   * @param {Object} [queryOptions] Options which are passed directly
+   *                                through to &#x60;Meteor.users.find(query, options)&#x60;
+   * @return {Promise&lt;Cursor&gt;} Cursor of users in roles.
+   * @static
+   */
+  getUsersInRoleAsync: async function (roles, options, queryOptions) {
+    const ids = (
+      await Roles.getUserAssignmentsForRole(roles, options).fetchAsync()
+    ).map((a) =&gt; a.user._id)
+
+    return Meteor.users.find(
+      { _id: { $in: ids } },
+      (options &amp;&amp; options.queryOptions) || queryOptions || {}
+    )
+  },
+
+  /**
+   * Retrieve all assignments of a user which are for the target role.
+   *
+   * Options:
+   *
+   * @method getUserAssignmentsForRole
+   * @param {Array|String} roles Name of role or an array of roles. If array, users
+   *                             returned will have at least one of the roles
+   *                             specified but need not have _all_ roles.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope to restrict roles to; user&#x27;s global
+   *     roles will also be checked
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *   - &#x60;queryOptions&#x60;: options which are passed directly
+   *     through to &#x60;RoleAssignmentCollection.find(query, options)&#x60;
+
+   * Alternatively, it can be a scope name string.
+   * @return {Cursor} Cursor of user assignments for roles.
+   * @static
+   */
+  getUserAssignmentsForRole: function (roles, options) {
+    options = Roles._normalizeOptions(options)
+
+    options = Object.assign(
+      {
+        anyScope: false,
+        queryOptions: {}
+      },
+      options
+    )
+
+    return Roles._getUsersInRoleCursor(roles, options, options.queryOptions)
+  },
+
+  /**
+   * @method _getUsersInRoleCursor
+   * @param {Array|String} roles Name of role or an array of roles. If array, ids of users are
+   *                             returned which have at least one of the roles
+   *                             assigned but need not have _all_ roles.
+   *                             Roles do not have to exist.
+   * @param {Object|String} [options] Options:
+   *   - &#x60;scope&#x60;: name of the scope to restrict roles to; user&#x27;s global
+   *     roles will also be checked
+   *   - &#x60;anyScope&#x60;: if set, role can be in any scope (&#x60;scope&#x60; option is ignored)
+   *
+   * Alternatively, it can be a scope name string.
+   * @param {Object} [filter] Options which are passed directly
+   *                                through to &#x60;RoleAssignmentCollection.find(query, options)&#x60;
+   * @return {Object} Cursor to the assignment documents
+   * @private
+   * @static
+   */
+  _getUsersInRoleCursor: function (roles, options, filter) {
+    options = Roles._normalizeOptions(options)
+
+    options = Object.assign(
+      {
+        anyScope: false,
+        onlyScoped: false
+      },
+      options
+    )
+
+    // ensure array to simplify code
+    if (!Array.isArray(roles)) roles = [roles]
+
+    Roles._checkScopeName(options.scope)
+
+    filter = Object.assign(
+      {
+        fields: { &#x27;user._id&#x27;: 1 }
+      },
+      filter
+    )
+
+    const selector = {
+      &#x27;inheritedRoles._id&#x27;: { $in: roles }
+    }
+
+    if (!options.anyScope) {
+      selector.scope = { $in: [options.scope] }
+
+      if (!options.onlyScoped) {
+        selector.scope.$in.push(null)
+      }
+    }
+
+    return Meteor.roleAssignment.find(selector, filter)
+  },
+
+  /**
+   * Deprecated. Use &#x60;getScopesForUser&#x60; instead.
+   *
+   * @method getGroupsForUserAsync
+   * @returns {Promise&lt;Array&gt;}
+   * @static
+   * @deprecated
+   */
+  getGroupsForUserAsync: async function (...args) {
+    if (!getGroupsForUserDeprecationWarning) {
+      getGroupsForUserDeprecationWarning = true
+      console &amp;&amp;
+        console.warn(
+          &#x27;getGroupsForUser has been deprecated. Use getScopesForUser instead.&#x27;
+        )
+    }
+
+    return await Roles.getScopesForUser(...args)
+  },
+
+  /**
+   * Retrieve users scopes, if any.
+   *
+   * @method getScopesForUserAsync
+   * @param {String|Object} user User ID or an actual user object.
+   * @param {Array|String} [roles] Name of roles to restrict scopes to.
+   *
+   * @return {Promise&lt;Array&gt;} Array of user&#x27;s scopes, unsorted.
+   * @static
+   */
+  getScopesForUserAsync: async function (user, roles) {
+    let id
+
+    if (roles &amp;&amp; !Array.isArray(roles)) roles = [roles]
+
+    if (user &amp;&amp; typeof user === &#x27;object&#x27;) {
+      id = user._id
+    } else {
+      id = user
+    }
+
+    if (!id) return []
+
+    const selector = {
+      &#x27;user._id&#x27;: id,
+      scope: { $ne: null }
+    }
+
+    if (roles) {
+      selector[&#x27;inheritedRoles._id&#x27;] = { $in: roles }
+    }
+
+    const scopes = (
+      await Meteor.roleAssignment
+        .find(selector, { fields: { scope: 1 } })
+        .fetchAsync()
+    ).map((obi) =&gt; obi.scope)
+
+    return [...new Set(scopes)]
+  },
+
+  /**
+   * Rename a scope.
+   *
+   * Roles assigned with a given scope are changed to be under the new scope.
+   *
+   * @method renameScopeAsync
+   * @param {String} oldName Old name of a scope.
+   * @param {String} newName New name of a scope.
+   * @returns {Promise}
+   * @static
+   */
+  renameScopeAsync: async function (oldName, newName) {
+    let count
+
+    Roles._checkScopeName(oldName)
+    Roles._checkScopeName(newName)
+
+    if (oldName === newName) return
+
+    do {
+      count = await Meteor.roleAssignment.updateAsync(
+        {
+          scope: oldName
+        },
+        {
+          $set: {
+            scope: newName
+          }
+        },
+        { multi: true }
+      )
+    } while (count &gt; 0)
+  },
+
+  /**
+   * Remove a scope.
+   *
+   * Roles assigned with a given scope are removed.
+   *
+   * @method removeScopeAsync
+   * @param {String} name The name of a scope.
+   * @returns {Promise}
+   * @static
+   */
+  removeScopeAsync: async function (name) {
+    Roles._checkScopeName(name)
+
+    await Meteor.roleAssignment.removeAsync({ scope: name })
+  },
+
+  /**
+   * Throw an exception if &#x60;roleName&#x60; is an invalid role name.
+   *
+   * @method _checkRoleName
+   * @param {String} roleName A role name to match against.
+   * @private
+   * @static
+   */
+  _checkRoleName: function (roleName) {
+    if (
+      !roleName ||
+      typeof roleName !== &#x27;string&#x27; ||
+      roleName.trim() !== roleName
+    ) {
+      throw new Error(&#x60;Invalid role name &#x27;${roleName}&#x27;.&#x60;)
+    }
+  },
+
+  /**
+   * Find out if a role is an ancestor of another role.
+   *
+   * WARNING: If you check this on the client, please make sure all roles are published.
+   *
+   * @method isParentOfAsync
+   * @param {String} parentRoleName The role you want to research.
+   * @param {String} childRoleName The role you expect to be among the children of parentRoleName.
+   * @returns {Promise}
+   * @static
+   */
+  isParentOfAsync: async function (parentRoleName, childRoleName) {
+    if (parentRoleName === childRoleName) {
+      return true
+    }
+
+    if (parentRoleName == null || childRoleName == null) {
+      return false
+    }
+
+    Roles._checkRoleName(parentRoleName)
+    Roles._checkRoleName(childRoleName)
+
+    let rolesToCheck = [parentRoleName]
+    while (rolesToCheck.length !== 0) {
+      const roleName = rolesToCheck.pop()
+
+      if (roleName === childRoleName) {
+        return true
+      }
+
+      const role = await Meteor.roles.findOneAsync({ _id: roleName })
+
+      // This should not happen, but this is a problem to address at some other time.
+      if (!role) continue
+
+      rolesToCheck = rolesToCheck.concat(role.children.map((r) =&gt; r._id))
+    }
+
+    return false
+  },
+
+  /**
+   * Normalize options.
+   *
+   * @method _normalizeOptions
+   * @param {Object} options Options to normalize.
+   * @return {Object} Normalized options.
+   * @private
+   * @static
+   */
+  _normalizeOptions: function (options) {
+    options = options === undefined ? {} : options
+
+    // TODO Number will error out on scope validation, we can either error it out here
+    // or make it into a string and hence a valid input.
+    if (options === null || typeof options === &#x27;string&#x27; || typeof options === &#x27;number&#x27;) {
+      options = { scope: options }
+    }
+
+    options.scope = Roles._normalizeScopeName(options.scope)
+
+    return options
+  },
+
+  /**
+   * Normalize scope name.
+   *
+   * @method _normalizeScopeName
+   * @param {String} scopeName A scope name to normalize.
+   * @return {String} Normalized scope name.
+   * @private
+   * @static
+   */
+  _normalizeScopeName: function (scopeName) {
+    // map undefined and null to null
+    if (scopeName == null) {
+      return null
+    } else {
+      return scopeName
+    }
+  },
+
+  /**
+   * Throw an exception if &#x60;scopeName&#x60; is an invalid scope name.
+   *
+   * @method _checkScopeName
+   * @param {String} scopeName A scope name to match against.
+   * @private
+   * @static
+   */
+  _checkScopeName: function (scopeName) {
+    if (scopeName === null) return
+
+    if (
+      !scopeName ||
+      typeof scopeName !== &#x27;string&#x27; ||
+      scopeName.trim() !== scopeName
+    ) {
+      throw new Error(&#x60;Invalid scope name &#x27;${scopeName}&#x27;.&#x60;)
+    }
+  }
+})
+
+    </pre>
+</div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 00000000..37ac1a39
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,118 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="./assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="./assets/css/main.css" id="site_styles">
+    <link rel="icon" href="./assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="./assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="./classes/Roles.html">Roles</a></li>
+                                <li><a href="./classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="./modules/Roles.html">Roles</a></li>
+                                <li><a href="./modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+    <div class="apidocs">
+        <div id="docs-main" class="content">
+            <p>
+            Browse to a module or class using the sidebar to view its API documentation.
+            </p>
+
+            <h2>Keyboard Shortcuts</h2>
+
+            <ul>
+                <li><p>Press <kbd>s</kbd> to focus the API search box.</p></li>
+
+                <li><p>Use <kbd>Up</kbd> and <kbd>Down</kbd> to select classes, modules, and search results.</p></li>
+
+                <li class="mac-only"><p>With the API search box or sidebar focused, use <kbd><span class="cmd">&#x2318;</span>-Left</kbd> or <kbd><span class="cmd">&#x2318;</span>-Right</kbd> to switch sidebar tabs.</p></li>
+
+                <li class="pc-only"><p>With the API search box or sidebar focused, use <kbd>Ctrl+Left</kbd> and <kbd>Ctrl+Right</kbd> to switch sidebar tabs.</p></li>
+            </ul>
+        </div>
+    </div>
+
+
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="./assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="./assets/js/yui-prettify.js"></script>
+<script src="./assets/../api.js"></script>
+<script src="./assets/js/api-filter.js"></script>
+<script src="./assets/js/api-list.js"></script>
+<script src="./assets/js/api-search.js"></script>
+<script src="./assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/modules/Roles.html b/docs/modules/Roles.html
new file mode 100644
index 00000000..2d49158c
--- /dev/null
+++ b/docs/modules/Roles.html
@@ -0,0 +1,152 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>Roles - The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+    <link rel="icon" href="../assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="../assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="../classes/Roles.html">Roles</a></li>
+                                <li><a href="../classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="../modules/Roles.html">Roles</a></li>
+                                <li><a href="../modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+<h1>Roles Module</h1>
+<div class="box clearfix meta">
+
+
+        <div class="foundat">
+            Defined in: <a href="../files/roles_roles_common_async.js.html#l41"><code>roles&#x2F;roles_common_async.js:41</code></a>
+        </div>
+
+</div>
+
+
+<div class="box intro">
+    <p>Provides functions related to user authorization. Compatible with built-in Meteor accounts packages.</p>
+<p>Roles are accessible through <code>Meteor.roles</code> collection and documents consist of:</p>
+<ul>
+<li><code>_id</code>: role name</li>
+<li><code>children</code>: list of subdocuments:
+<ul>
+<li><code>_id</code></li>
+</ul>
+</li>
+</ul>
+<p>Children list elements are subdocuments so that they can be easier extended in the future or by plugins.</p>
+<p>Roles can have multiple parents and can be children (subroles) of multiple roles.</p>
+<p>Example: <code>{_id: 'admin', children: [{_id: 'editor'}]}</code></p>
+<p>The assignment of a role to a user is stored in a collection, accessible through <code>RoleAssignmentCollection</code>.
+It's documents consist of</p>
+<ul>
+<li><code>_id</code>: Internal MongoDB id</li>
+<li><code>role</code>: A role object which got assigned. Usually only contains the <code>_id</code> property</li>
+<li><code>user</code>: A user object, usually only contains the <code>_id</code> property</li>
+<li><code>scope</code>: scope name</li>
+<li><code>inheritedRoles</code>: A list of all the roles objects inherited by the assigned role.</li>
+</ul>
+
+</div>
+
+
+<div class="yui3-g">
+    <div class="yui3-u-1-2">
+            <p>This module provides the following classes:</p>
+
+            <ul class="module-classes">
+                <li class="module-class">
+                    <a href="../classes/Roles.html">
+                        Roles
+                    </a>
+                </li>
+            </ul>
+    </div>
+
+
+    <div class="yui3-u-1-2">
+    </div>
+</div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/modules/UIHelpers.html b/docs/modules/UIHelpers.html
new file mode 100644
index 00000000..41aea141
--- /dev/null
+++ b/docs/modules/UIHelpers.html
@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>UIHelpers - The meteor-roles API</title>
+    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
+    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
+    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
+    <link rel="icon" href="../assets/favicon.ico">
+    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
+</head>
+<body class="yui3-skin-sam">
+
+<div id="doc">
+    <div id="hd" class="yui3-g header">
+        <div class="yui3-u-3-4">
+                <h1><img src="../assets/css/logo.png" title="The meteor-roles API" width="117" height="52"></h1>
+        </div>
+        <div class="yui3-u-1-4 version">
+            <em>API Docs for: v4.0.0</em>
+        </div>
+    </div>
+    <div id="bd" class="yui3-g">
+
+        <div class="yui3-u-1-4">
+            <div id="docs-sidebar" class="sidebar apidocs">
+                <div id="api-list">
+                    <h2 class="off-left">APIs</h2>
+                    <div id="api-tabview" class="tabview">
+                        <ul class="tabs">
+                            <li><a href="#api-classes">Classes</a></li>
+                            <li><a href="#api-modules">Modules</a></li>
+                        </ul>
+                
+                        <div id="api-tabview-filter">
+                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
+                        </div>
+                
+                        <div id="api-tabview-panel">
+                            <ul id="api-classes" class="apis classes">
+                                <li><a href="../classes/Roles.html">Roles</a></li>
+                                <li><a href="../classes/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                
+                
+                            <ul id="api-modules" class="apis modules">
+                                <li><a href="../modules/Roles.html">Roles</a></li>
+                                <li><a href="../modules/UIHelpers.html">UIHelpers</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+        <div class="yui3-u-3-4">
+                <div id="api-options">
+                    Show:
+                    <label for="api-show-inherited">
+                        <input type="checkbox" id="api-show-inherited" checked>
+                        Inherited
+                    </label>
+            
+                    <label for="api-show-protected">
+                        <input type="checkbox" id="api-show-protected">
+                        Protected
+                    </label>
+            
+                    <label for="api-show-private">
+                        <input type="checkbox" id="api-show-private">
+                        Private
+                    </label>
+                    <label for="api-show-deprecated">
+                        <input type="checkbox" id="api-show-deprecated">
+                        Deprecated
+                    </label>
+            
+                </div>
+            
+            <div class="apidocs">
+                <div id="docs-main">
+                    <div class="content">
+<h1>UIHelpers Module</h1>
+<div class="box clearfix meta">
+
+
+        <div class="foundat">
+            Defined in: <a href="../files/roles_client_uiHelpers.js.html#l3"><code>roles&#x2F;client&#x2F;uiHelpers.js:3</code></a>
+        </div>
+
+</div>
+
+
+<div class="box intro">
+    <p>Convenience functions for use on client.</p>
+<p>NOTE: You must restrict user actions on the server-side; any
+client-side checks are strictly for convenience and must not be
+trusted.</p>
+
+</div>
+
+
+<div class="yui3-g">
+    <div class="yui3-u-1-2">
+            <p>This module provides the following classes:</p>
+
+            <ul class="module-classes">
+                <li class="module-class">
+                    <a href="../classes/UIHelpers.html">
+                        UIHelpers
+                    </a>
+                </li>
+            </ul>
+    </div>
+
+
+    <div class="yui3-u-1-2">
+    </div>
+</div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+<script src="../assets/vendor/prettify/prettify-min.js"></script>
+<script>prettyPrint();</script>
+<script src="../assets/js/yui-prettify.js"></script>
+<script src="../assets/../api.js"></script>
+<script src="../assets/js/api-filter.js"></script>
+<script src="../assets/js/api-list.js"></script>
+<script src="../assets/js/api-search.js"></script>
+<script src="../assets/js/apidocs.js"></script>
+</body>
+</html>
diff --git a/docs/modules/index.html b/docs/modules/index.html
new file mode 100644
index 00000000..487fe15b
--- /dev/null
+++ b/docs/modules/index.html
@@ -0,0 +1,10 @@
+<!doctype html>
+<html>
+    <head>
+        <title>Redirector</title>
+        <meta http-equiv="refresh" content="0;url=../">
+    </head>
+    <body>
+        <a href="../">Click here to redirect</a>
+    </body>
+</html>