@mulverse/mulguard-core 1.0.0

package/src/providers/line.ts

@@ -0,0 +1,99 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>LINE</b> integration.</span>
+ * <a href="https://LINE.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/line.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/line
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface LineProfile extends Record<string, any> {
+  iss: string
+  sub: string
+  aud: string
+  exp: number
+  iat: number
+  amr: string[]
+  name: string
+  picture: string
+  user: any
+}
+
+/**
+ * Add LINE login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/line
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import LINE from "@auth/core/providers/line"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     LINE({ clientId: LINE_CLIENT_ID, clientSecret: LINE_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [LINE Login documentation](https://developers.line.biz/en/docs/line-login/integrate-line-login/)
+ *  - [LINE app console](https://developers.line.biz/console/)
+ *
+ * ## Configuration
+ * Create a provider and a LINE login channel at https://developers.line.biz/console/. In the settings of the channel under LINE Login, activate web app and configure the following: Callback URL `http://localhost:3000/api/auth/callback/line`
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the LINE provider is
+ * based on the [Open ID Connect](https://openid.net/specs/openid-connect-core-1_0.html) specification.
+ *
+ * :::tip
+ *
+ * To retrieve email address, you need to apply for Email address permission. Open [Line Developer Console](https://developers.line.biz/console/), go to your Login Channel. Scroll down bottom to find **OpenID Connect** -> **Email address permission**. Click **Apply** and follow the instruction.
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The LINE provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/line.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 LINE<P extends LineProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "line",
+    name: "LINE",
+    type: "oidc",
+    issuer: "https://access.line.me",
+    client: {
+      id_token_signed_response_alg: "HS256",
+    },
+    style: { bg: "#00C300", text: "#fff" },
+    options,
+    checks: ["state"],
+  }
+}

package/src/providers/linkedin.ts

@@ -0,0 +1,91 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>LinkedIn</b> integration.</span>
+ * <a href="https://linkedin.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/linkedin.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/linkedin
+ */
+import type { OIDCConfig, OIDCUserConfig } from "./index.js"
+
+/** @see https://learn.microsoft.com/en-us/linkedin/consumer/integrations/self-serve/sign-in-with-linkedin-v2#response-body-schema */
+export interface LinkedInProfile extends Record<string, any> {
+  sub: string
+  name: string
+  given_name: string
+  family_name: string
+  picture: string
+  locale: string
+  email: string
+  email_verified: boolean
+}
+
+/**
+ * Add LinkedIn login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/linkedin
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import LinkedIn from "@auth/core/providers/linkedin"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     LinkedIn({
+ *       clientId: LINKEDIN_CLIENT_ID,
+ *       clientSecret: LINKEDIN_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [LinkedIn OAuth documentation](https://docs.microsoft.com/en-us/linkedin/shared/authentication/authorization-code-flow)
+ *  - [LinkedIn app console](https://www.linkedin.com/developers/apps/)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the LinkedIn provider is
+ * based on the [OIDC](https://openid.net/specs/openid-connect-core-1_0.html) specification.
+ *
+ * :::tip
+ *
+ * The LinkedIn provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/linkedin.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 LinkedIn<P extends LinkedInProfile>(
+  options: OIDCUserConfig<P>
+): OIDCConfig<P> {
+  return {
+    id: "linkedin",
+    name: "LinkedIn",
+    type: "oidc",
+    client: { token_endpoint_auth_method: "client_secret_post" },
+    issuer: "https://www.linkedin.com/oauth",
+    style: { bg: "#069", text: "#fff" },
+    checks: ["state"],
+    options,
+  }
+}

package/src/providers/logto.ts

@@ -0,0 +1,122 @@
+/**
+ * <div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}>
+ * <span style={{fontSize: "1.35rem" }}>
+ *  Built-in sign in with <b>Logto</b> integration.
+ * </span>
+ * <a href="https://logto.io" style={{backgroundColor: "black", padding: "12px", borderRadius: "100%" }}>
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/logto.svg" width="24"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/logto
+ */
+
+import type { OIDCConfig, OIDCUserConfig } from "./index.js"
+
+/** The returned user profile from Logto when using the profile callback. [Reference](https://docs.logto.io/quick-starts/next-auth#scopes-and-claims). */
+export interface LogtoProfile {
+  /** The user's unique ID */
+  sub: string
+  /** The user's name */
+  name: string
+  /** The user's username */
+  username: string
+  /** The user's picture */
+  picture: string
+  /** The user's email */
+  email: string
+  /** A boolean indicating if the user's email is verified */
+  email_verified: boolean
+  /** The user's phone number */
+  phone_number: string
+  /** A boolean indicating if the user's phone number is verified */
+  phone_number_verified: boolean
+  /** The user's address */
+  address: string
+  /** Custom fields */
+  custom_data: object
+  /** The linked identities of the user */
+  identities: object
+  /** The linked SSO identities of the user */
+  sso_identities: object[]
+  /** The organization IDs the user belongs to */
+  organizations: string[]
+  /** The organization data the user belongs to */
+  organization_data: object[]
+  /** The organization roles the user belongs to with the format of organization_id:/role_name */
+  organization_roles: string[]
+  /** The user's custom attributes */
+  [claim: string]: unknown
+}
+
+/**
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/logto
+ * ```
+ *
+ * #### Configuration
+ * ```ts
+ * import { Auth } from "@auth/core"
+ * import Logto from "@auth/core/providers/logto"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Logto({
+ *       clientId: LOGTO_ID,
+ *       clientSecret: LOGTO_SECRET,
+ *       issuer: LOGTO_ISSUER
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ *
+ * ### Resources
+ *
+ * - [Logto Auth.js quickstart](https://docs.logto.io/quick-starts/next-auth)
+ * - [Integrate Logto in your application](https://docs.logto.io/integrate-logto/integrate-logto-into-your-application)
+ *
+ * ### Notes
+ *
+ * The Logto provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/logto.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
+ * By default, Auth.js assumes that the Logto provider is based on the [OIDC](https://openid.net/specs/openid-connect-core-1_0.html) spec
+ * :::
+ *
+ * ## 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 Logto(
+  options: OIDCUserConfig<LogtoProfile>
+): OIDCConfig<LogtoProfile> {
+  return {
+    id: "logto",
+    name: "Logto",
+    type: "oidc",
+    authorization: {
+      params: {
+        scope: "offline_access openid email profile",
+      },
+    },
+    profile(profile) {
+      return {
+        id: profile.sub,
+        name: profile.name ?? profile.username,
+        email: profile.email,
+        image: profile.picture,
+      }
+    },
+    options,
+  }
+}

package/src/providers/loops.ts

@@ -0,0 +1,79 @@
+/**
+ * <div style={{backgroundColor: "#24292f", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Loops</b> integration.</span>
+ * <a href="https://loops.so">
+ *  <img style={{display: "block"}} src="https://authjs.dev/img/providers/loops.svg" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/loops
+ */
+
+import type { EmailConfig, EmailUserConfig } from "./email.js"
+
+export type LoopsUserConfig = Omit<Partial<LoopsConfig>, "options" | "type">
+
+export interface LoopsConfig
+  extends Omit<EmailConfig, "sendVerificationRequest" | "options"> {
+  id: string
+  apiKey: string
+  transactionalId: string
+  sendVerificationRequest: (params: Params) => Promise<void>
+  options: LoopsUserConfig
+}
+
+type Params = Parameters<EmailConfig["sendVerificationRequest"]>[0] & {
+  provider: LoopsConfig
+}
+
+/**
+ *
+ * @param config
+ * @returns LoopsConfig
+ * @requires LoopsUserConfig
+ * @example
+ * ```ts
+ * Loops({
+ *   apiKey: process.env.AUTH_LOOPS_KEY,
+ *   transactionalId: process.env.AUTH_LOOPS_TRANSACTIONAL_ID,
+ * })
+ * ```
+ *
+ * @typedef LoopsUserConfig
+ */
+
+export default function Loops(config: LoopsUserConfig): LoopsConfig {
+  return {
+    id: "loops",
+    apiKey: "",
+    type: "email",
+    name: "Loops",
+    from: "Auth.js <no-reply@authjs.dev>",
+    maxAge: 24 * 60 * 60,
+    transactionalId: config.transactionalId || "",
+    async sendVerificationRequest(params: Params) {
+      const { identifier: to, provider, url } = params
+      if (!provider.apiKey || !provider.transactionalId)
+        throw new TypeError("Missing Loops API Key or TransactionalId")
+
+      const res = await fetch("https://app.loops.so/api/v1/transactional", {
+        method: "POST",
+        headers: {
+          Authorization: `Bearer ${provider.apiKey}`,
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+          transactionalId: provider.transactionalId,
+          email: to,
+          dataVariables: {
+            url: url,
+          },
+        }),
+      })
+      if (!res.ok) {
+        throw new Error("Loops Send Error: " + JSON.stringify(await res.json()))
+      }
+    },
+    options: config,
+  }
+}

package/src/providers/mailchimp.ts

@@ -0,0 +1,90 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Mailchimp</b> integration.</span>
+ * <a href="https://mailchimp.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/mailchimp.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/mailchimp
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * Add Mailchimp login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/mailchimp
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Mailchimp from "@auth/core/providers/mailchimp"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Mailchimp({
+ *       clientId: MAILCHIMP_CLIENT_ID,
+ *       clientSecret: MAILCHIMP_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Mailchimp OAuth documentation](https://admin.mailchimp.com/account/oauth2/client/)
+ *  - [Mailchimp documentation: Access user data](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Mailchimp provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Mailchimp provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/mailchimp.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 Mailchimp(
+  config: OAuthUserConfig<Record<string, any>>
+): OAuthConfig<Record<string, any>> {
+  return {
+    id: "mailchimp",
+    name: "Mailchimp",
+    type: "oauth",
+    authorization: "https://login.mailchimp.com/oauth2/authorize",
+    token: "https://login.mailchimp.com/oauth2/token",
+    userinfo: "https://login.mailchimp.com/oauth2/metadata",
+    profile(profile) {
+      return {
+        id: profile.login.login_id,
+        name: profile.accountname,
+        email: profile.login.email,
+        image: null,
+      }
+    },
+    style: {
+      bg: "#000",
+      text: "#fff",
+    },
+    options: config,
+  }
+}

package/src/providers/mailgun.ts

@@ -0,0 +1,98 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Mailgun</b> integration.</span>
+ * <a href="https://www.mailgun.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/mailgun.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/mailgun
+ */
+import type { EmailConfig, EmailUserConfig } from "./index.js"
+import { html, text } from "../lib/utils/email.js"
+
+/**
+ * Add Mailgun login to your page.
+ *
+ * ### Setup
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Mailgun from "@auth/core/providers/mailgun"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Mailgun({
+ *       from: MAILGUN_DOMAIN,
+ *       region: "EU", // Optional
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Mailgun documentation](https://documentation.mailgun.com/docs/mailgun)
+ *
+ * :::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 MailGun(
+  config: EmailUserConfig & {
+    /**
+     * https://documentation.mailgun.com/docs/mailgun/api-reference/#base-url
+     *
+     * @default "US"
+     */
+    region?: "US" | "EU"
+  }
+): EmailConfig {
+  const { region = "US" } = config
+  const servers = {
+    US: "api.mailgun.net",
+    EU: "api.eu.mailgun.net",
+  }
+  const apiServer = servers[region]
+
+  return {
+    id: "mailgun",
+    type: "email",
+    name: "Mailgun",
+    from: "Auth.js <no-reply@authjs.dev>",
+    maxAge: 24 * 60 * 60,
+    async sendVerificationRequest(params) {
+      const { identifier: to, provider, url, theme } = params
+      const { host } = new URL(url)
+      const domain = provider.from?.split("@").at(1)
+
+      if (!domain) throw new Error("malformed Mailgun domain")
+
+      const form = new FormData()
+      form.append("from", `${provider.name} <${provider.from}>`)
+      form.append("to", to)
+      form.append("subject", `Sign in to ${host}`)
+      form.append("html", html({ host, url, theme }))
+      form.append("text", text({ host, url }))
+
+      const res = await fetch(`https://${apiServer}/v3/${domain}/messages`, {
+        method: "POST",
+        headers: {
+          Authorization: `Basic ${btoa(`api:${provider.apiKey}`)}`,
+        },
+        body: form,
+      })
+
+      if (!res.ok) throw new Error("Mailgun error: " + (await res.text()))
+    },
+    options: config,
+  }
+}

package/src/providers/mailru.ts

@@ -0,0 +1,75 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Mailru</b> integration.</span>
+ * <a href="https://mail.ru">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/mailru.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/mailru
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * Add Mailru login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/mailru
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Mailru from "@auth/core/providers/mailru"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Mailru({ clientId: MAILRU_CLIENT_ID, clientSecret: MAILRU_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Mailru OAuth documentation](https://o2.mail.ru/docs)
+ *  - [Mailru app console](https://o2.mail.ru/app/)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Mailru provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Mailru provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/ma.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 Mailru(
+  config: OAuthUserConfig<Record<string, any>>
+): OAuthConfig<Record<string, any>> {
+  return {
+    id: "mailru",
+    name: "Mail.ru",
+    type: "oauth",
+    authorization: "https://oauth.mail.ru/login?scope=userinfo",
+    token: "https://oauth.mail.ru/token",
+    userinfo: "https://oauth.mail.ru/userinfo",
+    options: config,
+  }
+}