@mulverse/mulguard-core 1.0.0

package/src/providers/discord.ts

@@ -0,0 +1,176 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Discord</b> integration.</span>
+ * <a href="https://discord.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/discord.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/discord
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * Corresponds to the user structure documented here:
+ * https://discord.com/developers/docs/resources/user#user-object-user-structure
+ */
+export interface DiscordProfile extends Record<string, any> {
+  /** the user's id (i.e. the numerical snowflake) */
+  id: string
+  /** the user's username, not unique across the platform */
+  username: string
+  /** the user's Discord-tag */
+  discriminator: string
+  /** the user's display name, if it is set  */
+  global_name: string | null
+  /**
+   * the user's avatar hash:
+   * https://discord.com/developers/docs/reference#image-formatting
+   */
+  avatar: string | null
+  /** whether the user belongs to an OAuth2 application */
+  bot?: boolean
+  /**
+   * whether the user is an Official Discord System user (part of the urgent
+   * message system)
+   */
+  system?: boolean
+  /** whether the user has two factor enabled on their account */
+  mfa_enabled: boolean
+  /**
+   * the user's banner hash:
+   * https://discord.com/developers/docs/reference#image-formatting
+   */
+  banner: string | null
+
+  /** the user's banner color encoded as an integer representation of hexadecimal color code */
+  accent_color: number | null
+
+  /**
+   * the user's chosen language option:
+   * https://discord.com/developers/docs/reference#locales
+   */
+  locale: string
+  /** whether the email on this account has been verified */
+  verified: boolean
+  /** the user's email */
+  email: string | null
+  /**
+   * the flags on a user's account:
+   * https://discord.com/developers/docs/resources/user#user-object-user-flags
+   */
+  flags: number
+  /**
+   * the type of Nitro subscription on a user's account:
+   * https://discord.com/developers/docs/resources/user#user-object-premium-types
+   */
+  premium_type: number
+  /**
+   * the public flags on a user's account:
+   * https://discord.com/developers/docs/resources/user#user-object-user-flags
+   */
+  public_flags: number
+  /** undocumented field; corresponds to the user's custom nickname */
+  display_name: string | null
+  /**
+   * undocumented field; corresponds to the Discord feature where you can e.g.
+   * put your avatar inside of an ice cube
+   */
+  avatar_decoration: string | null
+  /**
+   * undocumented field; corresponds to the premium feature where you can
+   * select a custom banner color
+   */
+  banner_color: string | null
+  /** undocumented field; the CDN URL of their profile picture */
+  image_url: string
+}
+
+/**
+ * Add Discord login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/discord
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Discord from "@auth/core/providers/discord"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Discord({
+ *       clientId: DISCORD_CLIENT_ID,
+ *       clientSecret: DISCORD_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Discord OAuth documentation](https://discord.com/developers/docs/topics/oauth2)
+ *  - [Discord OAuth apps](https://discord.com/developers/applications)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Discord provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Discord provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/discord.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 Discord<P extends DiscordProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "discord",
+    name: "Discord",
+    type: "oauth",
+    authorization: {
+      url: "https://discord.com/api/oauth2/authorize",
+      params: { scope: "identify email" },
+    },
+    token: "https://discord.com/api/oauth2/token",
+    userinfo: "https://discord.com/api/users/@me",
+    profile(profile) {
+      if (profile.avatar === null) {
+        const defaultAvatarNumber =
+          profile.discriminator === "0"
+            ? Number(BigInt(profile.id) >> BigInt(22)) % 6
+            : parseInt(profile.discriminator) % 5
+        profile.image_url = `https://cdn.discordapp.com/embed/avatars/${defaultAvatarNumber}.png`
+      } else {
+        const format = profile.avatar.startsWith("a_") ? "gif" : "png"
+        profile.image_url = `https://cdn.discordapp.com/avatars/${profile.id}/${profile.avatar}.${format}`
+      }
+      return {
+        id: profile.id,
+        name: profile.global_name ?? profile.username,
+        email: profile.email,
+        image: profile.image_url,
+      }
+    },
+    style: { bg: "#5865F2", text: "#fff" },
+    options,
+  }
+}

package/src/providers/dribbble.ts

@@ -0,0 +1,122 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Dribbble</b> integration.</span>
+ * <a href="https://dribbble.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/dribbble.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/dribbble
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface DribbbleProfile extends Record<string, any> {
+  id: number
+  name: string
+  email: string
+  avatar_url: string
+}
+
+/**
+ *
+ * Add Dribbble login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/dribbble
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Dribbble from "@auth/core/providers/dribbble"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Dribbble({
+ *       clientId: DRIBBBLE_CLIENT_ID,
+ *       clientSecret: DRIBBBLE_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Dribbble API](https://developer.dribbble.com)
+ *  - [Dribbble OAuth](https://developer.dribbble.com/v2/oauth/)
+ *  - [Dribbble Applications](https://dribbble.com/account/applications/new)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the GitHub provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Dribbble provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/dribbble.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).
+ *
+ * :::
+ *
+ * :::tip
+ * You can optionally set the scope to `public upload` for more advanced scenarios. If omitted, the default `public` scope will be used for authentication purposes.
+ * :::
+ */
+
+export default function Dribbble<P extends DribbbleProfile>(
+  options: OAuthUserConfig<P> & {
+    /**
+     * Reference: https://developer.dribbble.com/v2/oauth/#scopes
+     *
+     * For the purposes of NextAuth.js `upload`-only scope makes no sense,
+     * therefore it is excluded from suggested values. Treated by Dribbble as `public` when omitted.
+     *
+     * @default public
+     */
+    scope?: "public" | "public upload"
+  }
+): OAuthConfig<P> {
+  return {
+    id: "dribbble",
+    name: "Dribbble",
+    type: "oauth",
+
+    authorization: {
+      url: "https://dribbble.com/oauth/authorize",
+      params: { scope: options.scope },
+    },
+
+    token: "https://dribbble.com/oauth/token",
+    userinfo: "https://api.dribbble.com/v2/user",
+
+    profile(profile) {
+      return {
+        id: profile.id.toString(),
+        name: profile.name,
+        email: profile.email,
+        image: profile.avatar_url,
+      }
+    },
+
+    style: {
+      text: "#fff",
+      bg: "#000",
+    },
+
+    options,
+  }
+}

package/src/providers/dropbox.ts

@@ -0,0 +1,102 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Dropbox</b> integration.</span>
+ * <a href="https://dropbox.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/dropbox.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/dropbox
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * Add Dropbox login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/dropbox
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Dropbox from "@auth/core/providers/dropbox"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Dropbox({
+ *       clientId: DROPBOX_CLIENT_ID,
+ *       clientSecret: DROPBOX_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Dropbox OAuth documentation](https://developers.dropbox.com/oauth-guide)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Dropbox provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Dropbox provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/dropbox.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 Dropbox(
+  options: OAuthUserConfig<Record<string, any>>
+): OAuthConfig<Record<string, any>> {
+  return {
+    id: "dropbox",
+    name: "Dropbox",
+    type: "oauth",
+    authorization: {
+      url: "https://www.dropbox.com/oauth2/authorize",
+      params: {
+        token_access_type: "offline",
+        scope: "account_info.read",
+      },
+    },
+    token: "https://api.dropboxapi.com/oauth2/token",
+    userinfo: {
+      url: "https://api.dropboxapi.com/2/users/get_current_account",
+      async request({ tokens, provider }) {
+        return await fetch(provider.userinfo?.url as URL, {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${tokens.access_token}`,
+          },
+        }).then(async (res) => await res.json())
+      },
+    },
+    profile(profile) {
+      return {
+        id: profile.account_id,
+        name: profile.name.display_name,
+        email: profile.email,
+        image: profile.profile_photo_url,
+      }
+    },
+    style: { brandColor: "#0061fe" },
+    options,
+  }
+}

package/src/providers/duende-identity-server6.ts

@@ -0,0 +1,101 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>DuendeIdentityServer6</b> integration.</span>
+ * <a href="https://docs.duendesoftware.com/identityserver/v6">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/duende-identity-server6.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/duende-identity-server6
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./oauth.js"
+
+export interface DuendeISUser extends Record<string, any> {
+  email: string
+  id: string
+  name: string
+  verified: boolean
+}
+
+/**
+ * Add DuendeIdentityServer6 login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/duende-identity-server6
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import DuendeIdentityServer6 from "@auth/core/providers/duende-identity-server6"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     DuendeIdentityServer6({
+ *       clientId: DIS6_CLIENT_ID,
+ *       clientSecret: DIS6_CLIENT_SECRET,
+ *       issuer: DIS6_ISSUER,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [DuendeIdentityServer6 documentation](https://docs.duendesoftware.com/identityserver/v6)
+ *
+ * ### Notes
+ *
+ *
+ * ## Demo IdentityServer
+ *
+ * The configuration below is for the demo server at https://demo.duendesoftware.com/
+ *
+ * If you want to try it out, you can copy and paste the configuration below.
+ *
+ * You can sign in to the demo service with either <b>bob/bob</b> or <b>alice/alice</b>.
+ *
+ * ```ts
+ * import DuendeIdentityServer6 from "@auth/core/providers/duende-identity-server6"
+ * providers: [
+ *   DuendeIdentityServer6({
+ *     clientId: "interactive.confidential",
+ *     clientSecret: "secret",
+ *     issuer: "https://demo.duendesoftware.com",
+ *   })
+ * ]
+ * ```
+ * By default, Auth.js assumes that the DuendeIdentityServer6 provider is
+ * based on the [Open ID Connect](https://openid.net/specs/openid-connect-core-1_0.html) specification.
+ *
+ * :::tip
+ *
+ * The DuendeIdentityServer6 provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/duende-identity-server6.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 DuendeIdentityServer6<P extends DuendeISUser>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "duende-identity-server6",
+    name: "DuendeIdentityServer6",
+    type: "oidc",
+    options,
+  }
+}

package/src/providers/email.ts

@@ -0,0 +1,60 @@
+import type { CommonProviderOptions } from "./index.js"
+import type { Awaitable, Theme } from "../types.js"
+export type { EmailProviderId } from "./provider-types.js"
+
+// TODO: Kepts for backwards compatibility
+// Remove this import and encourage users
+// to import it from @auth/core/providers/nodemailer directly
+import Nodemailer from "./nodemailer.js"
+import type { NodemailerConfig, NodemailerUserConfig } from "./nodemailer.js"
+
+/**
+ * @deprecated
+ *
+ * Import this provider from the `providers/nodemailer` submodule instead of `providers/email`.
+ *
+ * To log in with nodemailer, change `signIn("email")` to `signIn("nodemailer")`
+ */
+export default function Email(config: NodemailerUserConfig): NodemailerConfig {
+  return {
+    ...Nodemailer(config),
+    id: "email",
+    name: "Email",
+  }
+}
+
+// TODO: Rename to Token provider
+// when started working on https://github.com/nextauthjs/next-auth/discussions/1465
+export type EmailProviderType = "email"
+
+export type EmailProviderSendVerificationRequestParams = {
+  identifier: string
+  url: string
+  expires: Date
+  provider: EmailConfig
+  token: string
+  theme: Theme
+  request: Request
+}
+
+export interface EmailConfig extends CommonProviderOptions {
+  id: string
+  type: "email"
+  name: string
+  from?: string
+  maxAge?: number
+  sendVerificationRequest: (
+    params: EmailProviderSendVerificationRequestParams
+  ) => Awaitable<void>
+  /** Used to hash the verification token. */
+  secret?: string
+  /** Used with HTTP-based email providers. */
+  apiKey?: string
+  /** Used with SMTP-based email providers. */
+  server?: NodemailerConfig["server"]
+  generateVerificationToken?: () => Awaitable<string>
+  normalizeIdentifier?: (identifier: string) => string
+  options?: EmailUserConfig
+}
+
+export type EmailUserConfig = Omit<Partial<EmailConfig>, "options" | "type">

package/src/providers/eventbrite.ts

@@ -0,0 +1,105 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#f05537", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Eventbrite</b> integration.</span>
+ * <a href="https://www.eventbrite.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/eventbrite.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/eventbrite
+ */
+
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * @see https://www.eventbrite.com/platform/api#/reference/user/retrieve-your-user/retrieve-your-user
+ */
+export interface EventbriteProfile extends Record<string, any> {
+  id: string
+  name: string
+  first_name: string
+  last_name: string
+  emails: { email: string; verified: boolean; primary: boolean }[]
+  image_id: string
+}
+
+/**
+ * Add Eventbrite login to your page and make requests to [Eventbrite APIs](https://www.eventbrite.com/platform/api).
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/eventbrite
+ * ```
+ *
+ * #### Configuration
+ * ```ts
+ * import { Auth } from "@auth/core"
+ * import Eventbrite from "@auth/core/providers/eventbrite"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [Eventbrite({ clientId: EVENTBRITE_CLIENT_ID, clientSecret: EVENTBRITE_CLIENT_SECRET })],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Eventbrite OAuth documentation](https://www.eventbrite.com/platform/api#/introduction/authentication)
+ * - [Eventbrite App Management](https://www.eventbrite.com/account-settings/apps)
+ * - [Learn more about OAuth](https://authjs.dev/concepts/oauth)
+ * - [Source code](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/eventbrite.ts)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Eventbrite provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Eventbrite provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/eventbrite.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 Eventbrite<P extends EventbriteProfile>(
+  config: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "eventbrite",
+    name: "Eventbrite",
+    type: "oauth",
+    authorization: {
+      url: "https://www.eventbrite.com/oauth/authorize",
+      params: { scope: "user.profile" },
+    },
+    token: "https://www.eventbrite.com/oauth/token",
+    userinfo: "https://www.eventbriteapi.com/v3/users/me/",
+    profile(profile) {
+      return {
+        id: profile.id,
+        name: profile.name,
+        email: profile.emails.find((e) => e.primary)?.email,
+        image: profile.image_id
+          ? `https://img.evbuc.com/https%3A%2F%2Fcdn.evbuc.com%2Fimages%2F${profile.image_id}%2F1%2Foriginal.jpg`
+          : null,
+      }
+    },
+    client: {
+      token_endpoint_auth_method: "client_secret_post",
+    },
+    style: { bg: "#f05537", text: "#fff" },
+    options: config,
+  }
+}