@logto/connector-dingtalk-web 0.0.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,144 @@
+# DingTalk Web Connector
+
+The official Logto connector for DingTalk social sign-in in web apps.
+
+钉钉 web 应用社交登录官方 Logto 连接器 [中文文档](#钉钉网页连接器)
+
+**Table of contents**
+
+- [DingTalk Web Connector](#dingtalk-web-connector)
+  - [Get Started](#get-started)
+  - [Create a Web App in the DingTalk Open Platform](#create-a-web-app-in-the-dingtalk-open-platform)
+    - [Register a DingTalk Developer Account](#register-a-dingtalk-developer-account)
+    - [Create an Application](#create-an-application)
+    - [Configure Permissions](#configure-permissions)
+  - [Configure Your Connector](#configure-your-connector)
+    - [Config Types](#config-types)
+  - [Test DingTalk Connector](#test-dingtalk-connector)
+  - [Support](#support)
+- [钉钉网页连接器](#钉钉网页连接器)
+  - [开始上手](#开始上手)
+  - [在钉钉开放平台新建一个应用](#在钉钉开放平台新建一个应用)
+    - [注册钉钉开发者账号](#注册钉钉开发者账号)
+    - [创建应用](#创建应用)
+    - [配置权限](#配置权限)
+  - [配置你的连接器](#配置你的连接器)
+    - [配置类型](#配置类型)
+  - [测试钉钉连接器](#测试钉钉连接器)
+  - [支持](#支持)
+
+## Get started
+
+The DingTalk web connector is designed for desktop web applications. It uses the OAuth 2.0 authentication flow.
+
+## Create a web app in the DingTalk Open Platform
+
+> 💡 **Tip**
+> 
+> You can skip some sections if you have already finished.
+
+### Register a DingTalk developer account
+
+If you do not have a DingTalk developer account, please register at the [DingTalk Open Platform](https://open.dingtalk.com).
+
+### Create an application
+
+1. In the [DingTalk Developer Console](https://open-dev.dingtalk.com/console/index), click "Create Application"
+2. Choose "Self-built Application", fill in the application name and basic information, and click "Create"
+3. In the left navigation bar, select "Development Configuration" -> "Security Settings", find and configure the "Redirect URL" `${your_logto_origin}/callback/${connector_id}`. You can find the `connector_id` on the connector details page after adding the respective connector in the management console
+4. In the left navigation bar, select "Basic Information" -> "Credentials and Basic Information" to get the "Client ID" and "Client Secret"
+5. In the left navigation bar, select "Application Release" -> "Version Management and Release", create and release the first version to activate the "Client ID" and "Client Secret"
+
+> ℹ️ **Note**
+> If the application does not release a version, the obtained "Client ID" and "Client Secret" cannot be used, or requests will fail.
+
+### Configure permissions
+
+1. In "Development Configuration" -> "Permission Management", select `Contact.User.Read` and `Contact.User.mobile` permissions and authorize them
+2. After confirming the permission configuration, click "Save" and publish the application
+
+## Configure your connector
+
+Fill out the `clientId` and `clientSecret` field with _Client ID(formerly AppKey and SuiteKey)_ and _Client Secret(formerly AppKey and SuiteKey)_ you've got from OAuth app detail pages mentioned in the previous section.
+
+`scope` currently supports two values: `openid` and `openid corpid`. `openid` allows obtaining the user's `userid` after authorization, while `openid corpid` allows obtaining both the user's `id` and the organization `id` selected during the login process. The values should be space-delimited. Note: URL encoding is required.
+
+### Config types
+
+| Name         | Type   |
+|--------------|--------|
+| clientId     | string |
+| clientSecret | string |
+| scope        | string |
+
+## Test DingTalk connector
+
+That's it. The DingTalk connector should be available now. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/passwordless-sign-in-by-adding-connectors#enable-social-sign-in).
+
+Once DingTalk web connector is enabled, you can sign in to your app again to see if it works.
+
+> ℹ️ **Note**
+> Please ensure strict compliance with the usage specifications and development guidelines of the DingTalk Open Platform during the development process.
+
+## Support
+
+If you have any questions or need further assistance, please visit the [DingTalk Developer Documentation](https://open.dingtalk.com/document/orgapp/obtain-identity-credentials) or contact DingTalk technical support.
+
+# 钉钉网页连接器
+
+## 开始上手
+
+钉钉网页连接器是为桌面网页应用设计的。它采用了 OAuth 2.0 认证流程。
+
+## 在钉钉开放平台新建一个应用
+
+> 💡 **Tip**
+> 
+> 你可以跳过已经完成的部分。
+
+### 注册钉钉开发者账号
+
+如果你还没有钉钉开发者账号，请在 [钉钉开放平台](https://open.dingtalk.com) 注册。
+
+### 创建应用
+
+1. 在 [钉钉开发者后台](https://open-dev.dingtalk.com/console/index) 中，点击「创建应用」
+2. 选择「自建应用」，填写应用名称和基本信息，点击「创建」
+3. 在左侧导航栏选择「开发配置」->「安全设置」，找到并配置「重定向 URL」 `${your_logto_origin}/callback/${connector_id}`。其中 `connector_id` 在管理控制台添加了相应的连接器之后，可以在连接器的详情页中找到
+4. 在左侧导航栏选择「基础信息」->「凭证与基础信息」中可以获取「Client ID」、「Client Secret」
+5. 在左侧导航栏选择「应用发布」->「版本管理与发布」，创建并发布第一个版本，以使「Client ID」、「Client Secret」生效
+
+> ℹ️ **Note**
+> 应用不发布版本，所获取的「Client ID」、「Client Secret」 均无法使用，或请求错误。
+
+### 配置权限
+
+1. 在「开发配置」->「权限管理」中，选择`通讯录个人信息读权限`和`个人手机号信息`权限并进行授权
+2. 确认权限配置后，点击「保存」并发布应用
+
+## 配置你的连接器
+
+在 clientId 和 clientSecret 字段中填入你在上一个部分中提到的 OAuth 应用详情页面获取的 Client ID(原 AppKey 和 SuiteKey) 和 Client Secret(原 AppKey 和 SuiteKey) 。
+
+scope 目前支持两种值：openid 和 openid corpid。openid 授权后可以获取用户的 userid，而 openid corpid 授权后可以获取用户的 id 和登录过程中用户选择的组织 id。这些值应以空格分隔。注意：需要进行 URL 编码。
+
+### 配置类型
+
+| Name         | Type   |
+|--------------|--------|
+| clientId     | string |
+| clientSecret | string |
+| scope        | string |
+
+## 测试钉钉连接器
+
+大功告成。别忘了 [在登录体验中启用本连接器](https://docs.logto.io/docs/tutorials/get-started/passwordless-sign-in-by-adding-connectors#enable-social-sign-in)。
+
+在钉钉web连接器启用后，你可以构建并运行你的应用看看是否生效。
+
+> ℹ️ **Note**
+> 请确保在开发过程中，严格遵守钉钉开放平台的使用规范和开发指南。
+
+## 支持
+
+如有任何问题或需进一步帮助，请访问 [钉钉开发者文档](https://open.dingtalk.com/document/orgapp/obtain-identity-credentials) 或联系钉钉技术支持。

package/lib/constant.d.ts

@@ -0,0 +1,7 @@
+import type { ConnectorMetadata } from '@logto/connector-kit';
+export declare const authorizationEndpoint = "https://login.dingtalk.com/oauth2/auth";
+export declare const accessTokenEndpoint = "https://api.dingtalk.com/v1.0/oauth2/userAccessToken";
+export declare const userInfoEndpoint = "https://api.dingtalk.com/v1.0/contact/users/me";
+export declare const scope = "openid";
+export declare const defaultMetadata: ConnectorMetadata;
+export declare const defaultTimeout = 5000;

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * DingTalk OAuth2 Connector
+ * https://open.dingtalk.com/document/orgapp/obtain-identity-credentials#title-4up-u8w-5ug
+ */
+import type { CreateConnector, SocialConnector } from '@logto/connector-kit';
+import type { DingtalkConfig } from './types.js';
+export declare const getAccessToken: (code: string, config: DingtalkConfig) => Promise<{
+    accessToken: string;
+}>;
+declare const createDingtalkConnector: CreateConnector<SocialConnector>;
+export default createDingtalkConnector;

package/lib/index.js

@@ -0,0 +1,177 @@
+import { got, HTTPError } from 'got';
+import { ConnectorPlatform, ConnectorConfigFormItemType, parseJson, ConnectorError, ConnectorErrorCodes, ConnectorType, validateConfig } from '@logto/connector-kit';
+import { z } from 'zod';
+
+// https://open.dingtalk.com/document/orgapp-server/use-dingtalk-account-to-log-on-to-third-party-websites-1
+const authorizationEndpoint = 'https://login.dingtalk.com/oauth2/auth';
+// https://open.dingtalk.com/document/isvapp/obtain-user-token
+const accessTokenEndpoint = 'https://api.dingtalk.com/v1.0/oauth2/userAccessToken';
+// https://open.dingtalk.com/document/isvapp/dingtalk-retrieve-user-information
+// To obtain the current authorized person's information, the unionId parameter can be set to "me".
+const userInfoEndpoint = 'https://api.dingtalk.com/v1.0/contact/users/me';
+const scope = 'openid';
+const defaultMetadata = {
+    id: 'dingtalk-web',
+    target: 'dingtalk',
+    platform: ConnectorPlatform.Web,
+    name: {
+        en: 'DingTalk',
+        'zh-CN': '钉钉',
+        'tr-TR': 'DingTalk',
+        ko: 'DingTalk',
+    },
+    logo: './logo.svg',
+    logoDark: null,
+    description: {
+        en: 'DingTalk is an enterprise-level intelligent mobile office platform launched by Alibaba Group.',
+        'zh-CN': '钉钉是一个由阿里巴巴集团推出的企业级智能移动办公平台。',
+        'tr-TR': 'DingTalk, Alibaba Grubu tarafından piyasaya sürülen kurumsal düzeyde akıllı mobil ofis platformudur.',
+        ko: '딩톡은 알리바바 그룹이 출시한 기업용 지능형 모바일 오피스 플랫폼입니다.',
+    },
+    readme: './README.md',
+    formItems: [
+        {
+            key: 'clientId',
+            label: 'Client ID',
+            required: true,
+            type: ConnectorConfigFormItemType.Text,
+            placeholder: '<client-id>',
+        },
+        {
+            key: 'clientSecret',
+            label: 'Client Secret',
+            required: true,
+            type: ConnectorConfigFormItemType.Text,
+            placeholder: '<client-secret>',
+        },
+        {
+            key: 'scope',
+            type: ConnectorConfigFormItemType.Text,
+            label: 'Scope',
+            required: false,
+            placeholder: '<scope>',
+            description: "The `scope` determines permissions granted by the user's authorization. If you are not sure what to enter, do not worry, just leave it blank.",
+        },
+    ],
+};
+const defaultTimeout = 5000;
+
+const dingtalkConfigGuard = z.object({
+    clientId: z.string(),
+    clientSecret: z.string(),
+    scope: z.string().optional(),
+});
+const accessTokenResponseGuard = z.object({
+    accessToken: z.string(),
+    refreshToken: z.string().optional(),
+    expireIn: z.number().optional(), // In seconds
+    corpId: z.string().optional(),
+});
+// https://open.dingtalk.com/document/isvapp/dingtalk-retrieve-user-information
+const userInfoResponseGuard = z.object({
+    nick: z.string().optional(),
+    avatarUrl: z.string().optional(),
+    mobile: z.string().optional(),
+    openId: z.string().optional(), // DingTalk no longer recommends using OpenId for integration. Instead, use unionId.
+    unionId: z.string(),
+    email: z.string().optional(),
+    stateCode: z.string().optional(),
+});
+const authResponseGuard = z.object({ code: z.string() });
+
+/**
+ * DingTalk OAuth2 Connector
+ * https://open.dingtalk.com/document/orgapp/obtain-identity-credentials#title-4up-u8w-5ug
+ */
+const getAuthorizationUri = (getConfig) => async ({ state, redirectUri }) => {
+    const config = await getConfig(defaultMetadata.id);
+    validateConfig(config, dingtalkConfigGuard);
+    const { clientId, scope: scope$1 } = config;
+    const queryParameters = new URLSearchParams({
+        client_id: clientId,
+        redirect_uri: encodeURI(redirectUri), // The variable `redirectUri` should match {clientId, clientSecret}
+        response_type: 'code',
+        scope: scope$1 ?? scope,
+        state,
+        prompt: 'consent',
+    });
+    return `${authorizationEndpoint}?${queryParameters.toString()}`;
+};
+const getAccessToken = async (code, config) => {
+    const { clientId, clientSecret } = config;
+    const httpResponse = await got.post(accessTokenEndpoint, {
+        json: {
+            clientId,
+            clientSecret,
+            code,
+            grantType: 'authorization_code',
+        },
+        timeout: { request: defaultTimeout },
+    });
+    const result = accessTokenResponseGuard.safeParse(parseJson(httpResponse.body));
+    if (!result.success) {
+        throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);
+    }
+    const { accessToken } = result.data;
+    return { accessToken };
+};
+const getUserInfo = (getConfig) => async (data) => {
+    const { code } = await authorizationCallbackHandler(data);
+    const config = await getConfig(defaultMetadata.id);
+    validateConfig(config, dingtalkConfigGuard);
+    const { accessToken } = await getAccessToken(code, config);
+    try {
+        const httpResponse = await got.get(userInfoEndpoint, {
+            headers: {
+                'x-acs-dingtalk-access-token': accessToken,
+            },
+            timeout: { request: defaultTimeout },
+        });
+        const rawData = parseJson(httpResponse.body);
+        const result = userInfoResponseGuard.safeParse(rawData);
+        if (!result.success) {
+            throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);
+        }
+        const { nick: name, avatarUrl: avatar, unionId: id, email, mobile, stateCode } = result.data;
+        return {
+            id,
+            avatar,
+            phone: stateCode && mobile ? `${stateCode}${mobile}` : undefined,
+            email,
+            name,
+            rawData,
+        };
+    }
+    catch (error) {
+        return getUserInfoErrorHandler(error);
+    }
+};
+const getUserInfoErrorHandler = (error) => {
+    // https://open.dingtalk.com/document/personalapp/error-code-2#title-m5s-krt-vds
+    if (error instanceof HTTPError) {
+        const { statusCode, body: rawBody } = error.response;
+        if (statusCode === 400) {
+            throw new ConnectorError(ConnectorErrorCodes.SocialAccessTokenInvalid);
+        }
+        throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(rawBody));
+    }
+    throw error;
+};
+const authorizationCallbackHandler = async (parameterObject) => {
+    const result = authResponseGuard.safeParse(parameterObject);
+    if (!result.success) {
+        throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(parameterObject));
+    }
+    return result.data;
+};
+const createDingtalkConnector = async ({ getConfig }) => {
+    return {
+        metadata: defaultMetadata,
+        type: ConnectorType.Social,
+        configGuard: dingtalkConfigGuard,
+        getAuthorizationUri: getAuthorizationUri(getConfig),
+        getUserInfo: getUserInfo(getConfig),
+    };
+};
+
+export { createDingtalkConnector as default, getAccessToken };

package/lib/mock.d.ts

@@ -0,0 +1,5 @@
+export declare const mockedConfig: {
+    clientId: string;
+    clientSecret: string;
+    scode: string;
+};

package/lib/types.d.ts

@@ -0,0 +1,65 @@
+import { z } from 'zod';
+export declare const dingtalkConfigGuard: z.ZodObject<{
+    clientId: z.ZodString;
+    clientSecret: z.ZodString;
+    scope: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    clientId: string;
+    clientSecret: string;
+    scope?: string | undefined;
+}, {
+    clientId: string;
+    clientSecret: string;
+    scope?: string | undefined;
+}>;
+export type DingtalkConfig = z.infer<typeof dingtalkConfigGuard>;
+export declare const accessTokenResponseGuard: z.ZodObject<{
+    accessToken: z.ZodString;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    expireIn: z.ZodOptional<z.ZodNumber>;
+    corpId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    accessToken: string;
+    refreshToken?: string | undefined;
+    expireIn?: number | undefined;
+    corpId?: string | undefined;
+}, {
+    accessToken: string;
+    refreshToken?: string | undefined;
+    expireIn?: number | undefined;
+    corpId?: string | undefined;
+}>;
+export declare const userInfoResponseGuard: z.ZodObject<{
+    nick: z.ZodOptional<z.ZodString>;
+    avatarUrl: z.ZodOptional<z.ZodString>;
+    mobile: z.ZodOptional<z.ZodString>;
+    openId: z.ZodOptional<z.ZodString>;
+    unionId: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    stateCode: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    unionId: string;
+    nick?: string | undefined;
+    avatarUrl?: string | undefined;
+    mobile?: string | undefined;
+    openId?: string | undefined;
+    email?: string | undefined;
+    stateCode?: string | undefined;
+}, {
+    unionId: string;
+    nick?: string | undefined;
+    avatarUrl?: string | undefined;
+    mobile?: string | undefined;
+    openId?: string | undefined;
+    email?: string | undefined;
+    stateCode?: string | undefined;
+}>;
+export type UserInfoResponse = z.infer<typeof userInfoResponseGuard>;
+export type UserInfoResponseMessageParser = (userInfo: Partial<UserInfoResponse>) => void;
+export declare const authResponseGuard: z.ZodObject<{
+    code: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    code: string;
+}, {
+    code: string;
+}>;

package/logo.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" image-rendering="optimizeSpeed">
+<path fill="#1791f5" d="M58.182 25.136a25.576 25.576 0 0 0-2.016-5.354 27.163 27.163 0 0 0-.704-1.282h-.001q-1.751-2.975-4.367-5.591C45.824 7.638 39.456 5 32 5S18.18 7.638 12.908 12.91C7.638 18.18 5 24.544 5 32c0 7.456 2.637 13.823 7.908 19.094 3.893 3.893 8.38 6.347 13.437 7.359A28.66 28.66 0 0 0 32 59c7.457 0 13.823-2.634 19.094-7.905 2.78-2.78 4.828-5.863 6.14-9.256.973-2.514 1.545-5.194 1.714-8.051.034-.584.052-1.181.052-1.788 0-2.388-.27-4.668-.818-6.864z"/>
+<path fill="#fff" d="M16.843 14.608c0 2.747.375 6.646 2.35 8.773 1.06 1.141 2.807 1.451 4.21 1.956 3.065 1.104 6.458 2.783 9.726 3.069l-4.298-.631-9.726-1.857c.02.98.219 1.805.59 2.714 2.43 5.974 8.3 4.75 13.66 4.75-2.02.614-4.245.687-6.333.968-.696.094-2.037.118-2.472.774-.733 1.104 1.34 2.622 2.02 3.175 2.967 2.411 5.932 1.95 9.273.511l-1.13 5.655h3.618l-1.81 8.143 4.243-5.428 4.805-6.56h-4.75c1.558-2.928 3.476-5.659 5.026-8.595.68-1.286 1.625-2.777 1.21-4.298-.648-2.369-4.876-3.41-6.914-4.11-5.601-1.92-11.023-4.17-16.512-6.373-2.143-.86-4.453-2.515-6.786-2.636z"/>
+</svg>

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@logto/connector-dingtalk-web",
+  "version": "0.0.0",
+  "description": "Dingtalk web connector implementation.",
+  "dependencies": {
+    "@logto/connector-kit": "^3.0.0",
+    "@silverhand/essentials": "^2.9.1",
+    "dayjs": "^1.10.5",
+    "got": "^14.0.0",
+    "iconv-lite": "^0.6.3",
+    "snakecase-keys": "^8.0.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@shopify/jest-koa-mocks": "^5.0.0",
+    "@silverhand/eslint-config": "6.0.1",
+    "@silverhand/ts-config": "6.0.0",
+    "@types/node": "^20.11.20",
+    "@types/supertest": "^6.0.2",
+    "@vitest/coverage-v8": "^1.4.0",
+    "eslint": "^8.56.0",
+    "lint-staged": "^15.0.2",
+    "nock": "^13.3.1",
+    "prettier": "^3.0.0",
+    "rollup": "^4.12.0",
+    "rollup-plugin-output-size": "^1.3.0",
+    "supertest": "^7.0.0",
+    "typescript": "^5.3.3",
+    "vitest": "^1.4.0"
+  },
+  "main": "./lib/index.js",
+  "module": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "license": "MPL-2.0",
+  "type": "module",
+  "files": [
+    "lib",
+    "docs",
+    "logo.svg",
+    "logo-dark.svg"
+  ],
+  "engines": {
+    "node": "^20.9.0"
+  },
+  "eslintConfig": {
+    "extends": "@silverhand",
+    "settings": {
+      "import/core-modules": [
+        "@silverhand/essentials",
+        "got",
+        "nock",
+        "snakecase-keys",
+        "zod"
+      ]
+    }
+  },
+  "prettier": "@silverhand/eslint-config/.prettierrc",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "precommit": "lint-staged",
+    "build:test": "rm -rf lib/ && tsc -p tsconfig.test.json --sourcemap",
+    "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
+    "dev": "tsc -p tsconfig.build.json --watch --preserveWatchOutput --incremental",
+    "lint": "eslint --ext .ts src",
+    "lint:report": "pnpm lint --format json --output-file report.json",
+    "test": "vitest src",
+    "test:ci": "pnpm run test --silent --coverage"
+  }
+}