@logto/connector-apple 1.0.1 → 1.0.2

package/LICENSE

@@ -1,9 +1,3 @@
-Portions of this software are licensed as follows:
-
-* All content that resides under the "packages/cloud" directory of this repository, if that directory exists, is licensed under the license defined in "packages/cloud/LICENSE" (Elastic-2.0).
-* All third party components incorporated into this software are licensed under the original license provided by the owner of the applicable component.
-* Content outside of the above mentioned directories or restrictions above is available under the "MPL-2.0" license as defined below.
-
 Mozilla Public License Version 2.0
 ==================================
 

package/README.md

@@ -2,8 +2,6 @@
 
 The official Logto connector for Apple social sign-in.
 
-Apple 社交登录 Logto 官方连接器 [中文文档](#apple-连接器)
-
 **Table of contents**
 
 - [Apple connector](#apple-connector)
@@ -12,12 +10,6 @@ Apple 社交登录 Logto 官方连接器 [中文文档](#apple-连接器)
     - [Create an identifier](#create-an-identifier)
     - [Enable Sign in with Apple for your identifier](#enable-sign-in-with-apple-for-your-identifier)
   - [Test Apple connector](#test-apple-connector)
-- [Apple 连接器](#apple-连接器)
-  - [开始上手](#开始上手)
-    - [为你的应用启用「通过 Apple 登录」](#为你的应用启用通过-apple-登录)
-    - [创建一个 identifier](#创建一个-identifier)
-    - [为你的 identifier 启用「通过 Apple 登录」](#为你的-identifier-启用通过-apple-登录)
-  - [测试 Apple 连接器](#测试-apple-连接器)
 
 ## Get started
 
@@ -77,66 +69,4 @@ Click "Next" then "Done" to close the modal. Click "Continue" on the top-right c
 
 ## Test Apple connector
 
-That's it. The Apple connector should be available in both web and native apps. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/enable-social-sign-in#enable-connector-in-sign-in-experience).
-
-# Apple 连接器
-
-## 开始上手
-
-如果你还不知道连接器的概念，或者还不知道如何将本连接器添加至你的「登录体验」，请先参见 [Logto 教程](https://docs.logto.io/zh-cn/docs/tutorials/get-started/enable-social-sign-in)。
-
-> ℹ️ **Note**
-> 
-> 如果你的应用有其他的社交登录方式，AppStore 要求必须同时有 Apple 登录。
-> 如果同时提供 Android 应用，在 Android 设备上同时提供 Apple 登录会让用户体验很棒。
-
-在继续前，你需要加入 [Apple Developer Program](https://developer.apple.com/programs/)。
-
-### 为你的应用启用「通过 Apple 登录」
-
-> ⚠️ **Caution**
-> 
-> 即使你只想在 web 应用中实现「通过 Apple 登录」，你仍需要拥有一个拥抱 AppStore 生态的应用（即：有一个有效的 App ID）。
-
-你可以通过 Xcode -> Project settings -> Signing & Capabilities 来启用，或者访问 [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list/bundleId)。
-
-![Enable Sign in with Apple](/packages/connector-apple/docs/enable-sign-in-with-apple-in-xcode.png)
-
-参见 [Apple 官方文档](https://developer.apple.com/documentation/sign_in_with_apple/configuring_your_environment_for_sign_in_with_apple) 里的「Enable an App ID」章节以了解更多。
-
-### 创建一个 identifier
-
-1. 访问 [Certificates, Identifiers & Profiles](https://developer.apple.com/account/resources/identifiers/list/serviceId)，并点按在「Identifier」旁边的「+」按钮。
-2. 在「Register a new identifier」页面，选择「Services IDs」并点按「Continue」。
-3. 填写「Description」与「Identifier」（例如 `Logto Test` 和 `io.logto.test`），并点按「Continue」。
-4. 再次检查相关信息并点按「Register」。
-
-### 为你的 identifier 启用「通过 Apple 登录」
-
-点按你刚刚创建的 identifier。在详情页勾选「Sign in with Apple」并点按「Configure」。
-
-![Enable Sign in with Apple](/packages/connector-apple/docs/enable-sign-in-with-apple.png)
-
-在打开的对话框中，选择刚刚启用了「通过 Apple 登录」的 App ID。
-
-输入你的 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)
-
-点按「Next」以及「Done」以关闭对话框。点按右上角的「Continue」，接着点按「Save」以保存你的配置。
-
-> ⚠️ **Caution**
-> 
-> Apple _不允许_ HTTP 协议或 `localhost` 域名作为 Return URL。
-> 
-> 如果你想在本地进行测试，你需要编辑 `/etc/hosts` 文件以映射 localhost 到一个自定义域名，并设置一个本地的 HTTPS 环境。[mkcert](https://github.com/FiloSottile/mkcert) 可以帮助你设置本地 HTTPS。
-
-> ℹ️ **Note**
-> 
-> 本连接器暂时不支持自定义 `scope`（例如 name，email）。因为在 `scope` 非空时，Apple 要求 `response_mode` 为 `form_post`，与现在连接器的设计不兼容。
-> 
-> 我们将稍后解决这个问题。
-
-## 测试 Apple 连接器
-
-大功告成。Apple 连接器应该在 web 和原生应用中都可用了。别忘了 [在登录体验中启用本连接器](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)。
+That's it. The Apple connector should be available in both web and native apps. 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).

package/lib/index.js

@@ -55,8 +55,26 @@ let customAlphabet = (alphabet, size = 21) =>
 
 const lowercaseAlphabet = '0123456789abcdefghijklmnopqrstuvwxyz';
 const alphabet = `${lowercaseAlphabet}ABCDEFGHIJKLMNOPQRSTUVWXYZ`;
-const buildIdGenerator = (size, includingUppercase = false) => customAlphabet(includingUppercase ? alphabet : lowercaseAlphabet, size);
-const generateStandardId = buildIdGenerator(21);
+const buildIdGenerator = (size, includingUppercase = true) => customAlphabet(includingUppercase ? alphabet : lowercaseAlphabet, size);
+/**
+ * Generate a standard id with 21 characters, including lowercase letters and numbers.
+ *
+ * @see {@link lowercaseAlphabet}
+ */
+const generateStandardId = buildIdGenerator(21, false);
+/**
+ * Generate a standard short id with 12 characters, including lowercase letters and numbers.
+ *
+ * @see {@link lowercaseAlphabet}
+ */
+buildIdGenerator(12, false);
+/**
+ * Generate a standard secret with 32 characters, including uppercase letters, lowercase
+ * letters, and numbers.
+ *
+ * @see {@link alphabet}
+ */
+buildIdGenerator(32);
 
 const encoder = new TextEncoder();
 const decoder = new TextDecoder();

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@logto/connector-apple",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Apple web connector implementation.",
   "dependencies": {
     "@logto/connector-kit": "^1.1.1",
-    "@logto/shared": "^2.0.0",
+    "@logto/shared": "^3.0.0",
     "jose": "^4.3.8"
   },
   "main": "./lib/index.js",