@seayoo-web/gamer-api 1.0.0 → 1.0.3

package/README.md

@@ -1,11 +1,74 @@
 # Gamer Api Agent
 
+## 页面初始化
+
+```js
+import { NetRequest } from "@seayoo-web/request";
+import { AuthToken, EventApi, ClubApi, CommunityApi } from "@seayoo-web/gamer-api";
+
+const authToken = new AuthToken("https://gamer-api.seayoo.com", NetRequest);
+const eventApi = new EventApi(authToken, eventId);
+const clubApi = new ClubApi(authToken);
+const communityApi = new CommunityApi(authToken);
+
+// 设置 idToken 后即可认为登录（会在内部自动进行 gamerToken 的置换操作）
+// idToken 通过通行证登录组件获取
+export function login(idToken: string) {
+	authToken.idToken = idToken;
+    // 可选自动登录调用，后续每个 api 都会自动检查并 autoLogin
+	authToken.autoLogin();
+}
+
+// 如果在 ComboWebView 中，url query 会直接提供 gamer_token
+// authToken 会自动从 url query 中读取并更新 gamer_token
+
+// 导出供其他功能使用
+export { eventApi, clubApi, communityApi, weixinApi };
+```
+
+## 小程序初始化
+
 ```js
-import { GamerApi, GamerApiForWeixin } from "@seayoo-web/gamer-api";
+import { NetRequest } from "@seayoo-web/request/wx";
+import { AuthToken, EventApi, ClubApi, WeixinApi } from "@seayoo-web/gamer-api";
+import { usePromise } from "@seayoo-web/utils";
 
-// 在页面中使用
-const gamerApi1 = new GamerApi(Endpoint, eventId);
+const authToken = new AuthToken("https://gamer-api.seayoo.com", NetRequest);
+const eventApi = new EventApi(authToken, eventId);
+const clubApi = new ClubApi(authToken);
+const communityApi = new CommunityApi(authToken);
+const weixinApi = new WeixinApi(authToken, appId);
 
-// 在小程序中使用
-const gamerApi2 = new GamerApiForWeixin(Endpoint, eventId);
+// 获取 weixinToken / unionid / openid
+export async function weixinLogin() {
+    const result = await weixinApi.login(() => {
+       const { promise, resolve } = usePromise<string>()
+       // 调用 wx.login 获取 weixinCode
+       wx.login({
+           success(code) { resolve(code) },
+           fail({ errMsg, errno }) {
+            /* handle error */
+            resolve("")
+           }
+       })
+       return promise
+    })
+    if("error" in result) {
+       /* handle error */
+       return null
+    }
+    return result; // { weixin_token, openid, unionid }
+}
+
+// idToken 通过通行证登录组件获取，weixinToken 通过上述方法获取
+export function login(idToken: string, weixinToken: string) {
+	authToken.idToken = idToken
+    authToken.weixinToken = weixinToken;
+    // 可选自动登录调用，后续每个 api 都会自动检查并 autoLogin
+    authToken.autoLogin();
+}
+
+// 导出供其他功能使用
+export { eventApi, clubApi, communityApi, weixinApi };
 ```
+