@logto/connector-aws-ses 1.0.0-beta.19 → 1.0.0-beta.20

package/README.md

@@ -2,31 +2,20 @@
 
 The official Logto connector for AWS connector for direct mail service.
 
-Amazon SES邮件推送服务 Logto 官方连接器[中文文档](#aws-ses邮件连接器)
-
 - [AWS direct mail connector](#aws-direct-mail-connector)
   - [Get started](#get-started)
   - [Configure a mail service in the AWS service console](#configure-a-mail-service-in-the-aws-service-console)
     - [Register AWS account](#register-aws-account)
     - [Create a identity](#create-a-identity)
-    - [Edit the JSON of the connector](#edit-the-json-of-the-connector)
+    - [Configuration of the connector](#configuration-of-the-connector)
     - [Test the Amazon SES connector](#test-the-amazon-ses-connector)
     - [Configure types](#configure-types)
-- [AWS SES 邮件连接器](#aws-ses-邮件连接器)
-  - [开始上手](#开始上手)
-  - [在 AWS 服务控制台中配置一个邮件服务](#在-aws-服务控制台中配置一个邮件服务)
-    - [注册 AWS 帐号](#注册-aws-帐号)
-    - [创建发信身份](#创建发信身份)
-  - [编写连接器的 JSON](#编写连接器的-json)
-    - [测试 Amazon SES 邮件连接器](#测试-amazon-ses-邮件连接器)
-    - [配置类型](#配置类型)
 
 ## Get started
 Amazon SES is a cloud email service provider that can integrate into any application for bulk email sending.
 
 Logto team to call the Amazon Simple Email Service APIs, with the help of which Logto end-users can register and sign in to their Logto account via mail verification code.
 
-
 ## Configure a mail service in the AWS service console
 
 > 💡 **Tip**
@@ -45,7 +34,7 @@ Go to [AWS](https://aws.amazon.com/) and register an account.
   - Create an email address
 
 
-### Edit the JSON of the connector
+### Configuration of the connector
 
 1. Click your username in the upper right corner of the Amazon console to enter `Security Credentials`. If you don't have one, create an `AccessKey` and save it carefully.
 2. Complete the settings of the `Amazon Simple Email Service` connector:
@@ -59,45 +48,6 @@ the following parameters are optional; parameters description can be found in th
 - `feedbackForwardingEmailAddressIdentityArn`
 - `configurationSetName`
 
-Here is an example of the JSON of the `Amazon SES` connector:
-
-```json
-{
-  "accessKeyId": "<access-key-id>",
-  "accessKeySecret": "<access-key-secret>",
-  "region": "<region>",
-  "emailAddress": "<noreply@logto.io>",
-  "templates": [
-    {
-      "usageType": "SignIn",
-      "subject": "<sign-in-template-subject>",
-      "content": "<sign-in-template-content>"
-    },
-    {
-      "usageType": "Register",
-      "subject": "<register-template-subject>",
-      "content": "<register-template-content>"
-    },
-    {
-      "usageType": "ForgotPassword",
-      "subject": "<forgot-password-template-subject>",
-      "content": "<forgot-password-template-content>"
-    },
-    {
-      "usageType": "Generic",
-      "subject": "<generic-template-subject>",
-      "content": "<generic-template-content>"
-    },
-    {
-      "usageType": "Test",
-      "subject": "<test-template-subject>",
-      "content": "<test-template-content>"
-    }
-  ]
-}
-
-```
-
 ### Test the Amazon SES connector
 
 You can type in an email address and click on "Send" to see whether the settings work before "Save and Done".
@@ -123,107 +73,3 @@ That's it. Don't forget to [Enable connector in sign-in experience](https://docs
 | subject             | string      | N/A                                                  |
 | content             | string      | N/A                                                  |
 | usageType           | enum string | 'Register' \| 'SignIn' \| 'ForgotPassword' \| 'Generic' \| 'Test' |
-
-
-# AWS SES 邮件连接器
-
-## 开始上手
-
-Amazon SES 是云电子邮件发送服务，它可以集成到任何应用程序中，用于批量发送电子邮件。
-
-本连接器是 Logto 官方提供的 Amazon SES 邮件连接器，帮助终端用户通过邮件验证码进行登录注册。
-
-## 在 AWS 服务控制台中配置一个邮件服务
-
-> 💡 **Tip**
-> 
-> 你可以跳过已经完成的部分。
-
-### 注册 AWS 帐号
-
-前往 [AWS](https://aws.amazon.com/) 并完成帐号的注册。
-
-### 创建发信身份
-
-- 进入 `Amazon Simple Email Service` Console
-- 创建发信身份，根据需要，以下任选一种
-  - 创建域
-  - 电子邮件地址
-
-## 编写连接器的 JSON
-
-1. 在 Amazon 控制台右上角点击你的用户名，进入`安全凭证`，如果你没有，请创建 `AccessKey`，并妥善保存
-2. 完成 `Amazon Simple Email Service` 连接器的设置：
-    - 使用在步骤 1 中拿到的一对「AccessKey ID」和「AccessKey Secret」来分别填入 `accessKeyId` 和 `accessKeySecret`
-    - `region`：使用发信身份所在的 region 填入`region` 字段
-    - `emailAddress`：发信人邮箱地址，格式：`Logto<noreply@logto.io>`，也可以仅使用 `<noreply@logto.io>`
-
-以下参数通常不需要配置，除非你明确知道你需要做什么；参数的含义可以参考 [AWS SES DOC](https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_SendEmail.html)。
-- `feedbackForwardingEmailAddress`
-- `feedbackForwardingEmailAddressIdentityArn`
-- `configurationSetName`
-
-这是一个 Amazon SES 邮件服务连接器 JSON 配置的样例。
-
-```json
-{
-  "accessKeyId": "<access-key-id>",
-  "accessKeySecret": "<access-key-secret>",
-  "region": "<region>",
-  "emailAddress": "<noreply@logto.io>",
-  "templates": [
-    {
-      "usageType": "SignIn",
-      "subject": "<sign-in-template-subject>",
-      "content": "<sign-in-template-content>"
-    },
-    {
-      "usageType": "Register",
-      "subject": "<register-template-subject>",
-      "content": "<register-template-content>"
-    },
-    {
-      "usageType": "ForgotPassword",
-      "subject": "<forgot-password-template-subject>",
-      "content": "<forgot-password-template-content>"
-    },
-    {
-      "usageType": "Generic",
-      "subject": "<generic-template-subject>",
-      "content": "<generic-template-content>"
-    },
-    {
-      "usageType": "Test",
-      "subject": "<test-template-subject>",
-      "content": "<test-template-content>"
-    }
-  ]
-}
-
-```
-
-### 测试 Amazon SES 邮件连接器
-
-你可以在「保存并完成」之前输入一个邮件地址并点按「发送」来测试配置是否可以正常工作。
-
-大功告成！快去 [启用短信或邮件验证码登录](https://docs.logto.io/zh-cn/docs/tutorials/get-started/enable-passcode-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) 吧。
-
-### 配置类型
-
-| 名称                                      | 类型              |
-| ----------------------------------------- | ----------------- |
-| accessKeyId                               | string            |
-| accessKeySecret                           | string            |
-| region                                    | string            |
-| emailAddress                              | string (OPTIONAL) |
-| emailAddressIdentityArn                   | string (OPTIONAL) |
-| feedbackForwardingEmailAddress            | string (OPTIONAL) |
-| feedbackForwardingEmailAddressIdentityArn | string (OPTIONAL) |
-| configurationSetName                      | string (OPTIONAL) |
-| templates                                 | Template[]        |
-
-| 模板属性  | 类型        | 枚举值                                                  |
-| --------- | ----------- | -----------------------------------------------------|
-| subject   | string      | N/A                                                  |
-| content   | string      | N/A                                                  |
-| usageType | enum string | 'Register' \| 'SignIn' \| 'ForgotPassword' \| 'Generic' \| 'Test' |

package/lib/index.js

@@ -11,7 +11,7 @@ import { Agent as Agent$1, request as request$1 } from 'https';
 import { Readable, Writable } from 'stream';
 import 'http2';
 import { versions, env } from 'process';
-import { ConnectorType, validateConfig, ConnectorError, ConnectorErrorCodes } from '@logto/connector-kit';
+import { ConnectorConfigFormItemType, ConnectorType, validateConfig, ConnectorError, ConnectorErrorCodes } from '@logto/connector-kit';
 import { z } from 'zod';
 
 const resolveParamsForS3 = async (endpointParams) => {
@@ -11654,7 +11654,97 @@ const defaultMetadata = {
         ko: 'Amazon SES는 모든 애플리케이션에 통합하여 대량으로 이메일을 전송할 수 있는 클라우드 이메일 서비스 공급자입니다.',
     },
     readme: './README.md',
-    configTemplate: './docs/config-template.json',
+    formItems: [
+        {
+            key: 'accessKeyId',
+            label: 'Access Key ID',
+            type: ConnectorConfigFormItemType.Text,
+            required: true,
+            placeholder: '<access-key-id>',
+        },
+        {
+            key: 'accessKeySecret',
+            label: 'Access Key Secret',
+            type: ConnectorConfigFormItemType.Text,
+            required: true,
+            placeholder: '<access-key-secret>',
+        },
+        {
+            key: 'region',
+            label: 'Region',
+            type: ConnectorConfigFormItemType.Text,
+            required: true,
+            placeholder: '<region>',
+        },
+        {
+            key: 'emailAddress',
+            label: 'Email Address',
+            type: ConnectorConfigFormItemType.Text,
+            required: false,
+            placeholder: '<email-address>',
+        },
+        {
+            key: 'emailAddressIdentityArn',
+            label: 'Email Address Identity ARN',
+            type: ConnectorConfigFormItemType.Text,
+            required: false,
+            placeholder: '<email-address-identity-arn>',
+        },
+        {
+            key: 'feedbackForwardingEmailAddress',
+            label: 'Feedback Forwarding Email Address',
+            type: ConnectorConfigFormItemType.Text,
+            required: false,
+            placeholder: '<feedback-forwarding-email-address>',
+        },
+        {
+            key: 'feedbackForwardingEmailAddressIdentityArn',
+            label: 'Feedback Forwarding Email Address Identity ARN',
+            type: ConnectorConfigFormItemType.Text,
+            required: false,
+            placeholder: '<feedback-forwarding-email-address-identity-arn>',
+        },
+        {
+            key: 'configurationSetName',
+            label: 'Configuration Set Name',
+            type: ConnectorConfigFormItemType.Text,
+            required: false,
+            placeholder: '<configuration-set-name>',
+        },
+        {
+            key: 'templates',
+            label: 'Templates',
+            type: ConnectorConfigFormItemType.Json,
+            required: true,
+            defaultValue: [
+                {
+                    usageType: 'SignIn',
+                    subject: '<sign-in-template-subject>',
+                    content: '<sign-in-template-content>',
+                },
+                {
+                    usageType: 'Register',
+                    subject: '<register-template-subject>',
+                    content: '<register-template-content>',
+                },
+                {
+                    usageType: 'ForgotPassword',
+                    subject: '<forgot-password-template-subject>',
+                    content: '<forgot-password-template-content>',
+                },
+                {
+                    usageType: 'Generic',
+                    subject: '<generic-template-subject>',
+                    content: '<generic-template-content>',
+                },
+                {
+                    usageType: 'Test',
+                    subject: '<test-template-subject>',
+                    content: '<test-template-content>',
+                },
+            ],
+        },
+    ],
 };
 
 /**

package/package.json

@@ -53,7 +53,7 @@
     "access": "public"
   },
   "name": "@logto/connector-aws-ses",
-  "version": "1.0.0-beta.19",
+  "version": "1.0.0-beta.20",
   "description": "Logto Connector for Amazon SES",
   "author": "Jeff <admin@breadth.app>",
   "scripts": {

package/docs/config-template.json

@@ -1,37 +0,0 @@
-{
-  "accessKeyId": "<access-key-id>",
-  "accessKeySecret": "<access-key-secret>",
-  "region": "<region>",
-  "emailAddress": "<OPTIONAL-verified-email>",
-  "emailAddressIdentityArn": "<OPTIONAL-email-arn>",
-  "feedbackForwardingEmailAddress": "<OPTIONAL-feedback-email>",
-  "feedbackForwardingEmailAddressIdentityArn": "<OPTIONAL-feedback-email-arn>",
-  "configurationSetName": "<OPTIONAL-configuration-set>",
-  "templates": [
-    {
-      "usageType": "SignIn",
-      "subject": "<sign-in-template-subject>",
-      "content": "<sign-in-template-content>"
-    },
-    {
-      "usageType": "Register",
-      "subject": "<register-template-subject>",
-      "content": "<register-template-content>"
-    },
-    {
-      "usageType": "ForgotPassword",
-      "subject": "<forgot-password-template-subject>",
-      "content": "<forgot-password-template-content>"
-    },
-    {
-      "usageType": "Generic",
-      "subject": "<generic-template-subject>",
-      "content": "<generic-template-content>"
-    },
-    {
-      "usageType": "Test",
-      "subject": "<test-template-subject>",
-      "content": "<test-template-content>"
-    }
-  ]
-}