@mulverse/mulguard-core 1.0.0

package/src/providers/mastodon.ts

@@ -0,0 +1,112 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Mastodon</b> integration.</span>
+ * <a href="https://mastodon.social">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/mastodon.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/mastodon
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export interface MastodonProfile extends Record<string, any> {
+  id: string
+  username: string
+  acct: string
+  display_name: string
+  locked: boolean
+  bot: boolean
+  created_at: string
+  note: string
+  url: string
+  avatar: string
+  avatar_static: string
+  header: string
+  header_static: string
+  followers_count: number
+  following_count: number
+  statuses_count: number
+  last_status_at: string | null
+}
+
+/**
+ * Add Mastodon login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/mastodon
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Mastodon from "@auth/core/providers/mastodon"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Mastodon({
+ *       clientId: MASTODON_CLIENT_ID,
+ *       clientSecret: MASTODON_CLIENT_SECRET,
+ *       issuer: MASTODON_ISSUER,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Mastodon OAuth documentation](https://docs.joinmastodon.org/client/token/)
+ *  - [Mastodon OAuth Configuration](https://mastodon.social/settings/applications)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Mastodon provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * Due to Mastodons infrastructure beeing a Fediverse you have to define the `issuer` you want to connect to.
+ *
+ * :::tip
+ *
+ * The Mastodon provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/mastodon.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 Mastodon<P extends MastodonProfile>(
+  options: OAuthUserConfig<P> & {
+    issuer: string
+  }
+): OAuthConfig<P> {
+  return {
+    id: "mastodon",
+    name: "Mastodon",
+    type: "oauth",
+    authorization: `${options.issuer}/oauth/authorize?scope=read`,
+    token: `${options.issuer}/oauth/token`,
+    userinfo: `${options.issuer}/api/v1/accounts/verify_credentials`,
+    profile(profile) {
+      return {
+        id: profile.id,
+        name: profile.username,
+        image: profile.avatar_static,
+        email: null,
+      }
+    },
+    options,
+  }
+}

package/src/providers/mattermost.ts

@@ -0,0 +1,154 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Mattermost</b> integration.</span>
+ * <a href="https://mattermost.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/mattermost.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/mattermost
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./oauth.js"
+
+/** [Get a user](https://api.mattermost.com/#tag/users/operation/GetUser) */
+export interface MattermostProfile {
+  id: string
+  /** The time in milliseconds a user was created */
+  create_at: number
+  /** The time in milliseconds a user was last updated */
+  update_at: number
+  /** The time in milliseconds a user was deleted */
+  delete_at: number
+  username: string
+  auth_data: string
+  auth_service: string
+  email: string
+  email_verified: boolean
+  nickname: string
+  first_name: string
+  last_name: string
+  position: string
+  roles: string
+  notify_props: {
+    /** Set to "true" to enable channel-wide notifications (@channel, @all, etc.), "false" to disable. Defaults to "true". */
+    channel: string
+    comments: string
+    /** Set to "all" to receive desktop notifications for all activity, "mention" for mentions and direct messages only, and "none" to disable. Defaults to "all". */
+    desktop: string
+    /** Set to "true" to enable sound on desktop notifications, "false" to disable. Defaults to "true". */
+    desktop_sound: string
+    desktop_threads: string
+    /** Set to "true" to enable email notifications, "false" to disable. Defaults to "true". */
+    email: string
+    email_threads: string
+    /** Set to "true" to enable mentions for first name. Defaults to "true" if a first name is set, "false" otherwise. */
+    first_name: string
+    /** A comma-separated list of words to count as mentions. Defaults to username and @username. */
+    mention_keys: string
+    /** Set to "all" to receive push notifications for all activity, "mention" for mentions and direct messages only, and "none" to disable. Defaults to "mention". */
+    push: string
+    push_status: string
+    push_threads: string
+  }
+  last_password_update: number
+  locale: string
+  timezone: {
+    /** This value is set automatically when the "useAutomaticTimezone" is set to "true". */
+    automaticTimezone: string
+    /** Value when setting manually the timezone, i.e. "Europe/Berlin". */
+    manualTimezone: string
+    /** Set to "true" to use the browser/system timezone, "false" to set manually. Defaults to "true". */
+    useAutomaticTimezone: string
+  }
+  disable_welcome_email: boolean
+  /** ID of accepted terms of service, if any. This field is not present if empty. */
+  terms_of_service_id?: string
+  /** The time in milliseconds the user accepted the terms of service */
+  terms_of_service_create_at?: number
+}
+/**
+ * Add Mattermost login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/mattermost
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Mattermost from "@auth/core/providers/mattermost"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Mattermost({
+ *       clientId: MATTERMOST_CLIENT_ID,
+ *       clientSecret: MATTERMOST_CLIENT_SECRET,
+ *       issuer: MATTERMOST_ISSUER, // The base url of your Mattermost instance. e.g `https://my-cool-server.cloud.mattermost.com`
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Mattermost OAuth documentation](https://example.com)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Mattermost provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * To create your Mattermost OAuth2 app visit `http://<your Mattermost instance url>/<your team>/integrations/oauth2-apps`
+ *
+ * :::warning
+ *
+ * The Mattermost provider requires the `issuer` option to be set. This is the base url of your Mattermost instance. e.g https://my-cool-server.cloud.mattermost.com
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The Mattermost provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/mattermost.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 Mattermost<P extends MattermostProfile>(
+  config: OAuthUserConfig<P> & { issuer: string }
+): OAuthConfig<P> {
+  const { issuer, ...rest } = config
+
+  return {
+    id: "mattermost",
+    name: "Mattermost",
+    type: "oauth",
+    client: { token_endpoint_auth_method: "client_secret_post" },
+    token: `${issuer}/oauth/access_token`,
+    authorization: `${issuer}/oauth/authorize`,
+    userinfo: `${issuer}/api/v4/users/me`,
+    profile(profile) {
+      return {
+        id: profile.id,
+        name: profile.username ?? `${profile.first_name} ${profile.last_name}`,
+        email: profile.email,
+        image: null,
+      }
+    },
+    style: { bg: "#000", text: "#fff" },
+    options: rest,
+  }
+}

package/src/providers/medium.ts

@@ -0,0 +1,89 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Medium</b> integration.</span>
+ * <a href="https://medium.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/medium.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/medium
+ */
+
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * Add Medium login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/medium
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Medium from "@auth/core/providers/medium"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Medium({ clientId: MEDIUM_CLIENT_ID, clientSecret: MEDIUM_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ *  - [Medium OAuth documentation](https://example.com)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Medium provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::warning
+ *
+ * Email address is not returned by the Medium API.
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The Medium provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/medium.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 Medium(
+  config: OAuthUserConfig<Record<string, any>>
+): OAuthConfig<Record<string, any>> {
+  return {
+    id: "medium",
+    name: "Medium",
+    type: "oauth",
+    authorization: "https://medium.com/m/oauth/authorize?scope=basicProfile",
+    token: "https://api.medium.com/v1/tokens",
+    userinfo: "https://api.medium.com/v1/me",
+    profile(profile) {
+      return {
+        id: profile.data.id,
+        name: profile.data.name,
+        email: null,
+        image: profile.data.imageUrl,
+      }
+    },
+    options: config,
+  }
+}