用户名
一个用于执行OAuth登录到Girder 4 (Django)服务器的TypeScript库.
说明
这为Girder 4服务器的认证提供了支持, 使用带有 PKCE 流的 OAuth2.0 授权代码 Grant.
使用量
-
安装库 :
yarn add @girder/oauth-client或者如果你正在使用 npm:
npm install @girder/oauth-client -
证明一个
OauthClient包含应用程序的配置 :import OauthClient from '@girder/oauth-client'; const oauthClient = new OauthClient( new URL(process.env.OAUTH_API_ROOT), // e.g. 'http://localhost:8000/oauth/' process.env.OAUTH_CLIENT_ID, // e.g. 'Qir0Aq7AKIsAkMDLQe9MEfORbHEBKsViNhAKJf1A' ); -
打电话
redirectToLogin当开始登录流量时 :document.querySelector('#sign-in-link').addEventListener('click', (event) => { event.preventDefault(); oauthClient.redirectToLogin(); // This will redirect away from the current page }); -
开始时 每个 页面装入, 无条件调用
maybeRestoreLogin,试图 恢复登录状态; 如果没有登录, 则不启用 。 之后,获取并存储 HTTP 认证信头authHeaders。 。 。 .let authHeaders; oauthClient.maybeRestoreLogin() .then(() => { authHeaders = oauthClient.authHeaders; });
或,如果使用ES6和 async编号 :await数字 :
await oauthClient.maybeRestoreLogin();
let { authHeaders } = client;
-
每个 Ajax API 请求包含这些信头 :
fetch('http://localhost:8000/api/files', { headers: authHeaders, }); -
登录状态将持续到整个页面刷新 。 打电话
logout以清除任何活动登录 :document.querySelector('#sign-out-link').addEventListener('click', (event) => { event.preventDefault(); oauthClient.logout() .then(() => { authHeaders = oauthClient.authHeaders; }); });
示例应用程序
这个寄存器被捆绑在一起 示例应用程序。运行它与 :
git clone https://github.com/girder/girder-oauth-client.git
yarn install
yarn build
cd example
yarn install
yarn serve
# Visit http://localhost:1234/
发展
要使用示例应用程序开发库 :
# From the root of the repository
yarn link
yarn install
yarn watch
在另一个终端:
# From the root of the repository
cd example
yarn link '@girder/oauth-client'
yarn install
yarn serve