@_mustachio/openauth 0.9.2 → 0.11.0

package/src/provider/facebook.ts

@@ -1,84 +0,0 @@
-/**
- * Use this provider to authenticate with Facebook. Supports both OAuth2 and OIDC.
- *
- * #### Using OAuth
- *
- * ```ts {5-8}
- * import { FacebookProvider } from "@openauthjs/openauth/provider/facebook"
- *
- * export default issuer({
- *   providers: {
- *     facebook: FacebookProvider({
- *       clientID: "1234567890",
- *       clientSecret: "0987654321"
- *     })
- *   }
- * })
- * ```
- *
- * #### Using OIDC
- *
- * ```ts {5-7}
- * import { FacebookOidcProvider } from "@openauthjs/openauth/provider/facebook"
- *
- * export default issuer({
- *   providers: {
- *     facebook: FacebookOidcProvider({
- *       clientID: "1234567890"
- *     })
- *   }
- * })
- * ```
- *
- * @packageDocumentation
- */
-
-import { Oauth2Provider, Oauth2WrappedConfig } from "./oauth2.js"
-import { OidcProvider, OidcWrappedConfig } from "./oidc.js"
-
-export interface FacebookConfig extends Oauth2WrappedConfig {}
-export interface FacebookOidcConfig extends OidcWrappedConfig {}
-
-/**
- * Create a Facebook OAuth2 provider.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * FacebookProvider({
- *   clientID: "1234567890",
- *   clientSecret: "0987654321"
- * })
- * ```
- */
-export function FacebookProvider(config: FacebookConfig) {
-  return Oauth2Provider({
-    ...config,
-    type: "facebook",
-    endpoint: {
-      authorization: "https://www.facebook.com/v12.0/dialog/oauth",
-      token: "https://graph.facebook.com/v12.0/oauth/access_token",
-    },
-  })
-}
-
-/**
- * Create a Facebook OIDC provider.
- *
- * This is useful if you just want to verify the user's email address.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * FacebookOidcProvider({
- *   clientID: "1234567890"
- * })
- * ```
- */
-export function FacebookOidcProvider(config: FacebookOidcConfig) {
-  return OidcProvider({
-    ...config,
-    type: "facebook",
-    issuer: "https://graph.facebook.com",
-  })
-}

package/src/provider/github.ts

@@ -1,45 +0,0 @@
-/**
- * Use this provider to authenticate with Github.
- *
- * ```ts {5-8}
- * import { GithubProvider } from "@openauthjs/openauth/provider/github"
- *
- * export default issuer({
- *   providers: {
- *     github: GithubProvider({
- *       clientID: "1234567890",
- *       clientSecret: "0987654321"
- *     })
- *   }
- * })
- * ```
- *
- * @packageDocumentation
- */
-
-import { Oauth2Provider, Oauth2WrappedConfig } from "./oauth2.js"
-
-export interface GithubConfig extends Oauth2WrappedConfig {}
-
-/**
- * Create a Github OAuth2 provider.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * GithubProvider({
- *   clientID: "1234567890",
- *   clientSecret: "0987654321"
- * })
- * ```
- */
-export function GithubProvider(config: GithubConfig) {
-  return Oauth2Provider({
-    ...config,
-    type: "github",
-    endpoint: {
-      authorization: "https://github.com/login/oauth/authorize",
-      token: "https://github.com/login/oauth/access_token",
-    },
-  })
-}

package/src/provider/google.ts

@@ -1,85 +0,0 @@
-/**
- * Use this provider to authenticate with Google. Supports both OAuth2 and OIDC.
- *
- * #### Using OAuth
- *
- * ```ts {5-8}
- * import { GoogleProvider } from "@openauthjs/openauth/provider/google"
- *
- * export default issuer({
- *   providers: {
- *     google: GoogleProvider({
- *       clientID: "1234567890",
- *       clientSecret: "0987654321"
- *     })
- *   }
- * })
- * ```
- *
- * #### Using OIDC
- *
- * ```ts {5-7}
- * import { GoogleOidcProvider } from "@openauthjs/openauth/provider/google"
- *
- * export default issuer({
- *   providers: {
- *     google: GoogleOidcProvider({
- *       clientID: "1234567890"
- *     })
- *   }
- * })
- * ```
- *
- * @packageDocumentation
- */
-
-import { Oauth2Provider, Oauth2WrappedConfig } from "./oauth2.js"
-import { OidcProvider, OidcWrappedConfig } from "./oidc.js"
-
-export interface GoogleConfig extends Oauth2WrappedConfig {}
-export interface GoogleOidcConfig extends OidcWrappedConfig {}
-
-/**
- * Create a Google OAuth2 provider.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * GoogleProvider({
- *   clientID: "1234567890",
- *   clientSecret: "0987654321"
- * })
- * ```
- */
-export function GoogleProvider(config: GoogleConfig) {
-  return Oauth2Provider({
-    ...config,
-    type: "google",
-    endpoint: {
-      authorization: "https://accounts.google.com/o/oauth2/v2/auth",
-      token: "https://oauth2.googleapis.com/token",
-      jwks: "https://www.googleapis.com/oauth2/v3/certs",
-    },
-  })
-}
-
-/**
- * Create a Google OIDC provider.
- *
- * This is useful if you just want to verify the user's email address.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * GoogleOidcProvider({
- *   clientID: "1234567890"
- * })
- * ```
- */
-export function GoogleOidcProvider(config: GoogleOidcConfig) {
-  return OidcProvider({
-    ...config,
-    type: "google",
-    issuer: "https://accounts.google.com",
-  })
-}

package/src/provider/index.ts

@@ -1,3 +0,0 @@
-export * from "./code.js"
-export type { Provider as Provider } from "./provider.js"
-export * from "./spotify.js"

package/src/provider/jumpcloud.ts

@@ -1,45 +0,0 @@
-/**
- * Use this provider to authenticate with JumpCloud.
- *
- * ```ts {5-8}
- * import { JumpCloudProvider } from "@openauthjs/openauth/provider/jumpcloud"
- *
- * export default issuer({
- *   providers: {
- *     jumpcloud: JumpCloudProvider({
- *       clientID: "1234567890",
- *       clientSecret: "0987654321"
- *     })
- *   }
- * })
- * ```
- *
- * @packageDocumentation
- */
-
-import { Oauth2Provider, Oauth2WrappedConfig } from "./oauth2.js"
-
-export interface JumpCloudConfig extends Oauth2WrappedConfig {}
-
-/**
- * Create a JumpCloud OAuth2 provider.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * JumpCloudProvider({
- *   clientID: "1234567890",
- *   clientSecret: "0987654321"
- * })
- * ```
- */
-export function JumpCloudProvider(config: JumpCloudConfig) {
-  return Oauth2Provider({
-    type: "jumpcloud",
-    ...config,
-    endpoint: {
-      authorization: "https://oauth.id.jumpcloud.com/oauth2/auth",
-      token: "https://oauth.id.jumpcloud.com/oauth2/token",
-    },
-  })
-}

package/src/provider/keycloak.ts

@@ -1,75 +0,0 @@
-/**
- * Use this provider to authenticate with a Keycloak server.
- *
- * ```ts {5-10}
- * import { KeycloakProvider } from "@openauthjs/openauth/provider/keycloak"
- *
- * export default issuer({
- *   providers: {
- *     keycloak: KeycloakProvider({
- *       baseUrl: "https://your-keycloak-domain",
- *       realm: "your-realm",
- *       clientID: "1234567890",
- *       clientSecret: "0987654321"
- *     })
- *   }
- * })
- * ```
- *
- * @packageDocumentation
- */
-
-import { Oauth2Provider, Oauth2WrappedConfig } from "./oauth2.js"
-
-export interface KeycloakConfig extends Oauth2WrappedConfig {
-  /**
-   * The base URL of the Keycloak server.
-   *
-   * @example
-   * ```ts
-   * {
-   *   baseUrl: "https://your-keycloak-domain"
-   * }
-   * ```
-   */
-  baseUrl: string
-  /**
-   * The realm in the Keycloak server to authenticate against.
-   *
-   * A realm in Keycloak is like a tenant or namespace that manages a set of
-   * users, credentials, roles, and groups.
-   *
-   * @example
-   * ```ts
-   * {
-   *   realm: "your-realm"
-   * }
-   * ```
-   */
-  realm: string
-}
-
-/**
- * Create a Keycloak OAuth2 provider.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * KeycloakProvider({
- *   baseUrl: "https://your-keycloak-domain",
- *   realm: "your-realm",
- *   clientID: "1234567890",
- *   clientSecret: "0987654321"
- * })
- * ```
- */
-export function KeycloakProvider(config: KeycloakConfig) {
-  const baseConfig = {
-    ...config,
-    endpoint: {
-      authorization: `${config.baseUrl}/realms/${config.realm}/protocol/openid-connect/auth`,
-      token: `${config.baseUrl}/realms/${config.realm}/protocol/openid-connect/token`,
-    },
-  }
-  return Oauth2Provider(baseConfig)
-}

package/src/provider/linkedin.ts

@@ -1,12 +0,0 @@
-import { Oauth2Provider, type Oauth2WrappedConfig } from "./oauth2.js"
-
-export function LinkedInAdapter(config: Oauth2WrappedConfig) {
-  return Oauth2Provider({
-    ...config,
-    type: "linkedin",
-    endpoint: {
-      authorization: "https://www.linkedin.com/oauth/v2/authorization",
-      token: "https://www.linkedin.com/oauth/v2/accessToken",
-    },
-  })
-}

package/src/provider/m2m.ts

@@ -1,56 +0,0 @@
-import { Provider } from "./provider.js"
-
-export interface M2MProviderConfig {
-  /**
-   * Callback to verify client credentials.
-   * Should return data about the client (e.g., associated User or Org ID).
-   * Returning undefined or throwing indicates invalid credentials.
-   */
-  verify: (
-    clientID: string,
-    clientSecret: string,
-    params: Record<string, string>,
-  ) => Promise<
-    | {
-        id: string
-        [key: string]: any
-      }
-    | undefined
-  >
-}
-
-/**
- * Creates a provider for Machine-to-Machine (M2M) authentication using the
- * OAuth 2.0 `client_credentials` grant type.
- *
- * This provider does not have a UI and is intended for service-to-service
- * communication where the client can securely store a secret.
- *
- * @example
- * ```ts
- * const m2m = M2MProvider({
- *   verify: async (clientID, clientSecret) => {
- *     const client = await db.clients.findUnique({ where: { clientID } })
- *     if (client && client.secret === clientSecret) return client
- *   }
- * })
- * ```
- */
-export function M2MProvider(config: M2MProviderConfig): Provider<{
-  id: string
-  [key: string]: any
-}> {
-  return {
-    type: "m2m",
-    init() {},
-    async client(input) {
-      const result = await config.verify(
-        input.clientID,
-        input.clientSecret,
-        input.params,
-      )
-      if (!result) throw new Error("Invalid client credentials")
-      return result
-    },
-  }
-}

package/src/provider/microsoft.ts

@@ -1,100 +0,0 @@
-/**
- * Use this provider to authenticate with Microsoft. Supports both OAuth2 and OIDC.
- *
- * #### Using OAuth
- *
- * ```ts {5-9}
- * import { MicrosoftProvider } from "@openauthjs/openauth/provider/microsoft"
- *
- * export default issuer({
- *   providers: {
- *     microsoft: MicrosoftProvider({
- *       tenant: "1234567890",
- *       clientID: "1234567890",
- *       clientSecret: "0987654321"
- *     })
- *   }
- * })
- * ```
- *
- * #### Using OIDC
- *
- * ```ts {5-7}
- * import { MicrosoftOidcProvider } from "@openauthjs/openauth/provider/microsoft"
- *
- * export default issuer({
- *   providers: {
- *     microsoft: MicrosoftOidcProvider({
- *       clientID: "1234567890"
- *     })
- *   }
- * })
- * ```
- *
- * @packageDocumentation
- */
-
-import { Oauth2Provider, Oauth2WrappedConfig } from "./oauth2.js"
-import { OidcProvider, OidcWrappedConfig } from "./oidc.js"
-
-export interface MicrosoftConfig extends Oauth2WrappedConfig {
-  /**
-   * The tenant ID of the Microsoft account.
-   *
-   * This is usually the same as the client ID.
-   *
-   * @example
-   * ```ts
-   * {
-   *   tenant: "1234567890"
-   * }
-   * ```
-   */
-  tenant: string
-}
-export interface MicrosoftOidcConfig extends OidcWrappedConfig {}
-
-/**
- * Create a Microsoft OAuth2 provider.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * MicrosoftProvider({
- *   tenant: "1234567890",
- *   clientID: "1234567890",
- *   clientSecret: "0987654321"
- * })
- * ```
- */
-export function MicrosoftProvider(config: MicrosoftConfig) {
-  return Oauth2Provider({
-    ...config,
-    type: "microsoft",
-    endpoint: {
-      authorization: `https://login.microsoftonline.com/${config?.tenant}/oauth2/v2.0/authorize`,
-      token: `https://login.microsoftonline.com/${config?.tenant}/oauth2/v2.0/token`,
-    },
-  })
-}
-
-/**
- * Create a Microsoft OIDC provider.
- *
- * This is useful if you just want to verify the user's email address.
- *
- * @param config - The config for the provider.
- * @example
- * ```ts
- * MicrosoftOidcProvider({
- *   clientID: "1234567890"
- * })
- * ```
- */
-export function MicrosoftOidcProvider(config: MicrosoftOidcConfig) {
-  return OidcProvider({
-    ...config,
-    type: "microsoft",
-    issuer: "https://graph.microsoft.com/oidc/userinfo",
-  })
-}