@mulverse/mulguard-core 1.0.0

package/src/providers/webex.ts

@@ -0,0 +1,102 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Webex</b> integration.</span>
+ * <a href="https://webex.com">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/webex.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/webex
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * The returned user profile from Webex when using the profile callback.
+ *
+ * Please refer to {@link https://developer.webex.com/docs/api/v1/people/get-my-own-details People - Get My Own Details}
+ * on Webex Developer portal for additional fields. Returned fields may vary depending on the user's role, the OAuth
+ * integration's scope, and the organization the OAuth integration belongs to.
+ */
+export interface WebexProfile extends Record<string, any> {
+  id: string
+  emails: string[]
+  displayName?: string
+  avatar?: string
+}
+
+/**
+ * Add Webex login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/webex
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Webex from "@auth/core/providers/webex"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Webex({ clientId: WEBEX_CLIENT_ID, clientSecret: WEBEX_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Webex OAuth 2.0 Integration Guide](https://developer.webex.com/docs/integrations)
+ * - [Login with Webex](https://developer.webex.com/docs/login-with-webex)
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the Webex provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Webex provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/webex.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 Webex<P extends WebexProfile>(
+  config: OAuthUserConfig<P> & { apiBaseUrl?: string }
+): OAuthConfig<P> {
+  const apiBaseUrl = config?.apiBaseUrl ?? "https://webexapis.com/v1"
+
+  return {
+    id: "webex",
+    name: "Webex",
+    type: "oauth",
+    authorization: {
+      url: `${apiBaseUrl}/authorize`,
+      params: { scope: "spark:kms spark:people_read" },
+    },
+    token: `${apiBaseUrl}/access_token`,
+    userinfo: `${apiBaseUrl}/people/me`,
+    profile(profile) {
+      return {
+        id: profile.id,
+        email: profile.emails[0],
+        name: profile.displayName,
+        image: profile.avatar,
+      }
+    },
+    options: config,
+  }
+}

package/src/providers/wechat.ts

@@ -0,0 +1,141 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#24292f", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>WeChat</b> integration.</span>
+ * <a href="https://www.wechat.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/wechat.svg" height="48" width="48"/>
+ * </a>
+ * </div>
+ *
+ * @module providers/wechat
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/** @see [Get the authenticated user](https://developers.weixin.qq.com/doc/oplatform/Website_App/WeChat_Login/Authorized_Interface_Calling_UnionID.html) */
+export interface WeChatProfile {
+  openid: string
+  nickname: string
+  sex: number
+  province: string
+  city: string
+  country: string
+  headimgurl: string
+  privilege: string[]
+  unionid: string
+  [claim: string]: unknown
+}
+
+/**
+ * Add WeChat login to your page and make requests to [WeChat APIs](https://developers.weixin.qq.com/doc/oplatform/Website_App/WeChat_Login/Authorized_Interface_Calling_UnionID.html).
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/wechat
+ * ```
+ *
+ * #### Configuration
+ * ```ts
+ * import { Auth } from "@auth/core"
+ * import WeChat from "@auth/core/providers/wechat"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [WeChat({
+ *     clientId: AUTH_WECHAT_APP_ID,
+ *     clientSecret: AUTH_WECHAT_APP_SECRET,
+ *     platformType: "OfficialAccount",
+ *   })],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [WeChat Official Account](https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Overview.html)
+ * - [WeChat Official Account - Webpage Authorization](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html)
+ * - [WeChat Official Account Test Account](https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=sandbox/login)
+ * - [WeChat WebsiteApp Login](https://developers.weixin.qq.com/doc/oplatform/Website_App/WeChat_Login/Wechat_Login.html)
+ * - [使用微信测试账号对网页进行授权](https://cloud.tencent.com/developer/article/1703167)
+ *
+ * :::tip
+ *
+ * The WeChat provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/wechat.ts).
+ * To override the defaults for your use case, check out [customizing a built-in OAuth provider](https://authjs.dev/guides/providers/custom-provider#override-default-options).
+ *
+ * :::
+ *
+ * :::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 WeChat(
+  options: OAuthUserConfig<WeChatProfile> & {
+    platformType?: "OfficialAccount" | "WebsiteApp"
+  }
+): OAuthConfig<WeChatProfile> {
+  const { clientId, clientSecret, platformType = "OfficialAccount" } = options
+
+  return {
+    id: "wechat",
+    name: "WeChat",
+    type: "oauth",
+    style: { logo: "/wechat.svg", bg: "#fff", text: "#000" },
+    checks: ["state"],
+    authorization: {
+      url:
+        platformType === "OfficialAccount"
+          ? "https://open.weixin.qq.com/connect/oauth2/authorize"
+          : "https://open.weixin.qq.com/connect/qrconnect",
+      params: {
+        appid: clientId,
+        scope:
+          platformType === "OfficialAccount"
+            ? "snsapi_userinfo"
+            : "snsapi_login",
+      },
+    },
+    token: {
+      url: "https://api.weixin.qq.com/sns/oauth2/access_token",
+      params: { appid: clientId, secret: clientSecret },
+      async conform(response) {
+        const data = await response.json()
+        if (data.token_type === "bearer") {
+          console.warn(
+            "token_type is 'bearer'. Redundant workaround, please open an issue."
+          )
+          return response
+        }
+        return Response.json({ ...data, token_type: "bearer" }, response)
+      },
+    },
+    userinfo: {
+      url: "https://api.weixin.qq.com/sns/userinfo",
+      async request({ tokens, provider }) {
+        if (!provider.userinfo) return
+
+        const url = new URL(provider.userinfo.url)
+        url.searchParams.set("access_token", tokens.access_token!)
+        url.searchParams.set("openid", String(tokens.openid))
+        url.searchParams.set("lang", "zh_CN")
+        const response = await fetch(url)
+        return response.json()
+      },
+    },
+    profile(profile) {
+      return {
+        id: profile.unionid,
+        name: profile.nickname,
+        email: null,
+        image: profile.headimgurl,
+      }
+    },
+    options,
+  }
+}

package/src/providers/wikimedia.ts

@@ -0,0 +1,258 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b> Wikimedia</b> integration.</span>
+ * <a href="https://mediawiki.org/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/wikimedia.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/wikimedia
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+export type WikimediaGroup =
+  | "*"
+  | "user"
+  | "autoconfirmed"
+  | "extendedconfirmed"
+  | "bot"
+  | "sysop"
+  | "bureaucrat"
+  | "steward"
+  | "accountcreator"
+  | "import"
+  | "transwiki"
+  | "ipblock-exempt"
+  | "oversight"
+  | "rollbacker"
+  | "propertycreator"
+  | "wikidata-staff"
+  | "flood"
+  | "translationadmin"
+  | "confirmed"
+  | "flow-bot"
+  | "checkuser"
+
+export type WikimediaGrant =
+  | "basic"
+  | "blockusers"
+  | "checkuser"
+  | "createaccount"
+  | "delete"
+  | "editinterface"
+  | "editmycssjs"
+  | "editmyoptions"
+  | "editmywatchlist"
+  | "editpage"
+  | "editprotected"
+  | "editsiteconfig"
+  | "globalblock"
+  | "highvolume"
+  | "import"
+  | "mergehistory"
+  | "oath"
+  | "oversight"
+  | "patrol"
+  | "privateinfo"
+  | "protect"
+  | "rollback"
+  | "sendemail"
+  | "shortenurls"
+  | "uploadfile"
+  | "viewdeleted"
+  | "viewmywatchlist"
+
+export type WikimediaRight =
+  | "abusefilter-log"
+  | "apihighlimits"
+  | "applychangetags"
+  | "autoconfirmed"
+  | "autopatrol"
+  | "autoreview"
+  | "bigdelete"
+  | "block"
+  | "blockemail"
+  | "bot"
+  | "browsearchive"
+  | "changetags"
+  | "checkuser"
+  | "checkuser-log"
+  | "createaccount"
+  | "createpage"
+  | "createpagemainns"
+  | "createtalk"
+  | "delete"
+  | "delete-redirect"
+  | "deletedhistory"
+  | "deletedtext"
+  | "deletelogentry"
+  | "deleterevision"
+  | "edit"
+  | "edit-legal"
+  | "editinterface"
+  | "editmyoptions"
+  | "editmyusercss"
+  | "editmyuserjs"
+  | "editmyuserjson"
+  | "editmywatchlist"
+  | "editprotected"
+  | "editsemiprotected"
+  | "editsitecss"
+  | "editsitejs"
+  | "editsitejson"
+  | "editusercss"
+  | "edituserjs"
+  | "edituserjson"
+  | "globalblock"
+  | "import"
+  | "importupload"
+  | "ipblock-exempt"
+  | "item-merge"
+  | "item-redirect"
+  | "item-term"
+  | "markbotedits"
+  | "massmessage"
+  | "mergehistory"
+  | "minoredit"
+  | "move"
+  | "move-subpages"
+  | "movefile"
+  | "movestable"
+  | "mwoauth-authonlyprivate"
+  | "nominornewtalk"
+  | "noratelimit"
+  | "nuke"
+  | "patrol"
+  | "patrolmarks"
+  | "property-create"
+  | "property-term"
+  | "protect"
+  | "purge"
+  | "read"
+  | "reupload"
+  | "reupload-own"
+  | "reupload-shared"
+  | "rollback"
+  | "sendemail"
+  | "skipcaptcha"
+  | "suppressionlog"
+  | "tboverride"
+  | "templateeditor"
+  | "torunblocked"
+  | "transcode-reset"
+  | "translate"
+  | "undelete"
+  | "unwatchedpages"
+  | "upload"
+  | "upload_by_url"
+  | "viewmywatchlist"
+  | "viewsuppressed"
+  | "writeapi"
+
+export interface WikimediaProfile extends Record<string, any> {
+  sub: string
+  username: string
+  editcount: number
+  confirmed_email: boolean
+  blocked: boolean
+  registered: string
+  groups: WikimediaGroup[]
+  rights: WikimediaRight[]
+  grants: WikimediaGrant[]
+  realname: string
+  email: string
+}
+
+/**
+ * Add Wikimedia login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/wikimedia
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Wikimedia from "@auth/core/providers/wikimedia"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Wikimedia({
+ *       clientId: WIKIMEDIA_CLIENT_ID,
+ *       clientSecret: WIKIMEDIA_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Wikimedia OAuth documentation](https://www.mediawiki.org/wiki/Extension:OAuth)
+ *
+ * ## Configuration steps
+ * - Go to and accept the Consumer Registration doc: https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration
+ * - Request a new OAuth 2.0 consumer to get the `clientId` and `clientSecret`: https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose/oauth2
+ *   - Add the following redirect URL into the console: `http://<your-next-app-url>/api/auth/callback/wikimedia`
+ *   - Do not check the box next to This consumer is only for __your username__
+ *   - Unless you explicitly need a larger scope, feel free to select the radio button labelled User identity verification only - no ability to read pages or act on the users behalf.
+ *
+ * After registration, you can initially test your application only with your own Wikimedia account.
+ * You may have to wait several days for the application to be approved for it to be used by everyone.
+ *
+ * ### Notes
+ * This provider also supports all Wikimedia projects:
+ * - Wikipedia
+ * - Wikidata
+ * - Wikibooks
+ * - Wiktionary
+ * - etc..
+ *
+ * Please be aware that Wikimedia accounts do not have to have an associated email address. So you may want to add check if the user has an email address before allowing them to login.
+ *
+ * By default, Auth.js assumes that the Wikimedia provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Wikimedia provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/wikimedia.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 Wikimedia<P extends WikimediaProfile>(
+  options: OAuthUserConfig<P>
+): OAuthConfig<P> {
+  return {
+    id: "wikimedia",
+    name: "Wikimedia",
+    type: "oauth",
+    token: "https://meta.wikimedia.org/w/rest.php/oauth2/access_token",
+    userinfo: "https://meta.wikimedia.org/w/rest.php/oauth2/resource/profile",
+    authorization:
+      "https://meta.wikimedia.org/w/rest.php/oauth2/authorize?scope=",
+    profile(profile) {
+      return {
+        id: profile.sub,
+        name: profile.username,
+        email: profile.email,
+        image: null,
+      }
+    },
+    style: { bg: "#000", text: "#fff" },
+    options,
+  }
+}

package/src/providers/wordpress.ts

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