适配器

适配器是一個具有函數屬性（方法）的物件，可從資料來源讀取和寫入資料。將這些方法視為將資料層標準化為 Auth.js 可以理解的通用介面的方式。

這使得 Auth.js 非常靈活，並允許它與任何資料層一起使用。

适配器方法用於執行以下操作

建立/更新/刪除使用者
將帳戶連結/取消連結至/從使用者
處理作用中的工作階段
支援跨多個裝置的無密碼驗證

如果任何方法未實作，但被 Auth.js 呼叫，則會向使用者顯示錯誤，且操作將會失敗。

方法

createAuthenticator()?

optional createAuthenticator(authenticator): Awaitable<AdapterAuthenticator>

建立新的驗證器。

如果建立失敗，适配器必須擲回錯誤。

參數

參數	類型
`驗證器`	`AdapterAuthenticator`

Awaitable<AdapterAuthenticator>

createSession()?

optional createSession(session): Awaitable<AdapterSession>

為使用者建立工作階段並傳回。

另請參閱資料庫工作階段管理

參數

參數	類型
`session`	`物件`
`session.expires`	`日期`
`session.sessionToken`	`字串`
`session.userId`	`字串`

Awaitable<AdapterSession>

createUser()?

optional createUser(user): Awaitable<AdapterUser>

在資料庫中建立使用者並傳回。

另請參閱使用者管理

參數

參數	類型
`使用者`	`AdapterUser`

Awaitable<AdapterUser>

createVerificationToken()?

optional createVerificationToken(verificationToken): Awaitable<undefined | null | VerificationToken>

建立驗證權杖並傳回。

另請參閱驗證權杖

參數

參數	類型
`verificationToken`	`VerificationToken`

Awaitable<undefined | null | VerificationToken>

deleteSession()?

optional deleteSession(sessionToken): Promise<void> | Awaitable<undefined | null | AdapterSession>

從資料庫刪除工作階段。最好此方法也傳回正在刪除的工作階段以用於記錄目的。

另請參閱資料庫工作階段管理

參數

參數	類型
`sessionToken`	`字串`

Promise<void> | Awaitable<undefined | null | AdapterSession>

deleteUser()?

optional deleteUser(userId): Promise<void> | Awaitable<undefined | null | AdapterUser>

參數

參數	類型
`userId`	`字串`

Promise<void> | Awaitable<undefined | null | AdapterUser>

待辦事項

此方法目前尚未被叫用。

另請參閱使用者管理

getAccount()?

optional getAccount(providerAccountId, provider): Awaitable<null | AdapterAccount>

依供應商帳戶 ID 和供應商取得帳戶。

如果找不到帳戶，适配器必須傳回 null。

參數

參數	類型
`providerAccountId`	`字串`
`provider`	`字串`

回傳

Awaitable<null | AdapterAccount>

getAuthenticator()？

optional getAuthenticator(credentialID): Awaitable<null | AdapterAuthenticator>

從憑證 ID 回傳驗證器。

如果找不到驗證器，配接器必須回傳 null。

參數

參數	類型
`credentialID`	`字串`

回傳

Awaitable<null | AdapterAuthenticator>

getSessionAndUser()？

optional getSessionAndUser(sessionToken): Awaitable<null | {
  session: AdapterSession;
  user: AdapterUser;
}>

一次性從資料庫回傳 session 和 user。

💡

如果資料庫支援聯結 (joins)，建議減少資料庫查詢次數。

另請參閱資料庫工作階段管理

參數

參數	類型
`sessionToken`	`字串`

回傳

Awaitable<null | { session: AdapterSession; user: AdapterUser; }>

getUser()？

optional getUser(id): Awaitable<null | AdapterUser>

透過使用者 ID 從資料庫回傳使用者。

另請參閱使用者管理

參數

參數	類型
`id`	`字串`

回傳

Awaitable<null | AdapterUser>

getUserByAccount()？

optional getUserByAccount(providerAccountId): Awaitable<null | AdapterUser>

使用供應商 ID 和特定帳戶的使用者 ID，取得使用者。

另請參閱使用者管理

參數

參數	類型
`providerAccountId`	`Pick`<`AdapterAccount`, `"provider"` \| `"providerAccountId"`>

回傳

Awaitable<null | AdapterUser>

getUserByEmail()？

optional getUserByEmail(email): Awaitable<null | AdapterUser>

透過使用者的電子郵件地址從資料庫回傳使用者。

另請參閱驗證權杖

參數

參數	類型
`email`	`字串`

回傳

Awaitable<null | AdapterUser>

linkAccount()？

optional linkAccount(account): Promise<void> | Awaitable<undefined | null | AdapterAccount>

此方法在內部調用（但也可以選擇用於手動連結）。它會在資料庫中建立一個帳戶。

另請參閱使用者管理

參數

參數	類型
`帳戶`	`AdapterAccount`

回傳

Promise<void> | Awaitable<undefined | null | AdapterAccount>

listAuthenticatorsByUserId()？

optional listAuthenticatorsByUserId(userId): Awaitable<AdapterAuthenticator[]>

回傳使用者所有的驗證器。

如果找不到使用者，配接器仍應回傳空陣列。如果因為其他原因而導致檢索失敗，配接器必須拋出錯誤。

參數

參數	類型
`userId`	`字串`

回傳

Awaitable<AdapterAuthenticator[]>

unlinkAccount()？

optional unlinkAccount(providerAccountId): Promise<void> | Awaitable<undefined | AdapterAccount>

參數

參數	類型
`providerAccountId`	`Pick`<`AdapterAccount`, `"provider"` \| `"providerAccountId"`>

回傳

Promise<void> | Awaitable<undefined | AdapterAccount>

待辦事項

此方法目前尚未被叫用。

updateAuthenticatorCounter()？

optional updateAuthenticatorCounter(credentialID, newCounter): Awaitable<AdapterAuthenticator>

更新驗證器的計數器。

如果更新失敗，配接器必須拋出錯誤。

參數

參數	類型
`credentialID`	`字串`
`newCounter`	`數字`

回傳

Awaitable<AdapterAuthenticator>

updateSession()？

optional updateSession(session): Awaitable<undefined | null | AdapterSession>

更新資料庫中的 session 並回傳它。

另請參閱資料庫工作階段管理

參數

參數	類型
`session`	`Partial`<`AdapterSession`> & `Pick`<`AdapterSession`, `"sessionToken"`>

回傳

Awaitable<undefined | null | AdapterSession>

updateUser()？

optional updateUser(user): Awaitable<AdapterUser>

更新資料庫中的使用者並回傳它。

另請參閱使用者管理

參數

參數	類型
`使用者`	`Partial`<`AdapterUser`> & `Pick`<`AdapterUser`, `"id"`>

回傳

Awaitable<AdapterUser>

useVerificationToken()？

optional useVerificationToken(params): Awaitable<null | VerificationToken>

從資料庫回傳驗證權杖並刪除它，使其只能使用一次。

另請參閱驗證權杖

參數

參數	類型
`參數`	`物件`
`params.identifier`	`字串`
`params.token`	`字串`

回傳

Awaitable<null | VerificationToken>

AdapterAccount

帳戶是使用者和供應商之間的連線。

有兩種帳戶類型

當使用者使用 OAuth 供應商登入時，會建立 OAuth/OIDC 帳戶。
當使用者使用電子郵件供應商登入時，會建立電子郵件帳戶。

一位使用者可以有多個帳戶。

繼承自

帳戶

屬性

access_token？

optional readonly access_token: string;

繼承自

Account.access_token

authorization_details？

optional readonly authorization_details: AuthorizationDetails[];

繼承自

Account.authorization_details

expires_at？

optional expires_at: number;

根據 TokenEndpointResponse.expires_in 計算得出的值。

它是 TokenEndpointResponse.access_token 過期的絕對時間戳記（以秒為單位）。

此值可用於與 TokenEndpointResponse.refresh_token 一起實作權杖輪換。

參閱

繼承自

Account.expires_at

expires_in？

optional readonly expires_in: number;

繼承自

Account.expires_in

id_token？

optional readonly id_token: string;

繼承自

Account.id_token

provider

provider: string;

此帳戶的供應商 ID。例如：「google」。請參閱完整清單：https://authjs.dev.org.tw/reference/core/providers

繼承自

Account.provider

providerAccountId

providerAccountId: string;

此值取決於用於建立帳戶的供應商類型。

oauth/oidc：OAuth 帳戶的 ID，從 profile() 回呼中傳回。
email：使用者的電子郵件地址。
credentials: 從 authorize() 回呼傳回的 id

繼承自

Account.providerAccountId

refresh_token?

optional readonly refresh_token: string;

繼承自

Account.refresh_token

scope?

optional readonly scope: string;

繼承自

Account.scope

token_type?

optional readonly token_type: Lowercase<string>;

注意：因為值不區分大小寫，所以始終以小寫形式傳回

繼承自

Account.token_type

type

type: AdapterAccountType;

此帳戶的供應商類型

覆寫

Account.type

userId

userId: string;

此帳戶所屬的使用者 ID

請參閱

https://authjs.dev.org.tw/reference/core/adapters#adapteruser

覆寫

Account.userId

AdapterAuthenticator

驗證器代表分配給使用者的憑證驗證器。

擴展

Authenticator

屬性

counter

counter: number;

驗證器已使用的次數。

繼承自

Authenticator.counter

credentialBackedUp

credentialBackedUp: boolean;

用戶端驗證器是否備份了憑證。

繼承自

Authenticator.credentialBackedUp

credentialDeviceType

credentialDeviceType: string;

驗證器的裝置類型。

繼承自

Authenticator.credentialDeviceType

credentialID

credentialID: string;

Base64 編碼的憑證 ID。

繼承自

Authenticator.credentialID

credentialPublicKey

credentialPublicKey: string;

Base64 編碼的憑證公鑰。

繼承自

Authenticator.credentialPublicKey

providerAccountId

providerAccountId: string;

連結到驗證器的供應商帳戶 ID。

繼承自

Authenticator.providerAccountId

transports?

optional transports: null | string;

串連的傳輸標誌。

繼承自

Authenticator.transports

userId

userId: string;

驗證器的使用者 ID。

覆寫

Authenticator.userId

AdapterSession

工作階段會保留使用者目前登入狀態的相關資訊。

屬性

expires

expires: Date;

工作階段過期的絕對日期。

如果在工作階段過期日期之前存取，則會根據 SessionOptions.maxAge 中定義的 maxAge 選項來延長。在 SessionOptions.updateAge 定義的期間內，永遠不會延長超過一次。

如果存取的工作階段已過期，則會從資料庫中移除，以清除非使用中的工作階段。

sessionToken

sessionToken: string;

使用 "database" AuthConfig.strategy 選項時，用來在資料庫中查詢工作階段的隨機產生值。此值會儲存在用戶端安全的 HTTP-Only Cookie 中。

userId

userId: string;

將活動工作階段連接到資料庫中的使用者

AdapterUser

使用者代表可以登入應用程式的人員。如果使用者尚未存在，則會在他們第一次登入時，使用身分識別供應商傳回的資訊 (設定檔資料) 來建立。也會建立對應的帳戶並連結至使用者。

擴展

User

屬性

email

email: string;

使用者的電子郵件地址。

覆寫

User.email

emailVerified

emailVerified: null | Date;

使用者是否已透過電子郵件供應商驗證其電子郵件地址。如果使用者尚未透過電子郵件供應商登入，則為 null，或為首次成功登入的日期。

id

id: string;

使用者的唯一識別碼。

覆寫

User.id

圖片？

optional image: null | string;

繼承自

User.image

名稱？

optional name: null | string;

繼承自

User.name

驗證令牌

驗證令牌是用於透過使用者的電子郵件地址登入使用者的臨時令牌。當使用者使用電子郵件供應商登入時會建立此令牌。當使用者點擊電子郵件中的連結時，令牌和電子郵件會被傳回伺服器，在伺服器中會被雜湊並與資料庫中的值進行比較。如果令牌和電子郵件相符，且令牌尚未過期，則使用者將會登入。之後，令牌將從資料庫中刪除。

屬性

expires

expires: Date;

令牌過期的絕對日期。

identifier

identifier: string;

使用者的電子郵件地址。

token

token: string;

使用 AuthConfig.secret 值進行雜湊的令牌。

AdapterAccountType

type AdapterAccountType: Extract<ProviderType, "oauth" | "oidc" | "email" | "webauthn">;

帳戶的類型。

isDate()

isDate(value): value is string

判斷給定值是否可以解析為 Date

參數

參數	類型
`value`	`unknown`

回傳

value 是否為字串

@auth/solid-start client

适配器

适配器

方法

createAuthenticator()?

參數

返回

createSession()?

參數

返回

createUser()?

參數

返回

createVerificationToken()?

參數

返回

deleteSession()?

參數

返回

deleteUser()?

參數

返回

待辦事項

getAccount()?

參數

回傳

getAuthenticator()？

參數

回傳

getSessionAndUser()？

參數

回傳

getUser()？

參數

回傳

getUserByAccount()？

參數

回傳

getUserByEmail()？

參數

回傳

linkAccount()？

參數

回傳

listAuthenticatorsByUserId()？

參數

回傳

unlinkAccount()？

參數

回傳

待辦事項

updateAuthenticatorCounter()？

參數

回傳

updateSession()？

參數

回傳

updateUser()？

參數

回傳

useVerificationToken()？

參數

回傳

AdapterAccount

繼承自

屬性

access_token？

繼承自

authorization_details？

繼承自

expires_at？

參閱

繼承自

expires_in？

繼承自

id_token？

繼承自

provider

繼承自

providerAccountId

繼承自