@atpassport/client 0.1.1 → 0.1.2

package/README.md

@@ -1,13 +1,13 @@
 # @atpassport/client
 
-[AtPassport](https://atpassport.net) is an authentication provider tailored for the atproto ecosystem.
-Using this client library, you can easily integrate AtPassport "login" functionality into your applications (such as browser extensions or web apps) with an OAuth-like flow.
+[@passport](https://atpassport.net) is an authentication provider tailored for the atproto ecosystem.
+Using this client library, you can easily integrate a @passport-powered "handle input assist feature" into your applications (such as browser extensions or web apps) with an OAuth-like flow.
 
 *For the Japanese documentation, please see [README_ja.md](./README_ja.md).*
 
 ## Features
 - **Zero dependencies**
-- **OAuth-like secure authentication flow** (Built-in CSRF protection via `atpstate`)
+- **OAuth-like secure integration flow** (Built-in CSRF protection via `atpstate`)
 - **Custom parameter passthrough** (Query parameters attached to the callback URL are automatically returned)
 
 ## Installation
@@ -25,40 +25,39 @@ import { AtPassport } from '@atpassport/client';
 
 // 1. Initialize the client
 const passport = new AtPassport({
-  baseUrl: 'https://atpassport.net', // Optional (defaults to atpassport.net)
-  callbackUrl: 'https://myapp.com/oauth/callback' // Required: the URL to redirect back to
+  callbackUrl: 'https://myapp.com/oauth/login' // Required: the URL to redirect back to
 });
 
-// 2. Generate the authentication URL and redirect
+// 2. (Optional) Generate the authentication URL and redirect
 // You can pass custom parameters (e.g., redirect_uri to return to the original page)
 const { url, atpstate } = passport.generateAuthUrl({
   redirect_uri: '/dashboard'
 });
 
-// For security, save the generated atpstate to sessionStorage or cookies to prevent CSRF
+// 3. (Optional) For security, save the generated atpstate to sessionStorage or cookies to prevent CSRF
 sessionStorage.setItem('atpstate', atpstate);
 
-// Redirect the user to the AtPassport authentication page
+// 4. Redirect the user to the @passport handle selection screen
 window.location.assign(url);
 ```
 
 ```typescript
-// 3. Receive the parameters on your callback page (https://myapp.com/oauth/callback)
-// By passing the saved atpstate as the second argument, parseCallback will automatically
+// Receive the parameters on your callback page (https://myapp.com/oauth/callback)
+// (Optional) By passing the saved atpstate as the second argument, parseCallback will automatically
 // throw an Error if the states don't match (preventing CSRF attacks).
 const savedState = sessionStorage.getItem('atpstate');
 const result = passport.parseCallback(window.location.href, savedState);
 
 console.log('Login successful:', result);
 console.log('Authenticated User:', result.handle);
-console.log('Custom Parameters:', result.customParams.redirect_uri); // Outputs '/dashboard'
+console.log('Custom Parameters:', result.customParams['redirect_uri']); // Outputs '/dashboard'
 ```
 
 ---
 
 ## Explained: Parameters and Placeholders
 
-When AtPassport redirects back to your `callbackUrl`, the following information will be attached as URL parameters.
+When @passport redirects back to your `callbackUrl`, the following information will be attached as URL parameters.
 
 ### Basic Parameters (Automatically extracted by `parseCallback`)
 - **`handle`**: The authenticated user's Bluesky / atproto handle (e.g., `alice.bsky.social`).
@@ -67,9 +66,9 @@ When AtPassport redirects back to your `callbackUrl`, the following information
 - **`atpstate`**: The state string automatically generated for CSRF protection via `generateAuthUrl()`.
 
 ### The `{handle}` and `{did}` Placeholder Replacement Feature
-Depending on the specific API endpoint used for integration or the exact implementation of the integrating client, there is a feature where placing `{handle}` or `{did}` string placeholders inside the `callbackUrl` string will instruct AtPassport to **dynamically string-replace** them with the actual handle/DID upon completion.
+Depending on the specific API endpoint used for integration or the exact implementation of the integrating client, there is a feature where placing `{handle}` or `{did}` string placeholders inside the `callbackUrl` string will instruct @passport to **dynamically string-replace** them with the actual handle/DID upon completion.
 
 **Example:**
-If the `callbackUrl` was `https://myapp.com/login?handle={handle}`, AtPassport would redirect back to `https://myapp.com/login?handle=alice.bsky.social`.
+If the `callbackUrl` was `https://myapp.com/login?handle={handle}`, @passport would redirect back to `https://myapp.com/login?handle=alice.bsky.social`.
 
-*Note: With the standard flow using `@atpassport/client` (`generateAuthUrl` → `parseCallback`), AtPassport does not rely on string replacement. Instead, it securely appends parameters like `&handle=...` as standardized URL queries. This allows you to simply and securely receive all information using `parseCallback()` without manually formatting placeholders.*
+*Note: With the standard flow using `@atpassport/client` (`generateAuthUrl` → `parseCallback`), @passport does not rely on string replacement. Instead, it securely appends parameters like `&handle=...` as standardized URL queries. This allows you to simply and securely receive all information using `parseCallback()` without manually formatting placeholders.*

package/README_ja.md

@@ -1,13 +1,13 @@
 # @atpassport/client
 
-[AtPassport](https://atpassport.net) は、atproto エコシステム向けの認証プロバイダーです。
-このクライアントライブラリを使うことで、あなたのアプリケーション（ブラウザ拡張機能やWebアプリ）に、AtPassportを利用した「ログイン機能」を簡単に組み込むことができます。
+[@passport](https://atpassport.net) は、atproto エコシステム向けの認証プロバイダーです。
+このクライアントライブラリを使うことで、あなたのアプリケーション（ブラウザ拡張機能やWebアプリ）に、@passport を利用した「ハンドル入力のアシスト機能」を簡単に組み込むことができます。
 
 *For the English documentation, please see [README.md](./README.md).*
 
 ## 特徴
 - 依存関係ゼロ（Zero dependencies）
-- OAuthライクなセキュアな認証フロー（CSRF対策のための `atpstate` 対応）
+- OAuthライクなセキュアな連携フロー（CSRF対策のための `atpstate` 対応）
 - 複数のカスタムパラメータの引き回し（コールバックに付与したパラメータが自動で返却されます）
 
 ## インストール
@@ -25,39 +25,38 @@ import { AtPassport } from '@atpassport/client';
 
 // 1. クライアントの初期化
 const passport = new AtPassport({
-  baseUrl: 'https://atpassport.net', // 省略可能 (デフォルトは atpassport.net)
-  callbackUrl: 'https://myapp.com/oauth/callback' // 必須: 認証後に戻ってくるURL
+  callbackUrl: 'https://myapp.com/oauth/login' // 必須: 認証後に戻ってくるURL
 });
 
-// 2. 認証URLの生成とリダイレクト
+// 2. (任意)認証URLの生成とリダイレクト
 // カスタムパラメータ（例: ログイン後に元いたページに戻すための redirect_uri など）を指定できます
 const { url, atpstate } = passport.generateAuthUrl({
   redirect_uri: '/dashboard'
 });
 
-// セキュリティのため、発行された atpstate をセッションや sessionStorage 等に保存します
+// 3.(任意)セキュリティのため、発行された atpstate をセッションや sessionStorage 等に保存します
 sessionStorage.setItem('atpstate', atpstate);
 
-// AtPassportの認証画面へリダイレクト
+// 4. @passport のハンドル選択画面へリダイレクト
 window.location.assign(url);
 ```
 
 ```typescript
-// 3. コールバック先 (https://myapp.com/oauth/callback) でのパラメータ受け取り
-// 保存していた atpstate を第2引数に渡すことで、状態が不一致（CSRFの疑い）の場合はエラー（例外）が発生します
+// コールバック先 (https://myapp.com/oauth/callback) でのパラメータ受け取り
+// (任意)保存していた atpstate を第2引数に渡すことで、状態が不一致（CSRFの疑い）の場合はエラー（例外）が発生します
 const savedState = sessionStorage.getItem('atpstate');
 const result = passport.parseCallback(window.location.href, savedState);
 
 console.log('ログイン成功:', result);
 console.log('認証ユーザー:', result.handle);
-console.log('カスタムパラメータ:', result.customParams.redirect_uri); // '/dashboard' が取れる
+console.log('カスタムパラメータ:', result.customParams['redirect_uri']); // '/dashboard' が取れる
 ```
 
 ---
 
 ## パラメータ・プレースホルダーの解説
 
-AtPassport からコールバック URL にリダイレクトされる際、以下の情報が URL パラメータとして付与されます。
+@passport からコールバック URL にリダイレクトされる際、以下の情報が URL パラメータとして付与されます。
 
 ### 基本パラメータ（`parseCallback` で自動取得されるもの）
 - **`handle`**: 認証されたユーザーの Bluesky / atproto ハンドル名（例: `alice.bsky.social`）
@@ -66,9 +65,9 @@ AtPassport からコールバック URL にリダイレクトされる際、以
 - **`atpstate`**: `generateAuthUrl()` で自動生成された CSRF 防止用のステート文字列。リクエスト元の検証に用います。
 
 ### `{handle}` などのプレースホルダー置換機能
-特定のエンドポイントを利用した連携や、組み込み先のクライアント実装次第では、`callbackUrl` 内に `{handle}` や `{did}` といった文字列（プレースホルダー）を含めておくことで、認証完了時に AtPassport 側でユーザーの実際のハンドルや DID に**動的に文字列置換**されてリダイレクトされる機能があります。
+特定のエンドポイントを利用した連携や、組み込み先のクライアント実装次第では、`callbackUrl` 内に `{handle}` や `{did}` といった文字列（プレースホルダー）を含めておくことで、認証完了時に @passport 側でユーザーの実際のハンドルや DID に**動的に文字列置換**されてリダイレクトされる機能があります。
 
 **例:**
-`callbackUrl` を `https://myapp.com/login?handle={handle}` にして AtPassport へ送ると、完了時に `https://myapp.com/login?handle=alice.bsky.social` として戻ってきます。
+`callbackUrl` を `https://myapp.com/login?handle={handle}` にして @passport へ送ると、完了時に `https://myapp.com/login?handle=alice.bsky.social` として戻ってきます。
 
-※ `@atpassport/client` を使った標準の `generateAuthUrl` → `parseCallback` フローでは、AtPassport はプレースホルダー置換ではなく、安全に `&handle=...` のように標準的なクエリパラメータとして追記する形を採っているため、意識せずに `parseCallback()` だけで全ての情報を簡単に安全に受け取ることができます。
+※ `@atpassport/client` を使った標準の `generateAuthUrl` → `parseCallback` フローでは、@passport はプレースホルダー置換ではなく、安全に `&handle=...` のように標準的なクエリパラメータとして追記する形を採っているため、意識せずに `parseCallback()` だけで全ての情報を簡単に安全に受け取ることができます。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atpassport/client",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [