@mulverse/mulguard-core 1.0.0

package/src/providers/eveonline.ts

@@ -0,0 +1,117 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>EVEOnline</b> integration.</span>
+ * <a href="https://eveonline.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/eveonline.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/eveonline
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface EVEOnlineProfile extends Record<string, any> {
+  CharacterID: number
+  CharacterName: string
+  ExpiresOn: string
+  Scopes: string
+  TokenType: string
+  CharacterOwnerHash: string
+  IntellectualProperty: string
+}
+
+/**
+ * Add EveOnline login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/eveonline
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import EveOnline from "@auth/core/providers/eveonline"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     EveOnline({
+ *       clientId: EVEONLINE_CLIENT_ID,
+ *       clientSecret: EVEONLINE_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [EveOnline OAuth documentation](https://developers.eveonline.com/blog/article/sso-to-authenticated-calls)
+ *
+ * ### Notes
+ *
+ * :::tip
+ * When creating your application, make sure to select `Authentication Only` as the connection type.
+ * :::
+ *
+ * :::tip
+ * If using JWT for the session, you can add the `CharacterID` to the JWT and session. Example:
+ * ```ts
+ * options: {
+ *   jwt: {
+ *     secret: process.env.JWT_SECRET,
+ *   },
+ *   callbacks: {
+ *     session: async ({ session, token }) => {
+ *       session.user.id = token.id;
+ *       return session;
+ *     }
+ *   }
+ * }
+ * ```
+ * :::
+ * By default, Auth.js assumes that the EveOnline provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The EveOnline provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/eveonline.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 EVEOnline<P extends EVEOnlineProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "eveonline",
+    name: "EVE Online",
+    type: "oauth",
+    authorization:
+      "https://login.eveonline.com/v2/oauth/authorize?scope=publicData",
+    token: "https://login.eveonline.com/v2/oauth/token",
+    userinfo: "https://login.eveonline.com/oauth/verify",
+    checks: ["state"],
+    profile(profile) {
+      return {
+        id: String(profile.CharacterID),
+        name: profile.CharacterName,
+        email: null,
+        image: `https://image.eveonline.com/Character/${profile.CharacterID}_128.jpg`,
+      }
+    },
+    options,
+  }
+}

package/src/providers/facebook.ts

@@ -0,0 +1,119 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Facebook</b> integration.</span>
+ * <a href="https://facebook.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/facebook.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/facebook
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+interface FacebookPictureData {
+  url: string
+}
+
+interface FacebookPicture {
+  data: FacebookPictureData
+}
+export interface FacebookProfile extends Record<string, any> {
+  id: string
+  picture: FacebookPicture
+}
+
+/**
+ * Add Facebook login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/facebook
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Facebook from "@auth/core/providers/facebook"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Facebook({
+ *       clientId: FACEBOOK_CLIENT_ID,
+ *       clientSecret: FACEBOOK_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Facebook OAuth documentation](https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow/)
+ *
+ * ### Notes
+ *
+ * :::tip
+ * Production applications cannot use localhost URLs to sign in with Facebook. You need to use a dedicated development application in Facebook to use localhost callback URLs.
+ * :::
+ *
+ * :::tip
+ * Email address may not be returned for accounts created on mobile.
+ * :::
+ *
+ * By default, Auth.js assumes that the Facebook provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Facebook provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/facebook.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 Facebook<P extends FacebookProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "facebook",
+    name: "Facebook",
+    type: "oauth",
+    authorization: {
+      url: "https://www.facebook.com/v19.0/dialog/oauth",
+      params: {
+        scope: "email",
+      },
+    },
+    token: "https://graph.facebook.com/oauth/access_token",
+    userinfo: {
+      // https://developers.facebook.com/docs/graph-api/reference/user/#fields
+      url: "https://graph.facebook.com/me?fields=id,name,email,picture",
+      async request({ tokens, provider }) {
+        return await fetch(provider.userinfo?.url as URL, {
+          headers: { Authorization: `Bearer ${tokens.access_token}` },
+        }).then(async (res) => await res.json())
+      },
+    },
+    profile(profile: P) {
+      return {
+        id: profile.id,
+        name: profile.name,
+        email: profile.email,
+        image: profile.picture.data.url,
+      }
+    },
+    style: { bg: "#006aff", text: "#fff" },
+    options,
+  }
+}

package/src/providers/faceit.ts

@@ -0,0 +1,90 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>FACEIT</b> integration.</span>
+ * <a href="https://faceit.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/faceit.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/faceit
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * Add FACEIT login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/faceit
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import FACEIT from "@auth/core/providers/faceit"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     FACEIT({ clientId: FACEIT_CLIENT_ID, clientSecret: FACEIT_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [FACEIT OAuth documentation](https://cdn.faceit.com/third_party/docs/FACEIT_Connect_3.0.pdf)
+ *
+ * ### Notes
+ *
+ * Grant type: Authorization Code
+ * Scopes to have basic infos (email, nickname, guid and avatar) : openid, email, profile
+ * By default, Auth.js assumes that the FACEIT provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The FACEIT provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/faceit.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 FACEIT(
+  options: OAuthUserConfig<Record<string, any>>
+): OAuthConfig<Record<string, any>> {
+  return {
+    id: "faceit",
+    name: "FACEIT",
+    type: "oauth",
+    authorization: "https://accounts.faceit.com/accounts?redirect_popup=true",
+    // @ts-expect-error - TODO fix this
+    headers: {
+      Authorization: `Basic ${Buffer.from(
+        `${options.clientId}:${options.clientSecret}`
+      ).toString("base64")}`,
+    },
+    token: "https://api.faceit.com/auth/v1/oauth/token",
+    userinfo: "https://api.faceit.com/auth/v1/resources/userinfo",
+    profile(profile) {
+      return {
+        id: profile.guid,
+        name: profile.name,
+        email: profile.email,
+        image: profile.picture,
+      }
+    },
+    options,
+  }
+}

package/src/providers/figma.ts

@@ -0,0 +1,105 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Figma</b> integration.</span>
+ * <a href="https://figma.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/figma.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/figma
+ */
+import { OAuth2Config, OAuthUserConfig } from "./index.js"
+
+/**
+ * @see https://www.figma.com/developers/api#users-types
+ */
+interface FigmaProfile {
+  id: string
+  email: string
+  handle: string
+  img_url: string
+}
+
+/**
+ * ### Setup
+ *
+ * #### Callback URL
+ *
+ * ```ts
+ * https://example.com/api/auth/callback/figma
+ * ```
+ *
+ * #### Configuration
+ *
+ * ```ts
+ * import { Auth } from "@auth/core"
+ * import Figma from "@auth/core/providers/figma"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Figma({
+ *       clientId: process.env.AUTH_FIGMA_ID,
+ *       clientSecret: process.env.AUTH_FIGMA_SECRET
+ *     })
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Using OAuth 2 on Figma](https://www.figma.com/developers/api#oauth2)
+ * - [Scopes](https://www.figma.com/developers/api#authentication-scopes)
+ *
+ * #### Notes
+ *
+ * By default, Auth.js assumes that the Figma provider is based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Figma provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/figma.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 Figma(
+  options: OAuthUserConfig<FigmaProfile>
+): OAuth2Config<FigmaProfile> {
+  return {
+    id: "figma",
+    name: "Figma",
+    type: "oauth",
+    authorization: {
+      url: "https://www.figma.com/oauth",
+      params: {
+        scope: "files:read",
+      },
+    },
+    checks: ["state"],
+    token: "https://api.figma.com/v1/oauth/token",
+    userinfo: "https://api.figma.com/v1/me",
+    profile(profile) {
+      return {
+        name: profile.handle,
+        email: profile.email,
+        id: profile.id,
+        image: profile.img_url,
+      }
+    },
+    style: {
+      text: "#fff",
+      bg: "#ff7237",
+    },
+    options,
+  }
+}

package/src/providers/forwardemail.ts

@@ -0,0 +1,37 @@
+import type { EmailConfig, EmailUserConfig } from "./index.js"
+import { html, text } from "../lib/utils/email.js"
+
+/** @todo Document this */
+export default function ForwardEmail(config: EmailUserConfig): EmailConfig {
+  return {
+    id: "forwardemail",
+    type: "email",
+    name: "Forward Email",
+    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 res = await fetch("https://api.forwardemail.net/v1/emails", {
+        method: "POST",
+        headers: {
+          Authorization: `Basic ${btoa(provider.apiKey + ":")}`,
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+          from: provider.from,
+          to,
+          subject: `Sign in to ${host}`,
+          html: html({ url, host, theme }),
+          text: text({ url, host }),
+        }),
+      })
+
+      if (!res.ok)
+        throw new Error(
+          "Forward Email error: " + JSON.stringify(await res.json())
+        )
+    },
+    options: config,
+  }
+}

package/src/providers/foursquare.ts

@@ -0,0 +1,105 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>FourSquare</b> integration.</span>
+ * <a href="https://foursquare.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/foursquare.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/foursquare
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * Add FourSquare login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/foursquare
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import FourSquare from "@auth/core/providers/foursquare"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     FourSquare({
+ *       clientId: FOURSQUARE_CLIENT_ID,
+ *       clientSecret: FOURSQUARE_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [FourSquare OAuth documentation](https://docs.foursquare.com/developer/reference/authentication)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the FourSquare provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::warning
+ * Foursquare requires an additional apiVersion parameter in YYYYMMDD format, which essentially states "I'm prepared for API changes up to this date".
+ * :::
+ *
+ * :::tip
+ *
+ * The FourSquare provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/foursquare.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 Foursquare(
+  options: OAuthUserConfig<Record<string, any>> & { apiVersion?: string }
+): OAuthConfig<Record<string, any>> {
+  const { apiVersion = "20230131" } = options
+  return {
+    id: "foursquare",
+    name: "Foursquare",
+    type: "oauth",
+    authorization: "https://foursquare.com/oauth2/authenticate",
+    token: "https://foursquare.com/oauth2/access_token",
+    userinfo: {
+      url: `https://api.foursquare.com/v2/users/self?v=${apiVersion}`,
+      async request({ tokens, provider }) {
+        if (!provider.userinfo) return
+
+        const url = new URL(provider.userinfo.url)
+        url.searchParams.append("oauth_token", tokens.access_token!)
+        return fetch(url).then((res) => res.json())
+      },
+    },
+    profile({ response: { user: profile } }) {
+      return {
+        id: profile.id,
+        name: `${profile.firstName} ${profile.lastName}`,
+        email: profile.contact.email,
+        image: profile.photo
+          ? `${profile.photo.prefix}original${profile.photo.suffix}`
+          : null,
+      }
+    },
+    style: {
+      bg: "#000",
+      text: "#fff",
+    },
+    options,
+  }
+}

package/src/providers/freshbooks.ts

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