@mulverse/mulguard-core 1.0.0

package/src/providers/osu.ts

@@ -0,0 +1,138 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>osu!</b> integration.</span>
+ * <a href="https://osu.ppy.sh/home">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/osu.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/osu
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface OsuUserCompact {
+  avatar_url: string
+  country_code: string
+  default_group: string
+  id: number
+  is_active: boolean
+  is_bot: boolean
+  is_deleted: boolean
+  is_online: boolean
+  is_supporter: boolean
+  last_visit: Date | null
+  pm_friends_only: boolean
+  profile_colour: string | null
+  username: string
+}
+
+export interface OsuProfile extends OsuUserCompact, Record<string, any> {
+  discord: string | null
+  has_supported: boolean
+  interests: string | null
+  join_date: Date
+  kudosu: {
+    available: number
+    total: number
+  }
+  location: string | null
+  max_blocks: number
+  max_friends: number
+  occupation: string | null
+  playmode: string
+  playstyle: string[]
+  post_count: number
+  profile_order: string[]
+  title: string | null
+  title_url: string | null
+  twitter: string | null
+  website: string | null
+  country: {
+    code: string
+    name: string
+  }
+  cover: {
+    custom_url: string | null
+    url: string
+    id: number | null
+  }
+  is_restricted: boolean
+}
+
+/**
+ * Add osu! login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/osu
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Osu from "@auth/core/providers/osu"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Osu({ clientId: OSU_CLIENT_ID, clientSecret: OSU_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [osu! OAuth documentation](https://osu.ppy.sh/docs/index.html#authentication)
+ *  - [osu! app console](https://osu.ppy.sh/home/account/edit#new-oauth-application)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Osu provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::note
+ *
+ * osu! does not provide a user email.
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The osu! provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/osu.ts).
+ * To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
+ *
+ * :::
+ *
+ * :::info **Disclaimer**
+ *
+ * If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
+ *
+ * Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
+ * the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
+ * we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
+ *
+ * :::
+ */
+export default function Osu<P extends OsuProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "osu",
+    name: "osu!",
+    type: "oauth",
+    token: "https://osu.ppy.sh/oauth/token",
+    authorization: "https://osu.ppy.sh/oauth/authorize?scope=identify",
+    userinfo: "https://osu.ppy.sh/api/v2/me",
+    profile(profile) {
+      return {
+        id: profile.id.toString(),
+        email: null,
+        name: profile.username,
+        image: profile.avatar_url,
+      }
+    },
+    options,
+  }
+}

package/src/providers/passage.ts

@@ -0,0 +1,103 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Passage by 1Password</b> integration.</span>
+ * <a href="https://passage.1password.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/passage.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/passage
+ */
+
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/** @see [Supported Scopes](https://docs.passage.id/hosted-login/oidc-client-configuration#supported-scopes) */
+export interface PassageProfile {
+  iss: string
+  /** Unique identifer in Passage for the user */
+  sub: string
+  aud: string[]
+  exp: number
+  iat: number
+  auth_time: number
+  azp: string
+  client_id: string
+  at_hash: string
+  c_hash: string
+  /** The user's email address */
+  email: string
+  /** Whether the user has verified their email address */
+  email_verified: boolean
+  /** The user's phone number */
+  phone: string
+  /** Whether the user has verified their phone number */
+  phone_number_verified: boolean
+}
+
+/**
+ * Add Passage login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/passage
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Passage from "@auth/core/providers/passage"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Passage({
+ *       clientId: PASSAGE_ID,
+ *       clientSecret: PASSAGE_SECRET,
+ *       issuer: PASSAGE_ISSUER,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Passage OIDC documentation](https://docs.passage.id/hosted-login/oidc-client-configuration)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Passage provider is
+ * based on the [Open ID Connect](https://openid.net/specs/openid-connect-core-1_0.html) specification.
+ *
+ * :::tip
+ *
+ * The Passage provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/passage.ts).
+ * To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
+ *
+ * :::
+ *
+ * :::info **Disclaimer**
+ *
+ * If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
+ *
+ * Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
+ * the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
+ * we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
+ *
+ * :::
+ */
+export default function Passage(
+  config: OAuthUserConfig<PassageProfile>
+): OAuthConfig<PassageProfile> {
+  return {
+    id: "passage",
+    name: "Passage",
+    type: "oidc",
+    client: { token_endpoint_auth_method: "client_secret_basic" },
+    style: {
+      brandColor: "#3d53f6",
+    },
+    options: config,
+  }
+}

package/src/providers/passkey.ts

@@ -0,0 +1,94 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#24292f", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Passkey</b> integration.</span>
+ * <a href="https://passkeys.dev">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/passkey.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/passkey
+ */
+
+import WebAuthn, {
+  WebAuthnConfig,
+  DEFAULT_WEBAUTHN_TIMEOUT,
+} from "./webauthn.js"
+
+/**
+ * Add Passkey login to your page.
+ *
+ * ### Setup
+ *
+ * Install the required peer dependency.
+ *
+ * ```bash npm2yarn
+ * npm install @simplewebauthn/browser@9.0.1
+ * ```
+ *
+ * #### Configuration
+ * ```ts
+ * import { Auth } from "@auth/core"
+ * import Passkey from "@auth/core/providers/passkey"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [Passkey],
+ * })
+ * ```
+ * ### Resources
+ *
+ * - [SimpleWebAuthn - Server side](https://simplewebauthn.dev/docs/packages/server)
+ * - [SimpleWebAuthn - Client side](https://simplewebauthn.dev/docs/packages/client)
+ * - [Passkeys.dev - Intro](https://passkeys.dev/docs/intro/what-are-passkeys/)
+ * - [Passkeys.dev - Specifications](https://passkeys.dev/docs/reference/specs/)
+ * - [Source code](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/passkey.ts)
+ *
+ * ### Notes
+ *
+ * This provider is an extension of the WebAuthn provider that defines some default values
+ * associated with Passkey support. You may override these, but be aware that authenticators
+ * may not recognize your credentials as Passkey credentials if you do.
+ *
+ * :::tip
+ *
+ * The Passkey provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/passkey.ts).
+ * To override the defaults for your use case, check out [customizing a built-in WebAuthn provider](https://authjs.dev/guides/configuring-oauth-providers).
+ *
+ * :::
+ *
+ * :::info **Disclaimer**
+ *
+ * If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
+ *
+ * Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
+ * the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
+ * we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
+ *
+ * :::
+ */
+export default function Passkey(
+  config: Partial<WebAuthnConfig>
+): WebAuthnConfig {
+  return WebAuthn({
+    id: "passkey",
+    name: "Passkey",
+    authenticationOptions: {
+      timeout: DEFAULT_WEBAUTHN_TIMEOUT,
+      userVerification: "required",
+    },
+    registrationOptions: {
+      timeout: DEFAULT_WEBAUTHN_TIMEOUT,
+      authenticatorSelection: {
+        residentKey: "required",
+        userVerification: "required",
+      },
+    },
+    verifyAuthenticationOptions: {
+      requireUserVerification: true,
+    },
+    verifyRegistrationOptions: {
+      requireUserVerification: true,
+    },
+    ...config,
+  })
+}

package/src/providers/patreon.ts

@@ -0,0 +1,98 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Patreon</b> integration.</span>
+ * <a href="https://www.patreon.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/patreon.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/patreon
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface PatreonProfile extends Record<string, any> {
+  sub: string
+  nickname: string
+  email: string
+  picture: string
+}
+
+/**
+ * Add Patreon login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/patreon
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Patreon from "@auth/core/providers/patreon"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Patreon({
+ *       clientId: PATREON_CLIENT_ID,
+ *       clientSecret: PATREON_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Patreon OAuth documentation](https://docs.patreon.com/#apiv2-oauth)
+ *  - [Patreon Platform](https://www.patreon.com/portal/registration/register-clients)
+ *  - [ApiV2 Scopes](https://docs.patreon.com/#scopes)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Patreon provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Patreon provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/patreon.ts).
+ * To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
+ *
+ * :::
+ *
+ * :::info **Disclaimer**
+ *
+ * If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
+ *
+ * Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
+ * the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
+ * we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
+ *
+ * :::
+ */
+export default function Patreon<P extends PatreonProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "patreon",
+    name: "Patreon",
+    type: "oauth",
+    authorization: {
+      url: "https://www.patreon.com/oauth2/authorize",
+      params: { scope: "identity identity[email]" },
+    },
+    token: "https://www.patreon.com/api/oauth2/token",
+    userinfo: "https://www.patreon.com/api/oauth2/api/current_user",
+    profile(profile) {
+      return {
+        id: profile.data.id,
+        name: profile.data.attributes.full_name,
+        email: profile.data.attributes.email,
+        image: profile.data.attributes.image_url,
+      }
+    },
+    style: { bg: "#e85b46", text: "#fff" },
+    options,
+  }
+}

package/src/providers/ping-id.ts

@@ -0,0 +1,68 @@
+import type { OIDCConfig, OIDCUserConfig } from "./index.js"
+
+export interface PingProfile extends Record<string, any> {
+  iss: string
+  sub: string
+  aud: string
+  iat: number
+  exp: number
+  acr: string
+  amr: [string]
+  auth_time: number
+  at_hash: string
+  sid: string
+  preferred_username: string
+  given_name: string
+  picture: string
+  updated_at: number
+  name: string
+  family_name: string
+  email: string
+  env: string
+  org: string
+  "p1.region": string
+}
+
+/**
+ * Add PingId login to your page.
+ *
+ * ## Documentation
+ *
+ * - [Create App in Ping Identity](https://docs.pingidentity.com/r/en-us/pingone/p1_add_app_worker)
+ *
+ *  ---
+ * ## Example
+ *
+ * ```ts
+ * import PingId from "@auth/core/providers/ping-id"
+ *
+ * ...
+ * providers: [
+ *  PingId({
+ *    clientId: AUTH_PING_ID_ID,
+ *    clientSecret: AUTH_PING_ID_SECRET,
+ *    issuer: PING_ID_ISSUER
+ *  })
+ * ]
+ * ...
+ * ```
+ *
+ * ## Help
+ *
+ * If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
+ *
+ * Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
+ * the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
+ * we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
+ */
+
+export default function PingId(
+  options: OIDCUserConfig<PingProfile>
+): OIDCConfig<PingProfile> {
+  return {
+    id: "ping-id",
+    name: "Ping Identity",
+    type: "oidc",
+    options,
+  }
+}

package/src/providers/pinterest.ts

@@ -0,0 +1,106 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Pinterest</b> integration.</span>
+ * <a href="https://www.pinterest.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/pinterest.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/pinterest
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface PinterestProfile extends Record<string, any> {
+  account_type: "BUSINESS" | "PINNER"
+  profile_image: string
+  website_url: string
+  username: string
+}
+
+/**
+ * Add Pinterest login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/pinterest
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Pinterest from "@auth/core/providers/pinterest"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Pinterest({
+ *       clientId: PINTEREST_CLIENT_ID,
+ *       clientSecret: PINTEREST_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Pinterest OAuth documentation](https://developers.pinterest.com/docs/getting-started/authentication/)
+ *  - [Pinterest app console](https://developers.pinterest.com/apps/)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Pinterest provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ *
+ * :::tip
+ *
+ * To use in production, make sure the app has standard API access and not trial access
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The Pinterest provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/pinterest.ts).
+ * To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/configuring-oauth-providers).
+ *
+ * :::
+ *
+ * :::info **Disclaimer**
+ *
+ * If you think you found a bug in the default configuration, you can [open an issue](https://authjs.dev/new/provider-issue).
+ *
+ * Auth.js strictly adheres to the specification and it cannot take responsibility for any deviation from
+ * the spec by the provider. You can open an issue, but if the problem is non-compliance with the spec,
+ * we might not pursue a resolution. You can ask for more help in [Discussions](https://authjs.dev/new/github-discussions).
+ *
+ * :::
+ */
+export default function PinterestProvider<P extends PinterestProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "pinterest",
+    name: "Pinterest",
+    type: "oauth",
+    authorization: {
+      url: "https://www.pinterest.com/oauth",
+      params: { scope: "user_accounts:read" },
+    },
+    token: "https://api.pinterest.com/v5/oauth/token",
+    userinfo: "https://api.pinterest.com/v5/user_account",
+    profile({ username, profile_image }) {
+      return {
+        id: username,
+        name: username,
+        image: profile_image,
+        email: null,
+      }
+    },
+    style: {
+      brandColor: "#bd081c",
+    },
+    options,
+  }
+}