From 6180f6b816ead992713722ed78b12f13a7449ff5 Mon Sep 17 00:00:00 2001
From: linchen1987 <linchen.1987@foxmail.com>
Date: Mon, 27 Jun 2022 13:39:04 +0800
Subject: [PATCH] docs: update doc for Blocklet SDK (#143)

---
 .makefiles/bump_version.sh             |   3 +--
 CHANGELOG.md                           |   4 ++++
 blocklet.yml                           |   6 ++++--
 logo.png                               | Bin 0 -> 4572 bytes
 package.json                           |   2 +-
 src/developer/blocklet-sdk/index.md    |  26 +++++++++++++++++++++++--
 src/developer/blocklet-sdk/index.zh.md |  26 +++++++++++++++++++++++--
 version                                |   2 +-
 8 files changed, 59 insertions(+), 10 deletions(-)
 create mode 100644 logo.png

diff --git a/.makefiles/bump_version.sh b/.makefiles/bump_version.sh
index ad8530c..40e23c6 100755
--- a/.makefiles/bump_version.sh
+++ b/.makefiles/bump_version.sh
@@ -26,8 +26,7 @@ if [ -f $VERSION ]; then
     V_PATCH=${BASE_LIST[2]}
     echo -e "${NOTICE_FLAG} Current version: ${WHITE}$BASE_STRING"
     echo -e "${NOTICE_FLAG} Latest commit hash: ${WHITE}$LATEST_HASH"
-    V_MINOR=$((V_MINOR + 1))
-    V_PATCH=0
+    V_PATCH=$((V_PATCH + 1))
     SUGGESTED_VERSION="$V_MAJOR.$V_MINOR.$V_PATCH"
     echo -ne "${QUESTION_FLAG} ${CYAN}Enter a version number [${WHITE}$SUGGESTED_VERSION${CYAN}]: "
     read INPUT_STRING
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ea3172f..5ef07f7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.6.3 (June 27, 2022)
+
+- docs: update doc for Blocklet SDK
+
 ## 0.6.2 (April 28, 2022)
 
 - doc: update sdk doc
diff --git a/blocklet.yml b/blocklet.yml
index 0eb208a..7d2a4e8 100644
--- a/blocklet.yml
+++ b/blocklet.yml
@@ -1,5 +1,5 @@
 name: '@arcblock/abtnode-docs'
-version: 0.6.2
+version: 0.6.3
 description: >-
   Blocklet Server Documentation, a help documentation for quickly get started
   with Blocklet Server.
@@ -8,9 +8,11 @@ files:
   - public/
   - screenshots/
   - blocklet.md
+  - logo.png
 keywords:
   - Docs
   - ABTNode
+logo: logo.png
 repository:
   type: git
   url: git+https://github.com/ArcBlock/abtnode-docs.git
@@ -25,7 +27,7 @@ title: Blocklet Server Docs
 community: https://gitter.im/ArcBlock/community
 documentation: https://docs.arcblock.io
 support: support@arcblock.io
-specVersion: 1.2.4
+specVersion: 1.2.7
 did: z8ia5NLSuFwhPimBJHRdPmp6yx9fG8rcFex4b
 timeout:
   start: 10
diff --git a/logo.png b/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..49ccb839fd3db750ee14e7d41532c5427a095b7e
GIT binary patch
literal 4572
zcmbtYc|4Te+dngdvCa@hWa;sc%2MHn@iL=ClBJZ8t;a)1p=?=Z1}*lbvJ^5!j3qp_
z5QbDlhNNg2GomoE)Qn}uEbra#^LhXMect!;{&9cKb<Vl2bKUp3uj~6g*GYADw3U%m
zmIMIE*d4Pz1po{ZVL)6AYCNxy1E5AC?3nvi0CeqtKd{FZ`BlGFuAZ_z4C<)67NCyE
z1uF+D0RG9A;++=-KrY<Q+Uj%+Y>7s@qA=0^>ZdW>Jw8O2L~Qijk&==|_Jz5w>o?XE
zOJZKXww!EFX6$cB5bZrHJ14nqS;K5tqWrnU8Ht-ZZGRT{XI`JNOO#4?786UzS!*62
zJjT4Y95igZ5i6urr#1wn3>h{(@Lu^`6L-e5peyF*UvGqM9#yCHxB7PqmE!o^wUfeU
z2ay`CYkqzovoo1oE|;H}m>4IR>q<tVUA+{~cq(pM)x(5R!c9Uy4!M4~H|*l2OG`J=
z$>-|&FgpOIy1uRsKku@rDa^K2B|5q&d2XCvt#llgUf%_z<4JS*38|}9>d_|a$|7-+
z#IyC@3G)a>haUsMmmL<LikZn&(XaG`kzP%8Cv4#tk-{@b5`EmXm};n^6n1IsB;5&X
z>9>lwaj@bb=hwHP>`%P7rD4Eh2wT)QFA41d`zAVRF*!N8^zVd(?_f3A$3<`vg?q^9
z?pcZVVI-fZAO7_RcGLJ9<p;Q%^Z~UgTj&_)6^!;}4U905$E__enY8AK7HMK$UY^gv
zCFG!;-`Rv`uJu74@Q?>H!f}|6F*XZp8OFeUb#s&kC36!&qWy4n4UwV6#l;n^C-TR1
zVLS$9L5YXc$qJtK9+Q6t?@{O1o7FK8NslUg#|}Tdq}B6%+{ac3?XuC3V4UGji`Edl
zY~4vL)sCNs?8sTm#iAj@Adm;s4k;2fqJlb%7*@99QWNpXPF$C_PuK||Oe+7@&6`;Z
z=(p0ijn%8t_@1<~B0qeMNZWT%_^@c5c|iemb2bc-JsHF1QO^bgHVD121O5pK{95%b
zgeOyKG9t345{g=-a$1KGqHPwq8C7UA3K70p>&(-jfs1Zf2z=~aPl*C2g5&&T!L$Yd
zed3_!0300106<#vKXyN__zwQy9WkM>olH#IMl!Rr+I|{pqN2jh8szAf*O<$A%asQd
za_AQSVe*k>9(pRgl5Y9U7Y&nbs~mao>|VR*#!|E}nA4Gar=K?a!c9TEAsL8|4-Qrr
z@tGH~wEC8{4M$4C*oe4|1YA>`2wp}C2ARydIh5+Ei{NK;aqEro#Rrty6?~>TkBtn`
z0PwL|YC$i5s|;pg$;}T1g365=_oO5Z34Y?L9Dt4XOyDlN&Rz7ta{B(cgrMZY{nl%4
zU0x{aPaP>WU9TwW2+L~Jz=_~eAHU})x6Sq2mX*5eh%bLBWo7oQ$d^`PW!2!M>qe`_
z^XJ}knDg1inB`xiCrD=q4EDfl9XDsZ2=4W46^oS?pqSn=oAVGWD*`9|x$ZGHca)$J
zB7*A;>cFy&wtNF2mDCY?tFVpU0zE{E0LPI9qIr+0rLh~H6G(yM6E5PU#1*a{7ol|+
zC^#>@y)#dyr(>`Nd7AdZnDOS5#|Wfd;zYPz4XfWN+Zs_*ilChIAoy+$oR9uCCgN|E
zC<jEH??MJ##J8h>ee&cYuX7%K7Y!TT^Vaw0yE)g$?uspcg&Uv#$`s%vWPyciD+XKN
zEFdN^`073+-FZVe$+l6Ke6QGaQRTud&tq)51?y!Jw&|zWR~8$|O$YOhqfB0>#~RYQ
zNsWu>vIP+*2O{y_Y-HLEFc04kiSAs)S$)U0X%n=0gd%LzN@eY`vB&Fz>rxk5?WN#c
z1P!tQk%Fne7tnzp{*HV#?jX{mwlHLFc-CRpW;H7k;h1nOSAWUoPc{;h4F*y%6!UpB
zdk1W^qB(M9oKs>&Aeo30Gsc+ldW^S+)tEeLwFUlbKtPS&7Gj^2cv8GLQQBzr!W^Z7
zx}piWvjWXI(7*rYK?!|xK6NmOb4x`k^|p?91>R`cahH13z)f%rSK<=_xw{1dAyq~G
zt6d*P)hEs2zVeayYj4#DM&bdPI`NAJMej;%osJ2^8j~k#-_oyVf_dL9aV^?jGVdcG
zQPJ}J#PvccVjJ~rG*%)KucYuJS}5>;Cm;@*S=1sEt00}Hw*<J0+Hg{VO7NqYMmDlm
z%xV+{Ijz}U{z`U@B*R8VN$G?9?rXCF-*=Q@_c*NGz|dPON4le<mxqm)(1EU|P|Cfi
z)o25oGfU4>T@v0R&CSAZUVWZYPD`<-7YK_4>WYnww5fn(pR<b#mh5p(O3+}vJELUl
z>f2i1$^gTG9BEU{=Fz$DC6uFDaE)LTU9gz^qBrzLRo}FYOPFP_WTVoHy5{c<T2@Hh
z_?wTE(6gD9pPbC!H@H8xsOFrbbw>I}4!;=3?ud{eIWDt>-Y0g=a&uagogI#3iA=wX
z@F{JvWR=6}RtDHk`Zh>u`y>O{qwRQ1iQ$z)|9mW4U@TGo%QrKI)XYAo80Y@^&cXeL
z7C<IME56AE%jMgI676k|<hHVlT%NzWPuy0@weyhMVIpDd@b@C~*Vp`|kN4t{kK+2h
zOcfnC#(cV&inA=)yIfaC(P6`QHFDPJx#TGAge^&IeT0BH>MjeS0tauI<qWy*m>++e
zXD|OoOwvZG6WZPTjvH$qnMno}Td!lz{_CZGViw!Z<o4)CM4o8KX?N)$lc@7YK7?%U
zSRol?3?`BDJ!_ZlpJHxwv=%p#2#sIpR;B1MIpFZ(BGMyIRCn*P-tx@kH4&UtxO>>w
z$*_0Y57i{4@)e?;KH+6fY_K%JA!kiHw1e=@<^9_WM88CJu-Zz_MgOd8*{v@X(CwC@
zuN_=&K+acgiXs`Z@xc<IQ2M`^ySE%I1{>8*n6C50(61~JpYO(;3%kjpUMts|F6lTx
zJyCN+oLKy|1!4E>Ju|(gtl)v4U3k=!sGx26t5IqzvuZCsJ3s*4P#%MB)SYgLf9Y)^
z2UL4*f8|ZqKBkBhQD2Yu{TRz%Jw#iPnWCZ6Cs6ZJ#Str<Hr<8}6R%GZKJVfkHq0vN
zDk8W7X?3$*d7{G=ZQO*VpYksLiH-|FJ6=RkOvQ=%?-XNaXMg5HV=9i0*Pk8Td9Hao
zl>LYx`!r+ulnaR6dV2#TLVwBui@T9_;o|-<`<S7`XbSpp_gK#U^+5<c?&zLX&cDRE
z-RxjexU2|4)`fi%Hjb+4VpM9Q##E=Zf3J<3!qwI0`^)L@j0OC`pQ#EscN2s2?=pXB
z0?G0dMFkDlO{7I|u<h6E4i;U$e#5DXl-7Dp0uob!PTS`3zCf$tzn&QQ!=RCLpp&X=
zpJv|m@A+(}I_ub$-{Pbdxa&OgU8}_V)SC*GR#~9+;kDLFXyc$I+Pf}$Ki?kLDhCn=
znyyLM$Mo(|DXc9jAoo$Oz7Ee==vEcM5gS9iZ(nyX`LP?oKLoRGm$*H@C|?@I82gvO
z+mph<ZxZ+8ZDdRfWexVaUaGfJSK0NYpJ9>#4%qnjG6V@I+5Z*){%3an|IQ|%h;s(a
z<>h39vQpfBZq}D}?A!xN^P1Pk6}Vv=fpX5>i^iRM9I9rU&BDg?XO^mkCnxvv_xPb*
zU0rFsQ^Qz6`%;|dEtGWosHll@#guBaVbgmrJIk&26PK%6<wSlT27szk!1wBBV%_t&
zD}pa%DX%ctfh)h-R0Q>X_#SMACBsHVt2bUj?0=YKlC^ZF@@+KZ^NJvEvojzK<Lp+b
zC&uxKnP=oc>`f)4lsP0bAVlNb>v=tI9Bc8sawOq<dUcIO?Cnins$ZxLUB#Y$i=?TK
zN|NutN&CU;^YXXyBjEgDR<ackEkdz9tG$P61M|&H%__`d#|Ad+5ry#+!-5ziR06G&
zs!k6?o%65Os*`md9Ko_}lV5&nom1XIxL}o|_hg~X@1FH2A>iZ3Gqbz>1+_Wt!dM5^
z9)jt2EHAf$pZJ-;FBahJUS7oBmx)i0#P1K7F<3@t6k{I5e995v+MVa-{P1To995VQ
zy>*gVEI;=z6>V5jZ=FWq_@ufshvbgnIz@InE?Ok4$4^{U-kiB$LuR?GQjJE9u$Zyz
z;*d}3qp{&!1pjCW-An|R1R3uY(kO(F%~(><W3~9Vv6^)(V|n{WiS^5tk@zSGsJMUd
zd6g~>TL|u<4{F$l*ipnd2cpZraRd^9%zBm{tq1XESDx$K{=n^Rog;BaK=a;ZbYRD|
zxhc<g0$`Ps&5R$eF#6_nxP<O5f^+P%MLqq2p5MU4LY%4pgj!l`+86in{BL?chP}dc
zYlc5LLm+AdIz|d;BXjbhG@BB-S7({3Y~({1E<!RXb0^H-Dg#3iLa_7*n<Ep650?dA
zIW1Vy{%yuxE!HcxO;S-2@{T1Vm8Y4ia8mkLmE8Hjf^qdx&Lvt=&tU=)Ln(}T8mD1T
zAg#}v)4!qWr{2RK+-tv45ouXzzXhFMa$l+BO$mmQz5EmN6&B?Ni6p845>DzjYB;it
zE~gbHV<>LoM9U!PGX&Q&lONaeVNBky={xgHx_lVFdtl;eC5`A}RmtK=^S)M%FRo3X
zZpivLv)LavQb(ezv8(-9I&GiDquaCmy#>ffJV)-e=%Zd!{+;wHK5SUYsDZ0xUs7+V
z?5XS(4?)%AH6-_1*(oNkVRi3zw_GkFguGKb7HH*0O`kC5Cq~7B`^$?NFQ_2x<XnMD
zxYssi@``ZdMm`_*M0*#O?`q3MxHEZG(IW>}?X!T+y;p*sF|67pDY(qIBOBSA(3-^^
z=S<JY>sCRpui91bd4J%G`tL)C8V-C~LjU*y>lDsNrCMz(qoNgIvN-|##KNp8<$+8X
zX>XVF+-GYbq7yu&_hDNy&X$*#*YX0Up1v3_D)!t4hy?rfI<tZj497VTOeTJAYYf|s
zIXanE!MP)Ufwr1^1QjI<Y>XDs&@whaNgmld$W)HBgo=zt7_vwA{{(cRxc9IIay4*^
z0=ganVnAt)ySDfe#?OWd8uhIW1+cLTTon@&vviRN8-g9U02M;`qXhEAqLiQ?DteAa
z1_sWDG^2V7V1zL6hJ1S8Q??<BNH+%owNIYVMn{hGq<q8z7YoZ!xcNs56hT9a!la1^
zeg=q)I0@@R`DTJ-14LGL?Aq~RTmTH$me21M{JUUYL!UDQrIJH$;KYWYjQ(VweVI;&
zq(GAE8tec~34GQ^e$ef?)w2hM3p>4Kf)dO}+ZnK%h((s-br|q)lF2hU-nlykYrB~^
zbLhN=0&~S-k43H$xUcOj3C@qYO_{A_8+U0<CL)lQYlPe;I4+f=DcqwxH2k2xoR_fi
z^<_F;Mp~LT2GiM&-3;B-6t=k5+sS~ciN#WmdVwnO)N0elIl%z7WWD1=wCFmmZ{w~u
z3O5~88?cjio72j;f1Lav3`p81JZlajl(nvlt_u4n_!Nd;|K7u-z~+<{Kf<h#Ttc~9
zg>1MJDxJl7#c=5Nx=!qN=~_`&H!^=ealEc1k!>(m{fE!Cz+UI~u=!h?WNgWWRr|V~
zIL%?PeR+enf`=|QJgr3{d?LQpQCAkZs!x$|C}Lq!kFbqtpX_6H96?gS{A<-uRf=e1
zDP6}^pNLoDy^#~cUB;*RtYHPDttf7gKyTu_mjuzKNTzSdvR!|xw18LtDuNCx_4PyH
stPu$;a@}Is4il3f?RigIN0{`OimlR`C(VbU%NSsH)X}=`uy4|T17qHleE<Le

literal 0
HcmV?d00001

diff --git a/package.json b/package.json
index 56f7d36..842cbab 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@arcblock/abtnode-docs",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "Blocklet Server Documentation, a help documentation for quickly get started with Blocklet Server.",
   "main": "index.js",
   "publishConfig": {
diff --git a/src/developer/blocklet-sdk/index.md b/src/developer/blocklet-sdk/index.md
index 3c04ecf..247e9e4 100644
--- a/src/developer/blocklet-sdk/index.md
+++ b/src/developer/blocklet-sdk/index.md
@@ -57,9 +57,31 @@ Get owner of the team
 
 #### client.getUsers()
 
-Get all users of the team
+Get users of the app
+
+- _@param_ **paging** `Object`
+  - **paging.pageSize** ``
+  - **paging.page** ``
+- _@param_ **query** `Object`
+  - **query.role** `String` Match users by role name
+    - `$none`: Match users which does not have a role
+  - **query.approved** `Boolean` Match users by approved
+  - **query.search** `String` Match users by did or fullName
+- _@param_ **sort** `Object`
+  - **sort.createdAt** `Number`
+  - **sort.updatedAt** `Number`
+  - **sort.lastLoginAt** `Number`
+  - > `-1`: The latest time is at first. `1`: The latest time is at last.
+- _@return_ `{ code, users, paging }`
 
-- _@return_ `{ code, users }`
+```
+Paging {
+  total: number of users
+  pageSize: number of users per page
+  pageCount: number of page
+  page: current page number
+}
+```
 
 #### client.getPermissionsByRole(role)
 
diff --git a/src/developer/blocklet-sdk/index.zh.md b/src/developer/blocklet-sdk/index.zh.md
index fd5a020..29205eb 100644
--- a/src/developer/blocklet-sdk/index.zh.md
+++ b/src/developer/blocklet-sdk/index.zh.md
@@ -57,9 +57,31 @@ Get owner of the team
 
 #### client.getUsers()
 
-Get all users of the team
+获取用户列表
+
+- _@param_ **paging** `Object`
+  - **paging.pageSize** ``
+  - **paging.page** ``
+- _@param_ **query** `Object`
+  - **query.role** `String` 按 role name 匹配
+    - `$none`: 匹配没有 role 的用户
+  - **query.approved** `Boolean` 按 approved 匹配
+  - **query.search** `String` 按 did 或 fullName 匹配
+- _@param_ **sort** `Object`
+  - **sort.createdAt** `Number`
+  - **sort.updatedAt** `Number`
+  - **sort.lastLoginAt** `Number`
+  - > `-1`: The latest time is at first. `1`: The latest time is at last.
+- _@return_ `{ code, users, paging }`
 
-- _@return_ `{ code, users }`
+```
+Paging {
+  total: 全部用户数量
+  pageSize: 每页用户数量
+  pageCount: 一共有几页
+  page: 当前是第几页
+}
+```
 
 #### client.getPermissionsByRole(role)
 
diff --git a/version b/version
index b616048..844f6a9 100644
--- a/version
+++ b/version
@@ -1 +1 @@
-0.6.2
+0.6.3