feat: add SilentSignin (#23)

* feat: add SilentSignin

* chore: add API doc in README

Author: imp2002

README.md

@@ -131,6 +131,48 @@ export default {
 </script>
 ```
 
+## API reference interface
+### Get sign up url
+```javascript
+getSignupUrl()
+```
+Return the casdoor url that navigates to the registration screen
+
+### Get sign in url
+```javascript
+getSigninUrl()
+```
+Return the casdoor url that navigates to the login screen
+
+### Get user profile page url
+```javascript
+getUserProfileUrl(userName, account)
+```
+Return the url to navigate to a specific user's casdoor personal page
+
+### Get my profile page url
+```javascript
+getMyProfileUrl(account)
+```
+
+### Sign in
+```javascript
+signin(serverUrl, signinPath)
+```
+Handle the callback url from casdoor, call the back-end api to complete the login process
+
+### Determine whether silent sign-in is being used
+```javascript
+isSilentSigninRequired()
+```
+We usually use this method to determine if silent login is being used. By default, if the silentSignin parameter is included in the URL and equals one, this method will return true. Of course, you can also use any method you prefer.
+
+### silentSignin
+```javascript
+silentSignin(onSuccess, onFailure)
+```
+`onSuccess` and `onFailure` are the callback methods for successful and failed login.
+
 ## Q & A
 
 Q1:  How to solve "...index.js implicitly has an 'any' type..." error in typescript project?

package.json

@@ -10,7 +10,7 @@
     "lint": "vue-cli-service lint"
   },
   "dependencies": {
-    "casdoor-js-sdk": "^0.2.7",
+    "casdoor-js-sdk": "^0.7.0",
     "core-js": "^3.8.3",
     "vue-demi": "latest"
   },

src/CasdoorSDK.js

@@ -37,9 +37,17 @@ export default {
         return CasdoorSDK.getMyProfileUrl(account);
       };
 
-      app.prototype.signin = (ServerUrl) => {
-        return CasdoorSDK.signin(ServerUrl);
+      app.prototype.signin = (ServerUrl, signinPath) => {
+        return CasdoorSDK.signin(ServerUrl, signinPath);
       };
+
+      app.prototype.isSilentSigninRequired = () => {
+        return CasdoorSDK.isSilentSigninRequired();
+      }
+
+      app.prototype.silentSignin = (isLoggedIn, onSuccess, onFailure) => {
+        return CasdoorSDK.silentSignin(isLoggedIn, onSuccess, onFailure);
+      }
     }else{
 
       app.provide(CASDOOR_SDK_INJECTION_KEY,
@@ -48,7 +56,9 @@ export default {
           getSigninUrl: CasdoorSDK.getSigninUrl.bind(CasdoorSDK),
           getUserProfileUrl: CasdoorSDK.getUserProfileUrl.bind(CasdoorSDK),
           getMyProfileUrl: CasdoorSDK.getMyProfileUrl.bind(CasdoorSDK),
-          signin: CasdoorSDK.signin.bind(CasdoorSDK)
+          signin: CasdoorSDK.signin.bind(CasdoorSDK),
+          isSilentSigninRequired: CasdoorSDK.isSilentSigninRequired.bind(CasdoorSDK),
+          silentSignin: CasdoorSDK.silentSignin.bind(CasdoorSDK)
         }
       );
 
@@ -68,13 +78,22 @@ export default {
         return CasdoorSDK.getMyProfileUrl(account);
       };
 
-      app.config.globalProperties.signin = (ServerUrl) => {
+      app.config.globalProperties.signin = async (ServerUrl) => {
         const code = window.location.href.split('code=')[1].split('&')[0];
         const state = window.location.href.split('state=')[1].split('&')[0];
-        return fetch(`${ServerUrl}/api/signin?code=${code}&state=${state}`, {
+        const res = await fetch(`${ServerUrl}/api/signin?code=${code}&state=${state}`, {
           method: "POST",
-          credentials: "include",
-        }).then(res => res.json());
+          credentials: "include"
+        })
+        return await res.json()
+      };
+
+      app.config.globalProperties.isSilentSigninRequired = () => {
+        return CasdoorSDK.isSilentSigninRequired();
+      };
+
+      app.config.globalProperties.silentSignin = (isLoggedIn, onSuccess, onFailure) => {
+        return CasdoorSDK.silentSignin(isLoggedIn, onSuccess, onFailure);
       };
     }
 

yarn.lock

@@ -3251,10 +3251,10 @@ cardinal@^2.1.1:
     ansicolors "~0.3.2"
     redeyed "~2.1.0"
 
-casdoor-js-sdk@^0.2.7:
-  version "0.2.7"
-  resolved "https://registry.yarnpkg.com/casdoor-js-sdk/-/casdoor-js-sdk-0.2.7.tgz#09342f6715977bc1991222d04dd36c93b5f0872b"
-  integrity sha512-pEI7chd6KWDa7dhBxl3zDY+LagG40bBPoxdPMOZ5OG2gFMTXwRQ4Ka1do0giJsd2YTeAU3u6vwP62YmiQVzgSQ==
+casdoor-js-sdk@^0.7.0:
+  version "0.7.0"
+  resolved "https://registry.yarnpkg.com/casdoor-js-sdk/-/casdoor-js-sdk-0.7.0.tgz#ee6d8eea138210f26a14452a534cec6c4759b4cd"
+  integrity sha512-CcYf1YmdkCPmAbIn+RtQIHpLxq2H3UeOTmm+3ljg5bLBiESAJHhc0uGVpm7crWy/uAJJhQRgLXTPuoQQsgYCvQ==
 
 case-sensitive-paths-webpack-plugin@^2.3.0:
   version "2.4.0"