@logto/connector-github 1.0.0-beta.19 → 1.0.0-beta.21

package/README.md

@@ -2,8 +2,6 @@
 
 The official Logto connector for GitHub social sign-in.
 
-GitHub 社交登录 Logto 官方连接器 [中文文档](#github-连接器)
-
 **Table of contents**
 
 - [Github connector](#github-connector)
@@ -11,19 +9,10 @@ GitHub 社交登录 Logto 官方连接器 [中文文档](#github-连接器)
   - [Sign in with GitHub account](#sign-in-with-github-account)
   - [Create and configure OAuth app](#create-and-configure-oauth-app)
   - [Managing OAuth apps](#managing-oauth-apps)
-  - [Compose the connector JSON](#compose-the-connector-json)
+  - [Configure your connector](#configure-your-connector)
     - [Config types](#config-types)
   - [Test GitHub connector](#test-github-connector)
   - [Reference](#reference)
-- [GitHub 连接器](#github-连接器)
-  - [开始上手](#开始上手)
-  - [登录 GitHub 账号](#登录-github-账号)
-  - [创建并配置 OAuth 应用程序](#创建并配置-oauth-应用程序)
-  - [管理 OAuth 应用程序](#管理-oauth-应用程序)
-  - [编写连接器的 JSON](#编写连接器的-json)
-    - [配置类型](#配置类型)
-  - [测试 GitHub 连接器](#测试-github-连接器)
-  - [参考](#参考)
 
 ## Get started
 
@@ -49,19 +38,10 @@ We suggest not to check the box before **Enable Device Flow**, or users who sign
 Go to the [OAuth Apps page](https://github.com/settings/developers) and you can add, edit or delete existing OAuth apps.
 You can also find `Client ID` and generate `Client secrets` in OAuth app detail pages.
 
-## Compose the connector JSON
+## Configure your connector
 
 Fill out the `clientId` and `clientSecret` field with _Client ID_ and _Client Secret_ you've got from OAuth app detail pages mentioned in the previous section.
 
-Here is an example of GitHub connector config JSON.
-
-```json
-{
-  "clientID": "<your-client-id>",
-  "clientSecret": "<your-client-secret>"
-}
-```
-
 ### Config types
 
 | Name         | Type   |
@@ -78,62 +58,3 @@ That's it. The GitHub connector should be available now. Don't forget to [Enable
 
 - [GitHub - Developers - Apps](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps)
 - [GitHub - Developers - Apps - Creating an OAuth App](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app)
-
-# GitHub 连接器
-
-## 开始上手
-
-GitHub 连接器让终端用户可以用 GitHub 账号，通过 GitHub OAuth 2.0 授权协议来登录你的应用。
-
-## 登录 GitHub 账号
-
-前往 [GitHub 网站](https://github.com/) 并登录你的 GitHub 帐号。
-
-## 创建并配置 OAuth 应用程序
-
-跟随 [创建 _OAuth 应用程序_](https://docs.github.com/cn/developers/apps/building-oauth-apps/creating-an-oauth-app)，注册一个新应用。
-
-为新 _OAuth 应用程序_ 取名，并填入「Application name」栏；并填写应用的网页地址「Homepage URL」。
-你需要将 `${your_logto_origin}/callback/${connector_id}` 填写到「Authorization callback URL」栏；「Application description」栏可以选择留白。`connector_id` 在管理控制台相应连接器的详情页的顶栏中可以找到。
-
-> 注意：如果登录时报错 `The redirect_uri MUST match the registered callback URL for this application.`，可以尝试将 Authorization Callback URL 和 Logto App 的 Redirect URL 保持严格一致（包括协议类型）以解决该问题。
-
-我们建议不要勾选「Enable Device Flow」，否则希望在移动设备上登录的用户需要在 GitHub 应用中确认登录的动作。许多 GitHub 用户在移动端设备上不会安装应用，这可能阻碍这些用户的登录流程。
-
-如果你的确期望终端用户在移动设备上需要有确认登录的动作，请忽略我们的建议。查看更多关于 [设备流程](https://docs.github.com/cn/developers/apps/building-oauth-apps/authorizing-oauth-apps#device-flow) 的详情。
-
-## 管理 OAuth 应用程序
-
-前往 [OAuth Apps](https://github.com/settings/developers)，你可以添加新应用或者修改、删除已存在的 _OAuth 应用程序_。
-
-在应用详情页，你能找到 `Client ID` 和 `Client secrets`（如果没有可以点击「Generate a new client secret」生成新的）。
-
-## 编写连接器的 JSON
-
-用你从上一步 OAuth 应用程序详情页获取到的 _Client ID_ 和 _Client Secret_ 分别填写 `clientId` 和 `clientSecret`。
-
-以下是一个 GitHub 连接器配置 JSON 的样例。
-
-```json
-{
-  "clientID": "<your-client-id>",
-  "clientSecret": "<your-client-secret>"
-}
-```
-
-### 配置类型
-
-| 名称         | 类型    |
-|--------------|--------|
-| clientId     | string |
-| clientSecret | string |
-
-## 测试 GitHub 连接器
-
-大功告成！GitHub 连接器现在可以正常使用了。
-别忘了 [在登录体验中启用本连接器](https://docs.logto.io/zh-cn/docs/tutorials/get-started/enable-social-sign-in/#%E5%9C%A8%E7%99%BB%E5%BD%95%E4%BD%93%E9%AA%8C%E4%B8%AD%E5%90%AF%E7%94%A8%E8%BF%9E%E6%8E%A5%E5%99%A8)。
-
-## 参考
-
-- [GitHub - 开发者 - 应用](https://docs.github.com/cn/developers/apps/getting-started-with-apps/about-apps)
-- [GitHub - 开发者 - 应用 - 创建 OAuth 应用程序](https://docs.github.com/cn/developers/apps/building-oauth-apps/creating-an-oauth-app)

package/lib/index.js

@@ -1,4 +1,4 @@
-import { ConnectorPlatform, ConnectorError, ConnectorErrorCodes, ConnectorType, validateConfig, parseJson } from '@logto/connector-kit';
+import { ConnectorPlatform, ConnectorConfigFormItemType, ConnectorError, ConnectorErrorCodes, ConnectorType, validateConfig, parseJson } from '@logto/connector-kit';
 import { got, HTTPError } from 'got';
 import { z } from 'zod';
 
@@ -660,7 +660,22 @@ const defaultMetadata = {
         ko: 'GitHub는 소프트웨어 개발과 버전 관리를 위한 온라인 커뮤니티입니다.',
     },
     readme: './README.md',
-    configTemplate: './docs/config-template.json',
+    formItems: [
+        {
+            key: 'clientId',
+            type: ConnectorConfigFormItemType.Text,
+            label: 'Client ID',
+            required: true,
+            placeholder: '<client-id>',
+        },
+        {
+            key: 'clientSecret',
+            type: ConnectorConfigFormItemType.Text,
+            label: 'Client Secret',
+            required: true,
+            placeholder: '<client-secret>',
+        },
+    ],
 };
 const defaultTimeout = 5000;
 

package/package.json

@@ -11,7 +11,7 @@
     "logo-dark.svg"
   ],
   "dependencies": {
-    "@logto/connector-kit": "1.0.0-rc.2",
+    "@logto/connector-kit": "1.0.0-rc.3",
     "@silverhand/essentials": "2.1.0",
     "got": "^12.5.3",
     "snakecase-keys": "^5.1.0",
@@ -52,7 +52,7 @@
     "access": "public"
   },
   "name": "@logto/connector-github",
-  "version": "1.0.0-beta.19",
+  "version": "1.0.0-beta.21",
   "description": "Github web connector implementation.",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "scripts": {

package/docs/config-template.json

@@ -1,4 +0,0 @@
-{
-  "clientId": "<client-id>",
-  "clientSecret": "<client-secret>"
-}