@logto/connector-apple 1.0.0-beta.9 → 1.0.0

package/README.md

@@ -11,14 +11,12 @@ Apple 社交登录 Logto 官方连接器 [中文文档](#apple-连接器)
     - [Enable Sign in with Apple for your app](#enable-sign-in-with-apple-for-your-app)
     - [Create an identifier](#create-an-identifier)
     - [Enable Sign in with Apple for your identifier](#enable-sign-in-with-apple-for-your-identifier)
-  - [Compose the connector JSON](#compose-the-connector-json)
   - [Test Apple connector](#test-apple-connector)
 - [Apple 连接器](#apple-连接器)
   - [开始上手](#开始上手)
     - [为你的应用启用「通过 Apple 登录」](#为你的应用启用通过-apple-登录)
     - [创建一个 identifier](#创建一个-identifier)
     - [为你的 identifier 启用「通过 Apple 登录」](#为你的-identifier-启用通过-apple-登录)
-  - [编写连接器的 JSON](#编写连接器的-json)
   - [测试 Apple 连接器](#测试-apple-连接器)
 
 ## Get started
@@ -59,7 +57,7 @@ Click the identifier you just created. Check "Sign in with Apple" on the details
 
 In the opening modal, select the App ID you just enabled Sign in with Apple.
 
-Enter the domain of your Logto instance without protocol and port, e.g., `your.logto.domain`; then enter the "Return URL" (i.e., Redirect URI), which is the Logto URL with `/callback/apple-universal`, e.g., `https://your.logto.domain/callback/apple-universal`.
+Enter the domain of your Logto instance without protocol and port, e.g., `your.logto.domain`; then enter the "Return URL" (i.e., Redirect URI), which is the Logto URL with `/callback/${connector_id}`, e.g., `https://your.logto.domain/callback/apple-universal`. You can get the randomly generated `connector_id` after creating Apple connector in Admin Console.
 
 ![domain-and-url](/packages/connector-apple/docs/domain-and-url.png)
 
@@ -71,16 +69,6 @@ Click "Next" then "Done" to close the modal. Click "Continue" on the top-right c
 > 
 > If you want to test locally, you need to edit `/etc/hosts` file to map localhost to a custom domain and set up a local HTTPS environment. [mkcert](https://github.com/FiloSottile/mkcert) can help you for setting up local HTTPS.
 
-## Compose the connector JSON
-
-You need to use the identifier that fills in the [Create an identifier](#create-an-identifier) section to compose the JSON:
-
-```json
-{
-  "clientId": "io.logto.test"
-}
-```
-
 > ℹ️ **Note**
 > 
 > This connector doesn't support customizing `scope` (e.g., name, email) yet since Apple requires `form_post` response mode when `scope` is not empty, which is incompatible with the current connector design.
@@ -131,7 +119,7 @@ That's it. The Apple connector should be available in both web and native apps.
 
 在打开的对话框中，选择刚刚启用了「通过 Apple 登录」的 App ID。
 
-输入你的 Logto 实例域名（不含协议和端口），例如 `your.logto.domain`；并输入「Return URL」（即 Redirect URI）。Return URL 的值是 Logto URL 加上 `/callback/apple-universal`，例如 `https://your.logto.domain/callback/apple-universal`。
+输入你的 Logto 实例域名（不含协议和端口），例如 `your.logto.domain`；并输入「Return URL」（即 Redirect URI）。Return URL 的值是 Logto URL 加上 `/callback/${connector_id}`，例如 `https://your.logto.domain/callback/apple-universal`。在管理控制台创建了 Apple 连接器之后，在详情页可以找到生成的随机 `connector_id`。
 
 ![domain-and-url](/packages/connector-apple/docs/domain-and-url.png)
 
@@ -143,16 +131,6 @@ That's it. The Apple connector should be available in both web and native apps.
 > 
 > 如果你想在本地进行测试，你需要编辑 `/etc/hosts` 文件以映射 localhost 到一个自定义域名，并设置一个本地的 HTTPS 环境。[mkcert](https://github.com/FiloSottile/mkcert) 可以帮助你设置本地 HTTPS。
 
-## 编写连接器的 JSON
-
-你需要使用在 [创建一个 identifier](#创建一个-identifier) 章节中填写的 identifier 来编写此 JSON：
-
-```json
-{
-  "clientId": "io.logto.test"
-}
-```
-
 > ℹ️ **Note**
 > 
 > 本连接器暂时不支持自定义 `scope`（例如 name，email）。因为在 `scope` 非空时，Apple 要求 `response_mode` 为 `form_post`，与现在连接器的设计不兼容。

package/lib/{src/constant.d.ts → constant.d.ts}

@@ -1,4 +1,4 @@
-import { ConnectorMetadata } from '@logto/connector-core';
+import type { ConnectorMetadata } from '@logto/connector-kit';
 export declare const issuer = "https://appleid.apple.com";
 export declare const authorizationEndpoint: string;
 export declare const accessTokenEndpoint: string;

package/lib/{src/index.d.ts → index.d.ts}

@@ -1,3 +1,3 @@
-import { CreateConnector, SocialConnector } from '@logto/connector-core';
+import type { CreateConnector, SocialConnector } from '@logto/connector-kit';
 declare const createAppleConnector: CreateConnector<SocialConnector>;
 export default createAppleConnector;