@girder/oauth-client

中文文档
0.8.0发布于 2022/02/26Apache-2.0TypeScriptCommonJS近 30 天下载 2749

一个用于执行OAuth登录到Girder 4 (Django)服务器的TypeScript库.

此软件包已被标记为弃用

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

中文使用文档
文档目录4 节
  1. 说明
  2. 使用量
  3. 示例应用程序
  4. 发展

用户名

npm (scoped)

一个用于执行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

版本与发布记录

@girder/oauth-client 共发布 14 个版本,首次发布于 2020/12/16;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.8.0latest2022/02/264 年前
0.7.82022/01/294 年前
0.7.72021/03/165 年前
0.7.62021/01/215 年前
0.7.52021/01/215 年前
0.0.02021/01/215 年前

关于 @girder/oauth-client 的常见问题

@girder/oauth-client 是什么?

一个用于执行OAuth登录到Girder 4 (Django)服务器的TypeScript库.注意:该包已被作者标记为弃用——Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

如何安装 @girder/oauth-client?

在项目目录运行 npm install @girder/oauth-client,或使用 pnpm add / yarn add / bun add。

@girder/oauth-client 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@girder/oauth-client 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@girder/oauth-client 可以商用吗?

@girder/oauth-client 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@girder/oauth-client 的下载量有多少?

根据 npm 官方下载统计,@girder/oauth-client 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,749 次,日均约 92 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@girder/oauth-client 还在维护吗?

最新版本 0.8.0 发布于 2022/02/26(4 年前);至今共发布 14 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/12/16。作者已将其标记为弃用,新项目建议寻找替代方案。