@mulverse/mulguard-core 1.0.0

package/src/providers/simplelogin.ts

@@ -0,0 +1,107 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>SimpleLogin</b> integration.</span>
+ * <a href="https://simplelogin.io">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/simplelogin.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/simplelogin
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface SimpleLoginProfile {
+  id: number
+  sub: string
+  email: string
+  email_verified: boolean
+  name: string
+  avatar_url: string | undefined
+  client: string
+}
+
+/**
+ * Add SimpleLogin login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/simplelogin
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import SimpleLogin from "@auth/core/providers/simplelogin"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     SimpleLogin({
+ *       clientId: SIMPLELOGIN_CLIENT_ID,
+ *       clientSecret: SIMPLELOGIN_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Sign in with SimpleLogin](https://simplelogin.io/developer/)
+ *  - [SimpleLogin OAuth documentation](https://simplelogin.io/docs/siwsl/intro/)
+ *  - [SimpleLogin OAuth Configuration](https://app.simplelogin.io/developer)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the SimpleLogin provider is
+ * based on the [Open ID Connect](https://openid.net/specs/openid-connect-core-1_0.html) specification.
+ *
+ * The "Authorized redirect URIs" used must include your full domain and end in the callback path. By default, SimpleLogin whitelists all `http[s]://localhost:*` address to facilitate local development. For example;
+ *
+ * - For production: `https://{YOUR_DOMAIN}/api/auth/callback/simplelogin`
+ * - For development: By default **localhost** is whitelisted.
+ *
+ * :::warning
+ *
+ * **Authorized Redirect URIs** must be **HTTPS** for security reason (except for `localhost`).
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The SimpleLogin provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/simplelogin.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 SimpleLogin<P extends SimpleLoginProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "simplelogin",
+    name: "SimpleLogin",
+    type: "oidc",
+    issuer: "https://app.simplelogin.io",
+    profile(profile) {
+      return {
+        id: profile.sub,
+        name: profile.name,
+        email: profile.email,
+        image: profile.avatar_url,
+      }
+    },
+    style: { brandColor: "#e3156a" },
+    options,
+  }
+}

package/src/providers/slack.ts

@@ -0,0 +1,115 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Slack</b> integration.</span>
+ * <a href="https://www.slack.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/slack.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/slack
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface SlackProfile extends Record<string, any> {
+  ok: boolean
+  sub: string
+  "https://slack.com/user_id": string
+  "https://slack.com/team_id": string
+  email: string
+  email_verified: boolean
+  date_email_verified: number
+  name: string
+  picture: string
+  given_name: string
+  family_name: string
+  locale: string
+  "https://slack.com/team_name": string
+  "https://slack.com/team_domain": string
+  "https://slack.com/user_image_24": string
+  "https://slack.com/user_image_32": string
+  "https://slack.com/user_image_48": string
+  "https://slack.com/user_image_72": string
+  "https://slack.com/user_image_192": string
+  "https://slack.com/user_image_512": string
+  "https://slack.com/user_image_1024": string
+  "https://slack.com/team_image_34": string
+  "https://slack.com/team_image_44": string
+  "https://slack.com/team_image_68": string
+  "https://slack.com/team_image_88": string
+  "https://slack.com/team_image_102": string
+  "https://slack.com/team_image_132": string
+  "https://slack.com/team_image_230": string
+  "https://slack.com/team_image_default": boolean
+}
+
+/**
+ * Add Slack login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/slack
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Slack from "@auth/core/providers/slack"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Slack({ clientId: SLACK_CLIENT_ID, clientSecret: SLACK_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Slack Authentication documentation](https://api.slack.com/authentication)
+ * - [Sign-in with Slack](https://api.slack.com/docs/sign-in-with-slack)
+ * - [Slack app console](https://api.slack.com/apps)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Slack provider is
+ * based on the [Open ID Connect](https://openid.net/specs/openid-connect-core-1_0.html) specification.
+ *
+ * :::danger
+ *
+ * Slack requires that the redirect URL of your app uses https, even for local development.
+ * An easy workaround for this is using a service like [ngrok](https://ngrok.com/) that creates a secure tunnel to your app, using https. Remember to set the url as `NEXTAUTH_URL` as well.
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The Slack provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/slack.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 Slack<P extends SlackProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "slack",
+    name: "Slack",
+    type: "oidc",
+    issuer: "https://slack.com",
+    checks: ["nonce"],
+    style: { brandColor: "#611f69" },
+    options,
+  }
+}

package/src/providers/spotify.ts

@@ -0,0 +1,99 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Spotify</b> integration.</span>
+ * <a href="https://www.spotify.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/spotify.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/spotify
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface SpotifyImage {
+  url: string
+}
+
+export interface SpotifyProfile extends Record<string, any> {
+  id: string
+  display_name: string
+  email: string
+  images: SpotifyImage[]
+}
+
+/**
+ * Add Spotify login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/spotify
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Spotify from "@auth/core/providers/spotify"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Spotify({
+ *       clientId: SPOTIFY_CLIENT_ID,
+ *       clientSecret: SPOTIFY_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Spotify OAuth documentation](https://developer.spotify.com/documentation/general/guides/authorization-guide)
+ * - [Spotify app console](https://developer.spotify.com/dashboard/applications)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Spotify provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Spotify provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/spotify.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 Spotify<P extends SpotifyProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "spotify",
+    name: "Spotify",
+    type: "oauth",
+    authorization:
+      "https://accounts.spotify.com/authorize?scope=user-read-email",
+    token: "https://accounts.spotify.com/api/token",
+    userinfo: "https://api.spotify.com/v1/me",
+    profile(profile) {
+      return {
+        id: profile.id,
+        name: profile.display_name,
+        email: profile.email,
+        image: profile.images?.[0]?.url,
+      }
+    },
+    style: { brandColor: "#1db954" },
+    options,
+  }
+}

package/src/providers/strava.ts

@@ -0,0 +1,101 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Strava</b> integration.</span>
+ * <a href="https://www.strava.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/strava.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/strava
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface StravaProfile extends Record<string, any> {
+  id: string // this is really a number
+  firstname: string
+  lastname: string
+  profile: string
+}
+
+/**
+ * Add Strava login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/strava
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Strava from "@auth/core/providers/strava"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Strava({ clientId: STRAVA_CLIENT_ID, clientSecret: STRAVA_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Strava API documentation](http://developers.strava.com/docs/reference/)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Strava provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Strava provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/strava.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 Strava<P extends StravaProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "strava",
+    name: "Strava",
+    type: "oauth",
+    authorization: {
+      url: "https://www.strava.com/api/v3/oauth/authorize",
+      params: {
+        scope: "read",
+        approval_prompt: "auto",
+        response_type: "code",
+      },
+    },
+    token: {
+      url: "https://www.strava.com/api/v3/oauth/token",
+    },
+    userinfo: "https://www.strava.com/api/v3/athlete",
+    client: {
+      token_endpoint_auth_method: "client_secret_post",
+    },
+    profile(profile) {
+      return {
+        id: profile.id,
+        name: `${profile.firstname} ${profile.lastname}`,
+        email: null,
+        image: profile.profile,
+      }
+    },
+    options,
+  }
+}

package/src/providers/threads.ts

@@ -0,0 +1,135 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Threads</b> integration.</span>
+ * <a href="https://www.threads.net/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/threads.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/threads
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * [User](https://developers.facebook.com/docs/threads/reference/user)
+ */
+export interface ThreadsProfile {
+  data: {
+    /**
+     * Unique identifier of this user. This is returned as a string in order to avoid complications with languages and tools
+     * that cannot handle large integers.
+     */
+    id: string
+    /**
+     * The Threads handle (username) of this user.
+     *
+     * To return this field, add `fields=username` in the authorization request's query parameter.
+     */
+    username?: string
+    /**
+     * The URL to the profile image for this user, as shown on the user's profile.
+     *
+     * To return this field, add `fields=threads_profile_picture_url` in the authorization request's query parameter.
+     */
+    threads_profile_picture_url?: string
+    /**
+     * The text of this user's profile biography (also known as bio), if the user provided one.
+     *
+     * To return this field, add `fields=threads_biography` in the authorization request's query parameter.
+     */
+    threads_biography?: string
+  }
+}
+
+/**
+ * Add Threads login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/threads
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Threads from "@auth/core/providers/threads"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Threads({
+ *       clientId: THREADS_CLIENT_ID,
+ *       clientSecret: THREADS_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Threads OAuth documentation](https://developers.facebook.com/docs/threads)
+ * - [Threads OAuth apps](https://developers.facebook.com/apps/)
+ *
+ * ### Notes
+ *
+ * :::warning
+ *
+ * Email address is not returned by the Threads API.
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * Threads required callback URL to be configured in your Facebook app and Facebook required you to use **https** even for localhost! In order to do that, you either need to [add an SSL to your localhost](https://www.freecodecamp.org/news/how-to-get-https-working-on-your-local-development-environment-in-5-minutes-7af615770eec/) or use a proxy such as [ngrok](https://ngrok.com/docs).
+ *
+ * :::
+ *
+ * By default, Auth.js assumes that the Threads provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Threads provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/threads.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 Threads(
+  config: OAuthUserConfig<ThreadsProfile>
+): OAuthConfig<ThreadsProfile> {
+  return {
+    id: "threads",
+    name: "Threads",
+    type: "oauth",
+    checks: ["state"],
+    authorization: "https://threads.net/oauth/authorize?scope=threads_basic",
+    token: "https://graph.threads.net/oauth/access_token",
+    userinfo:
+      "https://graph.threads.net/v1.0/me?fields=id,username,threads_profile_picture_url",
+    client: {
+      token_endpoint_auth_method: "client_secret_post",
+    },
+    profile({ data }) {
+      return {
+        id: data.id,
+        name: data.username || null,
+        email: null,
+        image: data.threads_profile_picture_url || null,
+      }
+    },
+    style: { bg: "#000", text: "#fff" },
+    options: config,
+  }
+}