npm - @logto/connector-dingtalk-web - Versions diffs - 0.1.0 → 0.2.0 - Mend

@logto/connector-dingtalk-web 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -12,6 +12,7 @@ The official Logto connector for DingTalk social sign-in in web apps.
     - [Register a DingTalk Developer Account](#register-a-dingtalk-developer-account)
     - [Create an Application](#create-an-application)
     - [Configure Permissions](#configure-permissions)
+    - [Release Application](#release-application)
   - [Configure Your Connector](#configure-your-connector)
     - [Config Types](#config-types)
   - [Test DingTalk Connector](#test-dingtalk-connector)
@@ -22,6 +23,7 @@ The official Logto connector for DingTalk social sign-in in web apps.
     - [注册钉钉开发者账号](#注册钉钉开发者账号)
     - [创建应用](#创建应用)
     - [配置权限](#配置权限)
+    - [应用发布](#应用发布)
   - [配置你的连接器](#配置你的连接器)
     - [配置类型](#配置类型)
   - [测试钉钉连接器](#测试钉钉连接器)
@@ -34,7 +36,6 @@ The DingTalk web connector is designed for desktop web applications. It uses the
 ## 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
@@ -43,19 +44,21 @@ If you do not have a DingTalk developer account, please register at the [DingTal
 ### 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.
+1. In the DingTalk Open Platform "[Application Development](https://open-dev.dingtalk.com/fe/app)" > "Internal Enterprise Application" > "DingTalk Application", click "Create Application"
+2. Fill in the **application name** and **description**, and click "Save"
+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`
 ### 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
+In "Development Configuration" > "Permission Management", select `Contact.User.Read` and `Contact.User.mobile` permissions and authorize them
+### Release Application
+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 your connector
@@ -73,7 +76,7 @@ Fill out the `clientId` and `clientSecret` field with _Client ID(formerly AppKey
 ## 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).
+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/recipes/configure-connectors/social-connector/enable-social-sign-in/).
 Once DingTalk web connector is enabled, you can sign in to your app again to see if it works.
@@ -93,7 +96,6 @@ If you have any questions or need further assistance, please visit the [DingTalk
 ## 在钉钉开放平台新建一个应用
 > 💡 **Tip**
->
 > 你可以跳过已经完成的部分。
 ### 注册钉钉开发者账号
@@ -102,25 +104,27 @@ If you have any questions or need further assistance, please visit the [DingTalk
 ### 创建应用
-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. 在 钉钉开放平台「[应用开发](https://open-dev.dingtalk.com/fe/app)」>「企业内部应用」>「钉钉应用」中，点击「创建应用」
+2. 填写**应用名称**和**应用描述**，点击「保存」
+3. 在左侧导航栏选择「开发配置」>「安全设置」，找到并配置「重定向 URL」 `${your_logto_origin}/callback/${connector_id}`。其中 `connector_id` 在管理控制台添加了相应的连接器之后，可以在连接器的详情页中找到
+4. 在左侧导航栏选择「基础信息」>「凭证与基础信息」中可以获取「Client ID」、「Client Secret」
 ### 配置权限
-1. 在「开发配置」->「权限管理」中，选择`通讯录个人信息读权限`和`个人手机号信息`权限并进行授权
-2. 确认权限配置后，点击「保存」并发布应用
+在「开发配置」>「权限管理」中，选择`通讯录个人信息读权限`和`个人手机号信息`权限并进行授权
+### 应用发布
+在左侧导航栏选择「应用发布」>「版本管理与发布」，点击「创建新版本」发布第一个版本，以使「Client ID」、「Client Secret」生效
+> ℹ️ **Note**
+> 应用不发布版本，所获取的「Client ID」、「Client Secret」 均无法使用，或请求错误。
 ## 配置你的连接器
-在 clientId 和 clientSecret 字段中填入你在上一个部分中提到的 OAuth 应用详情页面获取的 Client ID(原 AppKey 和 SuiteKey) 和 Client Secret(原 AppKey 和 SuiteKey) 。
+在 `clientId` 和 `clientSecret` 字段中填入你在上一个部分中提到的 OAuth 应用详情页面获取的 _Client ID_（原 AppKey 和 SuiteKey）和 _Client Secret_（原 AppKey 和 SuiteKey）。
-scope 目前支持两种值：openid 和 openid corpid。openid 授权后可以获取用户的 userid，而 openid corpid 授权后可以获取用户的 id 和登录过程中用户选择的组织 id。这些值应以空格分隔。注意：需要进行 URL 编码。
+`scope` 目前支持两种值：`openid` 和 `openid corpid`。`openid` 授权后可以获取用户的 `userid`，而 `openid corpid` 授权后可以获取用户的 `id` 和登录过程中用户选择的组织 `id`。这些值应以空格分隔。注意：需要进行 URL 编码。
 ### 配置类型
@@ -132,7 +136,7 @@ scope 目前支持两种值：openid 和 openid corpid。openid 授权后可以
 ## 测试钉钉连接器
-大功告成。别忘了 [在登录体验中启用本连接器](https://docs.logto.io/docs/tutorials/get-started/passwordless-sign-in-by-adding-connectors#enable-social-sign-in)。
+大功告成。别忘了 [在登录体验中启用本连接器](https://docs.logto.io/docs/recipes/configure-connectors/social-connector/enable-social-sign-in/)。
 在钉钉web连接器启用后，你可以构建并运行你的应用看看是否生效。

package/lib/index.js CHANGED Viewed

@@ -1,177 +1,184 @@
-import { got, HTTPError } from 'got';
-import { ConnectorPlatform, ConnectorConfigFormItemType, parseJson, ConnectorError, ConnectorErrorCodes, ConnectorType, validateConfig } from '@logto/connector-kit';
-import { z } from 'zod';
+// src/index.ts
+import { got, HTTPError } from "got";
+import {
+  ConnectorError,
+  ConnectorErrorCodes,
+  validateConfig,
+  ConnectorType,
+  parseJson
+} from "@logto/connector-kit";
-// 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',
+// src/constant.ts
+import { ConnectorConfigFormItemType, ConnectorPlatform } from "@logto/connector-kit";
+var authorizationEndpoint = "https://login.dingtalk.com/oauth2/auth";
+var accessTokenEndpoint = "https://api.dingtalk.com/v1.0/oauth2/userAccessToken";
+var userInfoEndpoint = "https://api.dingtalk.com/v1.0/contact/users/me";
+var scope = "openid";
+var defaultMetadata = {
+  id: "dingtalk-web",
+  target: "dingtalk",
+  platform: ConnectorPlatform.Web,
+  name: {
+    en: "DingTalk",
+    "zh-CN": "\u9489\u9489",
+    "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": "\u9489\u9489\u662F\u4E00\u4E2A\u7531\u963F\u91CC\u5DF4\u5DF4\u96C6\u56E2\u63A8\u51FA\u7684\u4F01\u4E1A\u7EA7\u667A\u80FD\u79FB\u52A8\u529E\u516C\u5E73\u53F0\u3002",
+    "tr-TR": "DingTalk, Alibaba Grubu taraf\u0131ndan piyasaya s\xFCr\xFClen kurumsal d\xFCzeyde ak\u0131ll\u0131 mobil ofis platformudur.",
+    ko: "\uB529\uD1A1\uC740 \uC54C\uB9AC\uBC14\uBC14 \uADF8\uB8F9\uC774 \uCD9C\uC2DC\uD55C \uAE30\uC5C5\uC6A9 \uC9C0\uB2A5\uD615 \uBAA8\uBC14\uC77C \uC624\uD53C\uC2A4 \uD50C\uB7AB\uD3FC\uC785\uB2C8\uB2E4."
+  },
+  readme: "./README.md",
+  formItems: [
+    {
+      key: "clientId",
+      label: "Client ID",
+      required: true,
+      type: ConnectorConfigFormItemType.Text,
+      placeholder: "<client-id>"
     },
-    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: '딩톡은 알리바바 그룹이 출시한 기업용 지능형 모바일 오피스 플랫폼입니다.',
+    {
+      key: "clientSecret",
+      label: "Client Secret",
+      required: true,
+      type: ConnectorConfigFormItemType.Text,
+      placeholder: "<client-secret>"
     },
-    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.",
-        },
-    ],
+    {
+      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;
+var defaultTimeout = 5e3;
-const dingtalkConfigGuard = z.object({
-    clientId: z.string(),
-    clientSecret: z.string(),
-    scope: z.string().optional(),
+// src/types.ts
+import { z } from "zod";
+var 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(),
+var 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(),
+var 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() });
+var 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()}`;
+// src/index.ts
+var getAuthorizationUri = (getConfig) => async ({ state, redirectUri }) => {
+  const config = await getConfig(defaultMetadata.id);
+  validateConfig(config, dingtalkConfigGuard);
+  const { clientId, scope: scope2 } = config;
+  const queryParameters = new URLSearchParams({
+    client_id: clientId,
+    redirect_uri: encodeURI(redirectUri),
+    // The variable `redirectUri` should match {clientId, clientSecret}
+    response_type: "code",
+    scope: scope2 ?? scope,
+    state,
+    prompt: "consent"
+  });
+  return `${authorizationEndpoint}?${queryParameters.toString()}`;
+};
+var 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 getAccessToken = async (code, config) => {
-    const { clientId, clientSecret } = config;
-    const httpResponse = await got.post(accessTokenEndpoint, {
-        json: {
-            clientId,
-            clientSecret,
-            code,
-            grantType: 'authorization_code',
-        },
-        timeout: { request: defaultTimeout },
+var 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 result = accessTokenResponseGuard.safeParse(parseJson(httpResponse.body));
+    const rawData = parseJson(httpResponse.body);
+    const result = userInfoResponseGuard.safeParse(rawData);
     if (!result.success) {
-        throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);
+      throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);
     }
-    const { accessToken } = result.data;
-    return { accessToken };
+    const { nick: name, avatarUrl: avatar, unionId: id, email, mobile, stateCode } = result.data;
+    return {
+      id,
+      avatar,
+      phone: stateCode && mobile ? `${stateCode}${mobile}` : void 0,
+      email,
+      name,
+      rawData
+    };
+  } catch (error) {
+    return getUserInfoErrorHandler(error);
+  }
 };
-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);
+var getUserInfoErrorHandler = (error) => {
+  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 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;
+var authorizationCallbackHandler = async (parameterObject) => {
+  const result = authResponseGuard.safeParse(parameterObject);
+  if (!result.success) {
+    throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(parameterObject));
+  }
+  return result.data;
 };
-const authorizationCallbackHandler = async (parameterObject) => {
-    const result = authResponseGuard.safeParse(parameterObject);
-    if (!result.success) {
-        throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(parameterObject));
-    }
-    return result.data;
+var createDingtalkConnector = async ({ getConfig }) => {
+  return {
+    metadata: defaultMetadata,
+    type: ConnectorType.Social,
+    configGuard: dingtalkConfigGuard,
+    getAuthorizationUri: getAuthorizationUri(getConfig),
+    getUserInfo: getUserInfo(getConfig)
+  };
 };
-const createDingtalkConnector = async ({ getConfig }) => {
-    return {
-        metadata: defaultMetadata,
-        type: ConnectorType.Social,
-        configGuard: dingtalkConfigGuard,
-        getAuthorizationUri: getAuthorizationUri(getConfig),
-        getUserInfo: getUserInfo(getConfig),
-    };
+var src_default = createDingtalkConnector;
+export {
+  src_default as default,
+  getAccessToken
 };
-export { createDingtalkConnector as default, getAccessToken };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../src/index.ts","../src/constant.ts","../src/types.ts"],"sourcesContent":["/**\n * DingTalk OAuth2 Connector\n * https://open.dingtalk.com/document/orgapp/obtain-identity-credentials#title-4up-u8w-5ug\n */\n\nimport { got, HTTPError } from 'got';\n\nimport type {\n GetAuthorizationUri,\n GetUserInfo,\n GetConnectorConfig,\n CreateConnector,\n SocialConnector,\n} from '@logto/connector-kit';\nimport {\n ConnectorError,\n ConnectorErrorCodes,\n validateConfig,\n ConnectorType,\n parseJson,\n} from '@logto/connector-kit';\n\nimport {\n authorizationEndpoint,\n accessTokenEndpoint,\n userInfoEndpoint,\n scope as defaultScope,\n defaultMetadata,\n defaultTimeout,\n} from './constant.js';\nimport type { DingtalkConfig } from './types.js';\nimport {\n dingtalkConfigGuard,\n accessTokenResponseGuard,\n userInfoResponseGuard,\n authResponseGuard,\n} from './types.js';\n\nconst getAuthorizationUri =\n (getConfig: GetConnectorConfig): GetAuthorizationUri =>\n async ({ state, redirectUri }) => {\n const config = await getConfig(defaultMetadata.id);\n validateConfig(config, dingtalkConfigGuard);\n\n const { clientId, scope } = config;\n\n const queryParameters = new URLSearchParams({\n client_id: clientId,\n redirect_uri: encodeURI(redirectUri), // The variable `redirectUri` should match {clientId, clientSecret}\n response_type: 'code',\n scope: scope ?? defaultScope,\n state,\n prompt: 'consent',\n });\n\n return `${authorizationEndpoint}?${queryParameters.toString()}`;\n };\n\nexport const getAccessToken = async (\n code: string,\n config: DingtalkConfig\n): Promise<{ accessToken: string }> => {\n const { clientId, clientSecret } = config;\n\n const httpResponse = await got.post(accessTokenEndpoint, {\n json: {\n clientId,\n clientSecret,\n code,\n grantType: 'authorization_code',\n },\n timeout: { request: defaultTimeout },\n });\n\n const result = accessTokenResponseGuard.safeParse(parseJson(httpResponse.body));\n\n if (!result.success) {\n throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);\n }\n\n const { accessToken } = result.data;\n\n return { accessToken };\n};\n\nconst getUserInfo =\n (getConfig: GetConnectorConfig): GetUserInfo =>\n async (data) => {\n const { code } = await authorizationCallbackHandler(data);\n const config = await getConfig(defaultMetadata.id);\n validateConfig(config, dingtalkConfigGuard);\n const { accessToken } = await getAccessToken(code, config);\n\n try {\n const httpResponse = await got.get(userInfoEndpoint, {\n headers: {\n 'x-acs-dingtalk-access-token': accessToken,\n },\n timeout: { request: defaultTimeout },\n });\n const rawData = parseJson(httpResponse.body);\n const result = userInfoResponseGuard.safeParse(rawData);\n\n if (!result.success) {\n throw new ConnectorError(ConnectorErrorCodes.InvalidResponse, result.error);\n }\n\n const { nick: name, avatarUrl: avatar, unionId: id, email, mobile, stateCode } = result.data;\n return {\n id,\n avatar,\n phone: stateCode && mobile ? `${stateCode}${mobile}` : undefined,\n email,\n name,\n rawData,\n };\n } catch (error: unknown) {\n return getUserInfoErrorHandler(error);\n }\n };\n\nconst getUserInfoErrorHandler = (error: unknown) => {\n // https://open.dingtalk.com/document/personalapp/error-code-2#title-m5s-krt-vds\n if (error instanceof HTTPError) {\n const { statusCode, body: rawBody } = error.response;\n\n if (statusCode === 400) {\n throw new ConnectorError(ConnectorErrorCodes.SocialAccessTokenInvalid);\n }\n\n throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(rawBody));\n }\n\n throw error;\n};\n\nconst authorizationCallbackHandler = async (parameterObject: unknown) => {\n const result = authResponseGuard.safeParse(parameterObject);\n\n if (!result.success) {\n throw new ConnectorError(ConnectorErrorCodes.General, JSON.stringify(parameterObject));\n }\n\n return result.data;\n};\n\nconst createDingtalkConnector: CreateConnector<SocialConnector> = async ({ getConfig }) => {\n return {\n metadata: defaultMetadata,\n type: ConnectorType.Social,\n configGuard: dingtalkConfigGuard,\n getAuthorizationUri: getAuthorizationUri(getConfig),\n getUserInfo: getUserInfo(getConfig),\n };\n};\n\nexport default createDingtalkConnector;\n","import type { ConnectorMetadata } from '@logto/connector-kit';\nimport { ConnectorConfigFormItemType, ConnectorPlatform } from '@logto/connector-kit';\n\n// https://open.dingtalk.com/document/orgapp-server/use-dingtalk-account-to-log-on-to-third-party-websites-1\nexport const authorizationEndpoint = 'https://login.dingtalk.com/oauth2/auth';\n// https://open.dingtalk.com/document/isvapp/obtain-user-token\nexport const accessTokenEndpoint = 'https://api.dingtalk.com/v1.0/oauth2/userAccessToken';\n// https://open.dingtalk.com/document/isvapp/dingtalk-retrieve-user-information\n// To obtain the current authorized person's information, the unionId parameter can be set to \"me\".\nexport const userInfoEndpoint = 'https://api.dingtalk.com/v1.0/contact/users/me';\nexport const scope = 'openid';\n\nexport const defaultMetadata: ConnectorMetadata = {\n id: 'dingtalk-web',\n target: 'dingtalk',\n platform: ConnectorPlatform.Web,\n name: {\n en: 'DingTalk',\n 'zh-CN': '钉钉',\n 'tr-TR': 'DingTalk',\n ko: 'DingTalk',\n },\n logo: './logo.svg',\n logoDark: null,\n description: {\n en: 'DingTalk is an enterprise-level intelligent mobile office platform launched by Alibaba Group.',\n 'zh-CN': '钉钉是一个由阿里巴巴集团推出的企业级智能移动办公平台。',\n 'tr-TR':\n 'DingTalk, Alibaba Grubu tarafından piyasaya sürülen kurumsal düzeyde akıllı mobil ofis platformudur.',\n ko: '딩톡은 알리바바 그룹이 출시한 기업용 지능형 모바일 오피스 플랫폼입니다.',\n },\n readme: './README.md',\n formItems: [\n {\n key: 'clientId',\n label: 'Client ID',\n required: true,\n type: ConnectorConfigFormItemType.Text,\n placeholder: '<client-id>',\n },\n {\n key: 'clientSecret',\n label: 'Client Secret',\n required: true,\n type: ConnectorConfigFormItemType.Text,\n placeholder: '<client-secret>',\n },\n {\n key: 'scope',\n type: ConnectorConfigFormItemType.Text,\n label: 'Scope',\n required: false,\n placeholder: '<scope>',\n description:\n \"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.\",\n },\n ],\n};\n\nexport const defaultTimeout = 5000;\n","import { z } from 'zod';\n\nexport const dingtalkConfigGuard = z.object({\n clientId: z.string(),\n clientSecret: z.string(),\n scope: z.string().optional(),\n});\n\nexport type DingtalkConfig = z.infer<typeof dingtalkConfigGuard>;\n\nexport const accessTokenResponseGuard = z.object({\n accessToken: z.string(),\n refreshToken: z.string().optional(),\n expireIn: z.number().optional(), // In seconds\n corpId: z.string().optional(),\n});\n\n// https://open.dingtalk.com/document/isvapp/dingtalk-retrieve-user-information\nexport const userInfoResponseGuard = z.object({\n nick: z.string().optional(),\n avatarUrl: z.string().optional(),\n mobile: z.string().optional(),\n openId: z.string().optional(), // DingTalk no longer recommends using OpenId for integration. Instead, use unionId.\n unionId: z.string(),\n email: z.string().optional(),\n stateCode: z.string().optional(),\n});\n\nexport type UserInfoResponse = z.infer<typeof userInfoResponseGuard>;\n\nexport type UserInfoResponseMessageParser = (userInfo: Partial<UserInfoResponse>) => void;\n\nexport const authResponseGuard = z.object({ code: z.string() });\n"],"mappings":";AAKA,SAAS,KAAK,iBAAiB;AAS/B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;;;ACnBP,SAAS,6BAA6B,yBAAyB;AAGxD,IAAM,wBAAwB;AAE9B,IAAM,sBAAsB;AAG5B,IAAM,mBAAmB;AACzB,IAAM,QAAQ;AAEd,IAAM,kBAAqC;AAAA,EAChD,IAAI;AAAA,EACJ,QAAQ;AAAA,EACR,UAAU,kBAAkB;AAAA,EAC5B,MAAM;AAAA,IACJ,IAAI;AAAA,IACJ,SAAS;AAAA,IACT,SAAS;AAAA,IACT,IAAI;AAAA,EACN;AAAA,EACA,MAAM;AAAA,EACN,UAAU;AAAA,EACV,aAAa;AAAA,IACX,IAAI;AAAA,IACJ,SAAS;AAAA,IACT,SACE;AAAA,IACF,IAAI;AAAA,EACN;AAAA,EACA,QAAQ;AAAA,EACR,WAAW;AAAA,IACT;AAAA,MACE,KAAK;AAAA,MACL,OAAO;AAAA,MACP,UAAU;AAAA,MACV,MAAM,4BAA4B;AAAA,MAClC,aAAa;AAAA,IACf;AAAA,IACA;AAAA,MACE,KAAK;AAAA,MACL,OAAO;AAAA,MACP,UAAU;AAAA,MACV,MAAM,4BAA4B;AAAA,MAClC,aAAa;AAAA,IACf;AAAA,IACA;AAAA,MACE,KAAK;AAAA,MACL,MAAM,4BAA4B;AAAA,MAClC,OAAO;AAAA,MACP,UAAU;AAAA,MACV,aAAa;AAAA,MACb,aACE;AAAA,IACJ;AAAA,EACF;AACF;AAEO,IAAM,iBAAiB;;;AC3D9B,SAAS,SAAS;AAEX,IAAM,sBAAsB,EAAE,OAAO;AAAA,EAC1C,UAAU,EAAE,OAAO;AAAA,EACnB,cAAc,EAAE,OAAO;AAAA,EACvB,OAAO,EAAE,OAAO,EAAE,SAAS;AAC7B,CAAC;AAIM,IAAM,2BAA2B,EAAE,OAAO;AAAA,EAC/C,aAAa,EAAE,OAAO;AAAA,EACtB,cAAc,EAAE,OAAO,EAAE,SAAS;AAAA,EAClC,UAAU,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAC9B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAC9B,CAAC;AAGM,IAAM,wBAAwB,EAAE,OAAO;AAAA,EAC5C,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA,EAC1B,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA,EAC/B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAC5B,SAAS,EAAE,OAAO;AAAA,EAClB,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,WAAW,EAAE,OAAO,EAAE,SAAS;AACjC,CAAC;AAMM,IAAM,oBAAoB,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;;;AFM9D,IAAM,sBACJ,CAAC,cACD,OAAO,EAAE,OAAO,YAAY,MAAM;AAChC,QAAM,SAAS,MAAM,UAAU,gBAAgB,EAAE;AACjD,iBAAe,QAAQ,mBAAmB;AAE1C,QAAM,EAAE,UAAU,OAAAA,OAAM,IAAI;AAE5B,QAAM,kBAAkB,IAAI,gBAAgB;AAAA,IAC1C,WAAW;AAAA,IACX,cAAc,UAAU,WAAW;AAAA;AAAA,IACnC,eAAe;AAAA,IACf,OAAOA,UAAS;AAAA,IAChB;AAAA,IACA,QAAQ;AAAA,EACV,CAAC;AAED,SAAO,GAAG,qBAAqB,IAAI,gBAAgB,SAAS,CAAC;AAC/D;AAEK,IAAM,iBAAiB,OAC5B,MACA,WACqC;AACrC,QAAM,EAAE,UAAU,aAAa,IAAI;AAEnC,QAAM,eAAe,MAAM,IAAI,KAAK,qBAAqB;AAAA,IACvD,MAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA,WAAW;AAAA,IACb;AAAA,IACA,SAAS,EAAE,SAAS,eAAe;AAAA,EACrC,CAAC;AAED,QAAM,SAAS,yBAAyB,UAAU,UAAU,aAAa,IAAI,CAAC;AAE9E,MAAI,CAAC,OAAO,SAAS;AACnB,UAAM,IAAI,eAAe,oBAAoB,iBAAiB,OAAO,KAAK;AAAA,EAC5E;AAEA,QAAM,EAAE,YAAY,IAAI,OAAO;AAE/B,SAAO,EAAE,YAAY;AACvB;AAEA,IAAM,cACJ,CAAC,cACD,OAAO,SAAS;AACd,QAAM,EAAE,KAAK,IAAI,MAAM,6BAA6B,IAAI;AACxD,QAAM,SAAS,MAAM,UAAU,gBAAgB,EAAE;AACjD,iBAAe,QAAQ,mBAAmB;AAC1C,QAAM,EAAE,YAAY,IAAI,MAAM,eAAe,MAAM,MAAM;AAEzD,MAAI;AACF,UAAM,eAAe,MAAM,IAAI,IAAI,kBAAkB;AAAA,MACnD,SAAS;AAAA,QACP,+BAA+B;AAAA,MACjC;AAAA,MACA,SAAS,EAAE,SAAS,eAAe;AAAA,IACrC,CAAC;AACD,UAAM,UAAU,UAAU,aAAa,IAAI;AAC3C,UAAM,SAAS,sBAAsB,UAAU,OAAO;AAEtD,QAAI,CAAC,OAAO,SAAS;AACnB,YAAM,IAAI,eAAe,oBAAoB,iBAAiB,OAAO,KAAK;AAAA,IAC5E;AAEA,UAAM,EAAE,MAAM,MAAM,WAAW,QAAQ,SAAS,IAAI,OAAO,QAAQ,UAAU,IAAI,OAAO;AACxF,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,OAAO,aAAa,SAAS,GAAG,SAAS,GAAG,MAAM,KAAK;AAAA,MACvD;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF,SAAS,OAAgB;AACvB,WAAO,wBAAwB,KAAK;AAAA,EACtC;AACF;AAEF,IAAM,0BAA0B,CAAC,UAAmB;AAElD,MAAI,iBAAiB,WAAW;AAC9B,UAAM,EAAE,YAAY,MAAM,QAAQ,IAAI,MAAM;AAE5C,QAAI,eAAe,KAAK;AACtB,YAAM,IAAI,eAAe,oBAAoB,wBAAwB;AAAA,IACvE;AAEA,UAAM,IAAI,eAAe,oBAAoB,SAAS,KAAK,UAAU,OAAO,CAAC;AAAA,EAC/E;AAEA,QAAM;AACR;AAEA,IAAM,+BAA+B,OAAO,oBAA6B;AACvE,QAAM,SAAS,kBAAkB,UAAU,eAAe;AAE1D,MAAI,CAAC,OAAO,SAAS;AACnB,UAAM,IAAI,eAAe,oBAAoB,SAAS,KAAK,UAAU,eAAe,CAAC;AAAA,EACvF;AAEA,SAAO,OAAO;AAChB;AAEA,IAAM,0BAA4D,OAAO,EAAE,UAAU,MAAM;AACzF,SAAO;AAAA,IACL,UAAU;AAAA,IACV,MAAM,cAAc;AAAA,IACpB,aAAa;AAAA,IACb,qBAAqB,oBAAoB,SAAS;AAAA,IAClD,aAAa,YAAY,SAAS;AAAA,EACpC;AACF;AAEA,IAAO,cAAQ;","names":["scope"]}

package/package.json CHANGED Viewed

@@ -1,36 +1,31 @@
 {
   "name": "@logto/connector-dingtalk-web",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Dingtalk web connector implementation.",
   "dependencies": {
-    "@logto/connector-kit": "^3.0.0",
+    "@logto/connector-kit": "^4.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"
+    "snakecase-keys": "^8.0.1",
+    "zod": "^3.23.8"
   },
   "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",
+    "@vitest/coverage-v8": "^2.0.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"
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.3",
+    "vitest": "^2.0.0"
   },
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -64,9 +59,9 @@
   },
   "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",
+    "check": "tsc --noEmit",
+    "build": "tsup",
+    "dev": "tsup --watch",
     "lint": "eslint --ext .ts src",
     "lint:report": "pnpm lint --format json --output-file report.json",
     "test": "vitest src",

package/lib/constant.d.ts DELETED Viewed

@@ -1,7 +0,0 @@
-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 DELETED Viewed

@@ -1,11 +0,0 @@
-/**
- * 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/mock.d.ts DELETED Viewed

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

package/lib/types.d.ts DELETED Viewed

@@ -1,65 +0,0 @@
-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;
-}>;