@mulverse/mulguard-core 1.0.0

package/src/providers/twitter.ts

@@ -0,0 +1,207 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>Twitter</b> integration.</span>
+ * <a href="https://www.x.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/twitter.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/twitter
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+
+/**
+ * [Users lookup](https://developer.x.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me)
+ */
+export interface TwitterProfile {
+  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 friendly name of this user, as shown on their profile. */
+    name: string
+    /** @note Email is currently unsupported by Twitter.  */
+    email?: string
+    /** The Twitter handle (screen name) of this user. */
+    username: string
+    /**
+     * The location specified in the user's profile, if the user provided one.
+     * As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries.
+     *
+     * To return this field, add `user.fields=location` in the authorization request's query parameter.
+     */
+    location?: string
+    /**
+     * This object and its children fields contain details about text that has a special meaning in the user's description.
+     *
+     *To return this field, add `user.fields=entities` in the authorization request's query parameter.
+     */
+    entities?: {
+      /** Contains details about the user's profile website. */
+      url: {
+        /** Contains details about the user's profile website. */
+        urls: Array<{
+          /** The start position (zero-based) of the recognized user's profile website. All start indices are inclusive. */
+          start: number
+          /** The end position (zero-based) of the recognized user's profile website. This end index is exclusive. */
+          end: number
+          /** The URL in the format entered by the user. */
+          url: string
+          /** The fully resolved URL. */
+          expanded_url: string
+          /** The URL as displayed in the user's profile. */
+          display_url: string
+        }>
+      }
+      /** Contains details about URLs, Hashtags, Cashtags, or mentions located within a user's description. */
+      description: {
+        hashtags: Array<{
+          start: number
+          end: number
+          tag: string
+        }>
+      }
+    }
+    /**
+     * Indicate if this user is a verified Twitter user.
+     *
+     * To return this field, add `user.fields=verified` in the authorization request's query parameter.
+     */
+    verified?: boolean
+    /**
+     * The text of this user's profile description (also known as bio), if the user provided one.
+     *
+     * To return this field, add `user.fields=description` in the authorization request's query parameter.
+     */
+    description?: string
+    /**
+     * The URL specified in the user's profile, if present.
+     *
+     * To return this field, add `user.fields=url` in the authorization request's query parameter.
+     */
+    url?: string
+    /** The URL to the profile image for this user, as shown on the user's profile. */
+    profile_image_url?: string
+    protected?: boolean
+    /**
+     * Unique identifier of this user's pinned Tweet.
+     *
+     *  You can obtain the expanded object in `includes.tweets` by adding `expansions=pinned_tweet_id` in the authorization request's query parameter.
+     */
+    pinned_tweet_id?: string
+    created_at?: string
+  }
+  includes?: {
+    tweets?: Array<{
+      id: string
+      text: string
+    }>
+  }
+  [claims: string]: unknown
+}
+
+/**
+ * Add Twitter login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/twitter
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import Twitter from "@auth/core/providers/twitter"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     Twitter({
+ *       clientId: TWITTER_CLIENT_ID,
+ *       clientSecret: TWITTER_CLIENT_SECRET,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [Twitter App documentation](https://developer.x.com/en/apps)
+ *
+ * ## OAuth 2
+ * Twitter supports OAuth 2, which is currently opt-in. To enable it, simply add version: "2.0" to your Provider configuration:
+ * ```ts
+ * Twitter({
+ *   clientId: process.env.TWITTER_ID,
+ *   clientSecret: process.env.TWITTER_SECRET,
+ *   version: "2.0", // opt-in to Twitter OAuth 2.0
+ * })
+ * ```
+ * Keep in mind that although this change is easy, it changes how and with which of Twitter APIs you can interact with. Read the official Twitter OAuth 2 documentation for more details.
+ *
+ *
+ * :::note
+ *
+ * Email is currently not supported by Twitter OAuth 2.0.
+ *
+ * :::
+ *
+ * ### Notes
+ *
+ * Twitter is currently the only built-in provider using the OAuth 1.0 spec.
+ * This means that you won't receive an `access_token` or `refresh_token`, but an `oauth_token` and `oauth_token_secret` respectively. Remember to add these to your database schema, in case if you are using an [Adapter](https://authjs.dev/reference/core/adapters).
+ *
+ * :::tip
+ *
+ * You must enable the "Request email address from users" option in your app permissions if you want to obtain the users email address.
+ *
+ * :::
+ *
+ * By default, Auth.js assumes that the Twitter provider is
+ * based on the [OAuth 2](https://www.rfc-editor.org/rfc/rfc6749.html) specification.
+ *
+ * :::tip
+ *
+ * The Twitter provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/twitter.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 Twitter(
+  config: OAuthUserConfig<TwitterProfile>
+): OAuthConfig<TwitterProfile> {
+  return {
+    id: "twitter",
+    name: "Twitter",
+    type: "oauth",
+    checks: ["pkce", "state"],
+    authorization:
+      "https://x.com/i/oauth2/authorize?scope=users.read tweet.read offline.access",
+    token: "https://api.x.com/2/oauth2/token",
+    userinfo: "https://api.x.com/2/users/me?user.fields=profile_image_url",
+    profile({ data }) {
+      return {
+        id: data.id,
+        name: data.name,
+        email: data.email ?? null,
+        image: data.profile_image_url,
+      }
+    },
+    style: { bg: "#1da1f2", text: "#fff" },
+    options: config,
+  }
+}

package/src/providers/united-effects.ts

@@ -0,0 +1,89 @@
+/**
+ * <div class="provider" style={{backgroundColor: "#000", display: "flex", justifyContent: "space-between", color: "#fff", padding: 16}}>
+ * <span>Built-in <b>United Effects</b> integration.</span>
+ * <a href="https://www.unitedeffects.com/">
+ *   <img style={{display: "block"}} src="https://authjs.dev/img/providers/united-effects.svg" height="48" />
+ * </a>
+ * </div>
+ *
+ * @module providers/united-effects
+ */
+import type { OAuthConfig, OAuthUserConfig } from "./index.js"
+export interface UnitedEffectsProfile extends Record<string, any> {
+  sub: string
+  email: string
+}
+/**
+ * Add United Effects login to your page.
+ *
+ * ### Setup
+ *
+ * #### Callback URL
+ * ```
+ * https://example.com/api/auth/callback/united-effects
+ * ```
+ *
+ * #### Configuration
+ *```ts
+ * import { Auth } from "@auth/core"
+ * import UnitedEffects from "@auth/core/providers/united-effects"
+ *
+ * const request = new Request(origin)
+ * const response = await Auth(request, {
+ *   providers: [
+ *     UnitedEffects({ clientId: UE_CLIENT_ID, clientSecret: UE_CLIENT_SECRET }),
+ *   ],
+ * })
+ * ```
+ *
+ * ### Resources
+ *
+ * - [UnitedEffects Auth.js documentation](https://docs.unitedeffects.com/integrations/nextauthjs)",
+ *
+ * ### Notes
+ *
+ * By default, Auth.js assumes that the UnitedEffects provider is
+ * based on the [Open ID Connect](https://openid.net/specs/openid-connect-core-1_0.html) specification.
+ *
+ * :::note
+ *
+ * `issuer` should be the fully qualified URL including your Auth Group ID – e.g. `https://auth.unitedeffects.com/YQpbQV5dbW-224dCovz-3`
+ *
+ * :::
+ *
+ * :::danger
+ *
+ * The United Effects API does not return the user name or image by design, so this provider will return null for both. United Effects prioritizes user personal information security above all and has built a secured profile access request system separate from the provider API.
+ *
+ * :::
+ *
+ * :::tip
+ *
+ * The UnitedEffects provider comes with a [default configuration](https://github.com/nextauthjs/next-auth/blob/main/packages/core/src/providers/united-effects.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 UnitedEffects<P extends UnitedEffectsProfile>(
+  options: OAuthUserConfig<P> & { issuer: string }
+): OAuthConfig<P> {
+  return {
+    id: "united-effects",
+    name: "United Effects",
+    type: "oidc",
+    authorization: {
+      params: { scope: "openid email profile", resource: options.issuer },
+    },
+    options,
+  }
+}

package/src/providers/vipps.ts

@@ -0,0 +1,86 @@
+import type { OIDCConfig, OIDCUserConfig } from "./index.js"
+
+interface Address {
+  address_type: string
+  country: string
+  formatted: string
+  postal_code: string
+  region: string
+  street_address: string
+}
+
+/** @see [User Profile Structure](https://developer.vippsmobilepay.com/api/userinfo/#operation/userinfoAuthorizationCode) */
+export interface VippsProfile extends Record<string, any> {
+  accounts: {
+    account_name: string
+    account_number: number
+    bank_name: string
+  }[]
+  address: Address
+  other_addresses: Address[]
+  birthdate: string
+  email: string
+  email_verified: boolean
+  family_name: string
+  given_name: string
+  name: string
+  nin: string
+  phone_number: string
+  sid: string
+  sub: string
+  delegatedConsents: {
+    language: string
+    heading: string
+    termsDescription: string
+    confirmConsentButtonText: string
+    links: {
+      termsLinkText: string
+      termsLinkUrl: string
+      privacyStatementLinkText: string
+      privacyStatementLinkUrl: string
+    }
+    timeOfConsent: string
+    consents: {
+      id: string
+      accepted: boolean
+      required: boolean
+      textDisplayedToUser: string
+    }[]
+  }
+}
+
+/**
+ * @see [Vipps Login API](https://developer.vippsmobilepay.com/docs/APIs/login-api/api-guide)
+ *
+ * ## Example
+ *
+ * ```ts
+ * import Vipps from "@auth/core/providers/vipps"
+ * ...
+ * providers: [
+ *  Vipps({
+ *    clientId: process.env.AUTH_VIPPS_ID,
+ *    clientSecret: process.env.AUTH_VIPPS_SECRET,
+ *  })
+ * ]
+ * ...
+ * ```
+ * ::: note
+ * If you're testing, make sure to override the issuer option with apitest.vipps.no
+ * :::
+ */
+export default function Vipps(
+  options: OIDCUserConfig<VippsProfile>
+): OIDCConfig<VippsProfile> {
+  return {
+    id: "vipps",
+    name: "Vipps",
+    type: "oidc",
+    issuer: "https://api.vipps.no/access-management-1.0/access/",
+    authorization: { params: { scope: "openid name email" } },
+    idToken: false,
+    style: { brandColor: "#f05c18" },
+    checks: ["pkce", "state", "nonce"],
+    options,
+  }
+}