@adonisjs/ally 6.0.0 → 6.2.0

package/build/src/ally_manager.d.ts

@@ -1,5 +1,5 @@
 import type { HttpContext } from '@adonisjs/core/http';
-import type { AllyManagerDriverFactory } from './types.ts';
+import type { AllyManagerDriverFactory, AllyManagerUseOptions } from './types.ts';
 /**
  * AllyManager is used to create and manage social authentication driver
  * instances during an HTTP request. The drivers are cached during the
@@ -20,23 +20,87 @@ import type { AllyManagerDriverFactory } from './types.ts';
  */
 export declare class AllyManager<KnownSocialProviders extends Record<string, AllyManagerDriverFactory>> {
     #private;
+    /**
+     * The configured provider factories available for the current application.
+     */
     config: KnownSocialProviders;
     /**
+     * Create a new Ally manager for the current request.
+     *
      * @param config - Map of provider names to driver factory functions
      * @param ctx - The current HTTP context
      */
-    constructor(config: KnownSocialProviders, ctx: HttpContext);
+    constructor(
+    /**
+     * The configured provider factories available for the current application.
+     */
+    config: KnownSocialProviders, ctx: HttpContext);
+    /**
+     * Find if a provider has been configured.
+     *
+     * @param provider - The provider name to check.
+     * @returns `true` when the provider exists in the manager config.
+     *
+     * @example
+     * ```ts
+     * if (ally.has(provider)) {
+     *   await ally.use(provider).redirect()
+     * }
+     * ```
+     */
+    has(provider: string): provider is Extract<keyof KnownSocialProviders, string>;
+    /**
+     * Find if a provider allows local signup.
+     *
+     * @param provider - The configured provider name to inspect.
+     * @returns `true` when the provider does not opt out of local signup.
+     *
+     * @example
+     * ```ts
+     * if (ally.allowsLocalSignup('github')) {
+     *   return ally.use('github', { intent: 'signup' }).redirect()
+     * }
+     * ```
+     */
+    allowsLocalSignup(provider: keyof KnownSocialProviders & string): boolean;
+    /**
+     * Returns configured provider names.
+     *
+     * @returns An array of configured provider names.
+     *
+     * @example
+     * ```ts
+     * const providers = ally.configuredProviderNames()
+     * ```
+     */
+    configuredProviderNames(): Array<Extract<keyof KnownSocialProviders, string>>;
+    /**
+     * Returns provider names that allow local signup.
+     *
+     * @returns An array of configured provider names that allow signup flows.
+     *
+     * @example
+     * ```ts
+     * const signupProviders = ally.signupProviderNames()
+     * ```
+     */
+    signupProviderNames(): Array<Extract<keyof KnownSocialProviders, string>>;
     /**
      * Get a driver instance for the specified social provider. The driver
      * instance is cached for the duration of the HTTP request.
      *
      * @param provider - The name of the social provider (e.g., 'github', 'google')
+     * @param options - Additional options used to qualify the provider usage.
+     * @returns The instantiated social authentication driver.
      *
      * @example
      * ```ts
      * const github = ally.use('github')
      * await github.redirect()
+     *
+     * const signupDriver = ally.use('github', { intent: 'signup' })
+     * await signupDriver.redirect()
      * ```
      */
-    use<SocialProvider extends keyof KnownSocialProviders>(provider: SocialProvider): ReturnType<KnownSocialProviders[SocialProvider]>;
+    use<SocialProvider extends keyof KnownSocialProviders>(provider: SocialProvider, options?: AllyManagerUseOptions): ReturnType<KnownSocialProviders[SocialProvider]>;
 }

package/build/src/define_config.d.ts

@@ -4,14 +4,17 @@ import type { GoogleDriver } from './drivers/google.ts';
 import type { GithubDriver } from './drivers/github.ts';
 import type { SpotifyDriver } from './drivers/spotify.ts';
 import type { TwitterDriver } from './drivers/twitter.ts';
+import type { TwitterXDriver } from './drivers/twitter_x.ts';
 import type { DiscordDriver } from './drivers/discord.ts';
 import type { FacebookDriver } from './drivers/facebook.ts';
 import type { LinkedInDriver } from './drivers/linked_in.ts';
 import type { LinkedInOpenidConnectDriver } from './drivers/linked_in_openid_connect.ts';
-import type { GoogleDriverConfig, GithubDriverConfig, SpotifyDriverConfig, DiscordDriverConfig, TwitterDriverConfig, LinkedInDriverConfig, LinkedInOpenidConnectDriverConfig, FacebookDriverConfig, AllyManagerDriverFactory } from './types.ts';
+import type { GoogleDriverConfig, GithubDriverConfig, SpotifyDriverConfig, DiscordDriverConfig, TwitterDriverConfig, TwitterXDriverConfig, LinkedInDriverConfig, LinkedInOpenidConnectDriverConfig, FacebookDriverConfig, AllyManagerDriverFactory } from './types.ts';
 /**
  * Shape of config after it has been resolved from
  * the config provider
+ *
+ * Maps config providers to their resolved driver factory values.
  */
 type ResolvedConfig<KnownSocialProviders extends Record<string, AllyManagerDriverFactory | ConfigProvider<AllyManagerDriverFactory>>> = {
     [K in keyof KnownSocialProviders]: KnownSocialProviders[K] extends ConfigProvider<infer A> ? A : KnownSocialProviders[K];
@@ -22,6 +25,7 @@ type ResolvedConfig<KnownSocialProviders extends Record<string, AllyManagerDrive
  * functions or config providers.
  *
  * @param config - An object mapping provider names to driver factories
+ * @returns A config provider that resolves all registered providers.
  *
  * @example
  * ```ts
@@ -47,6 +51,16 @@ export declare function defineConfig<KnownSocialProviders extends Record<string,
  *
  * @example
  * ```ts
+ * const github = services.github({
+ *   clientId: env.get('GITHUB_CLIENT_ID'),
+ *   clientSecret: env.get('GITHUB_CLIENT_SECRET'),
+ *   callbackUrl: 'http://localhost:3333/github/callback',
+ *   disallowLocalSignup: true,
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
  * export default defineConfig({
  *   github: services.github({
  *     clientId: env.get('GITHUB_CLIENT_ID'),
@@ -66,5 +80,6 @@ export declare const services: {
     linkedinOpenidConnect: (config: LinkedInOpenidConnectDriverConfig) => ConfigProvider<(ctx: HttpContext) => LinkedInOpenidConnectDriver>;
     spotify: (config: SpotifyDriverConfig) => ConfigProvider<(ctx: HttpContext) => SpotifyDriver>;
     twitter: (config: TwitterDriverConfig) => ConfigProvider<(ctx: HttpContext) => TwitterDriver>;
+    twitterX: (config: TwitterXDriverConfig) => ConfigProvider<(ctx: HttpContext) => TwitterXDriver>;
 };
 export {};

package/build/src/drivers/discord.d.ts

@@ -36,8 +36,17 @@ import { Oauth2Driver } from '../abstract_drivers/oauth2.ts';
  */
 export declare class DiscordDriver extends Oauth2Driver<DiscordToken, DiscordScopes> {
     config: DiscordDriverConfig;
+    /**
+     * Discord token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * Discord authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * Discord user profile endpoint URL.
+     */
     protected userInfoUrl: string;
     /**
      * The param name for the authorization code

package/build/src/drivers/discord.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-WM3V3APX.js";
-import "../../chunk-KSJ4CFTC.js";
-import "../../chunk-MLKGABMK.js";
+} from "../../chunk-7V2EH7U6.js";
+import "../../chunk-NK6X76EQ.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/discord.ts
 var DiscordDriver = class extends Oauth2Driver {
@@ -15,8 +15,18 @@ var DiscordDriver = class extends Oauth2Driver {
     this.config = config;
     this.loadState();
   }
+  config;
+  /**
+   * Discord token endpoint URL.
+   */
   accessTokenUrl = "https://discord.com/api/oauth2/token";
+  /**
+   * Discord authorization endpoint URL.
+   */
   authorizeUrl = "https://discord.com/oauth2/authorize";
+  /**
+   * Discord user profile endpoint URL.
+   */
   userInfoUrl = "https://discord.com/api/users/@me";
   /**
    * The param name for the authorization code

package/build/src/drivers/facebook.d.ts

@@ -36,8 +36,17 @@ import { Oauth2Driver } from '../abstract_drivers/oauth2.ts';
  */
 export declare class FacebookDriver extends Oauth2Driver<FacebookToken, FacebookScopes> {
     config: FacebookDriverConfig;
+    /**
+     * Facebook token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * Facebook authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * Facebook profile endpoint URL.
+     */
     protected userInfoUrl: string;
     /**
      * The default set of fields to query for the user request

package/build/src/drivers/facebook.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-WM3V3APX.js";
-import "../../chunk-KSJ4CFTC.js";
-import "../../chunk-MLKGABMK.js";
+} from "../../chunk-7V2EH7U6.js";
+import "../../chunk-NK6X76EQ.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/facebook.ts
 var FacebookDriver = class extends Oauth2Driver {
@@ -15,8 +15,18 @@ var FacebookDriver = class extends Oauth2Driver {
     this.config = config;
     this.loadState();
   }
+  config;
+  /**
+   * Facebook token endpoint URL.
+   */
   accessTokenUrl = "https://graph.facebook.com/v10.0/oauth/access_token";
+  /**
+   * Facebook authorization endpoint URL.
+   */
   authorizeUrl = "https://www.facebook.com/v10.0/dialog/oauth";
+  /**
+   * Facebook profile endpoint URL.
+   */
   userInfoUrl = "https://graph.facebook.com/v10.0/me";
   /**
    * The default set of fields to query for the user request

package/build/src/drivers/github.d.ts

@@ -36,9 +36,21 @@ import { Oauth2Driver } from '../abstract_drivers/oauth2.ts';
  */
 export declare class GithubDriver extends Oauth2Driver<GithubToken, GithubScopes> {
     config: GithubDriverConfig;
+    /**
+     * GitHub token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * GitHub authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * GitHub profile endpoint URL.
+     */
     protected userInfoUrl: string;
+    /**
+     * GitHub email endpoint URL.
+     */
     protected userEmailUrl: string;
     /**
      * The param name for the authorization code

package/build/src/drivers/github.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-WM3V3APX.js";
-import "../../chunk-KSJ4CFTC.js";
-import "../../chunk-MLKGABMK.js";
+} from "../../chunk-7V2EH7U6.js";
+import "../../chunk-NK6X76EQ.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/github.ts
 var GithubDriver = class extends Oauth2Driver {
@@ -15,9 +15,22 @@ var GithubDriver = class extends Oauth2Driver {
     this.config = config;
     this.loadState();
   }
+  config;
+  /**
+   * GitHub token endpoint URL.
+   */
   accessTokenUrl = "https://github.com/login/oauth/access_token";
+  /**
+   * GitHub authorization endpoint URL.
+   */
   authorizeUrl = "https://github.com/login/oauth/authorize";
+  /**
+   * GitHub profile endpoint URL.
+   */
   userInfoUrl = "https://api.github.com/user";
+  /**
+   * GitHub email endpoint URL.
+   */
   userEmailUrl = "https://api.github.com/user/emails";
   /**
    * The param name for the authorization code
@@ -137,7 +150,7 @@ var GithubDriver = class extends Oauth2Driver {
       }
       return mainEmail;
     } catch (error) {
-      if (error && error.response && error.response.statusCode === 404) {
+      if (error && typeof error === "object" && "response" in error && error.response && typeof error.response === "object" && "statusCode" in error.response && error.response.statusCode === 404) {
         return;
       }
       throw error;

package/build/src/drivers/google.d.ts

@@ -37,8 +37,17 @@ import { Oauth2Driver } from '../abstract_drivers/oauth2.ts';
  */
 export declare class GoogleDriver extends Oauth2Driver<GoogleToken, GoogleScopes> {
     config: GoogleDriverConfig;
+    /**
+     * Google token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * Google authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * Google user profile endpoint URL.
+     */
     protected userInfoUrl: string;
     /**
      * The param name for the authorization code

package/build/src/drivers/google.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-WM3V3APX.js";
-import "../../chunk-KSJ4CFTC.js";
-import "../../chunk-MLKGABMK.js";
+} from "../../chunk-7V2EH7U6.js";
+import "../../chunk-NK6X76EQ.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/google.ts
 var SCOPE_PREFIXES = {
@@ -52,8 +52,18 @@ var GoogleDriver = class extends Oauth2Driver {
     this.config = config;
     this.loadState();
   }
+  config;
+  /**
+   * Google token endpoint URL.
+   */
   accessTokenUrl = "https://oauth2.googleapis.com/token";
+  /**
+   * Google authorization endpoint URL.
+   */
   authorizeUrl = "https://accounts.google.com/o/oauth2/v2/auth";
+  /**
+   * Google user profile endpoint URL.
+   */
   userInfoUrl = "https://www.googleapis.com/oauth2/v3/userinfo";
   /**
    * The param name for the authorization code

package/build/src/drivers/linked_in.d.ts

@@ -37,9 +37,21 @@ import { Oauth2Driver } from '../abstract_drivers/oauth2.ts';
  */
 export declare class LinkedInDriver extends Oauth2Driver<LinkedInToken, LinkedInScopes> {
     config: LinkedInDriverConfig;
+    /**
+     * LinkedIn token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * LinkedIn authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * LinkedIn profile endpoint URL.
+     */
     protected userInfoUrl: string;
+    /**
+     * LinkedIn email endpoint URL.
+     */
     protected userEmailUrl: string;
     /**
      * The param name for the authorization code

package/build/src/drivers/linked_in.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-WM3V3APX.js";
-import "../../chunk-KSJ4CFTC.js";
-import "../../chunk-MLKGABMK.js";
+} from "../../chunk-7V2EH7U6.js";
+import "../../chunk-NK6X76EQ.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/linked_in.ts
 import { Exception } from "@adonisjs/core/exceptions";
@@ -16,9 +16,22 @@ var LinkedInDriver = class extends Oauth2Driver {
     this.config = config;
     this.loadState();
   }
+  config;
+  /**
+   * LinkedIn token endpoint URL.
+   */
   accessTokenUrl = "https://www.linkedin.com/oauth/v2/accessToken";
+  /**
+   * LinkedIn authorization endpoint URL.
+   */
   authorizeUrl = "https://www.linkedin.com/oauth/v2/authorization";
+  /**
+   * LinkedIn profile endpoint URL.
+   */
   userInfoUrl = "https://api.linkedin.com/v2/me";
+  /**
+   * LinkedIn email endpoint URL.
+   */
   userEmailUrl = "https://api.linkedin.com/v2/clientAwareMemberHandles";
   /**
    * The param name for the authorization code

package/build/src/drivers/linked_in_openid_connect.d.ts

@@ -1,7 +1,7 @@
 import type { HttpContext } from '@adonisjs/core/http';
 import type { HttpClient } from '@poppinss/oauth-client';
 import { Oauth2Driver } from '../abstract_drivers/oauth2.ts';
-import type { ApiRequestContract, LinkedInOpenidConnectAccessToken, LinkedInOpenidConnectDriverConfig, LinkedInOpenidConnectScopes, RedirectRequestContract } from '../types.ts';
+import type { ApiRequestContract, LinkedInOpenidConnectAccessToken, LinkedInOpenidConnectDriverConfig, LinkedInOpenidConnectScopes, Oauth2AccessToken, RedirectRequestContract } from '../types.ts';
 /**
  * LinkedIn OpenID Connect OAuth2 driver for authenticating users via LinkedIn.
  * This driver uses the OpenID Connect protocol for authentication.
@@ -37,8 +37,17 @@ import type { ApiRequestContract, LinkedInOpenidConnectAccessToken, LinkedInOpen
  */
 export declare class LinkedInOpenidConnectDriver extends Oauth2Driver<LinkedInOpenidConnectAccessToken, LinkedInOpenidConnectScopes> {
     config: LinkedInOpenidConnectDriverConfig;
+    /**
+     * LinkedIn OpenID authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * LinkedIn OpenID token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * LinkedIn OpenID userinfo endpoint URL.
+     */
     protected userInfoUrl: string;
     /**
      * The param name for the authorization code
@@ -97,7 +106,7 @@ export declare class LinkedInOpenidConnectDriver extends Oauth2Driver<LinkedInOp
         name: any;
         avatarUrl: any;
         email: any;
-        emailVerificationState: "verified" | "unverified";
+        emailVerificationState: "unsupported";
         original: any;
     }>;
     /**
@@ -122,14 +131,14 @@ export declare class LinkedInOpenidConnectDriver extends Oauth2Driver<LinkedInOp
             token: string;
             type: "bearer";
             expiresIn: number;
-            expiresAt: Exclude<import("@poppinss/oauth-client/types").Oauth2AccessToken["expiresAt"], undefined>;
+            expiresAt: Exclude<Oauth2AccessToken["expiresAt"], undefined>;
         };
         id: any;
         nickName: any;
         name: any;
         avatarUrl: any;
         email: any;
-        emailVerificationState: "verified" | "unverified";
+        emailVerificationState: "unsupported";
         original: any;
     }>;
     /**
@@ -154,7 +163,7 @@ export declare class LinkedInOpenidConnectDriver extends Oauth2Driver<LinkedInOp
         name: any;
         avatarUrl: any;
         email: any;
-        emailVerificationState: "verified" | "unverified";
+        emailVerificationState: "unsupported";
         original: any;
     }>;
 }

package/build/src/drivers/linked_in_openid_connect.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-WM3V3APX.js";
-import "../../chunk-KSJ4CFTC.js";
-import "../../chunk-MLKGABMK.js";
+} from "../../chunk-7V2EH7U6.js";
+import "../../chunk-NK6X76EQ.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/linked_in_openid_connect.ts
 var LinkedInOpenidConnectDriver = class extends Oauth2Driver {
@@ -15,8 +15,18 @@ var LinkedInOpenidConnectDriver = class extends Oauth2Driver {
     this.config = config;
     this.loadState();
   }
+  config;
+  /**
+   * LinkedIn OpenID authorization endpoint URL.
+   */
   authorizeUrl = "https://www.linkedin.com/oauth/v2/authorization";
+  /**
+   * LinkedIn OpenID token endpoint URL.
+   */
   accessTokenUrl = "https://www.linkedin.com/oauth/v2/accessToken";
+  /**
+   * LinkedIn OpenID userinfo endpoint URL.
+   */
   userInfoUrl = "https://api.linkedin.com/v2/userinfo";
   /**
    * The param name for the authorization code
@@ -80,14 +90,13 @@ var LinkedInOpenidConnectDriver = class extends Oauth2Driver {
       callback(request);
     }
     const body = await request.get();
-    const emailVerificationState = body.email_verified ? "verified" : "unverified";
     return {
       id: body.sub,
       nickName: body.given_name,
       name: body.family_name,
       avatarUrl: body.picture,
       email: body.email,
-      emailVerificationState,
+      emailVerificationState: "unsupported",
       original: body
     };
   }

package/build/src/drivers/spotify.d.ts

@@ -36,8 +36,17 @@ import { Oauth2Driver } from '../abstract_drivers/oauth2.ts';
  */
 export declare class SpotifyDriver extends Oauth2Driver<SpotifyToken, SpotifyScopes> {
     config: SpotifyDriverConfig;
+    /**
+     * Spotify token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * Spotify authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * Spotify profile endpoint URL.
+     */
     protected userInfoUrl: string;
     /**
      * The param name for the authorization code
@@ -104,6 +113,8 @@ export declare class SpotifyDriver extends Oauth2Driver<SpotifyToken, SpotifySco
     /**
      * Check if the error from the callback indicates that the user
      * denied authorization.
+     *
+     * @returns `true` when the provider reported an access-denied error.
      */
     accessDenied(): boolean;
     /**

package/build/src/drivers/spotify.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-WM3V3APX.js";
-import "../../chunk-KSJ4CFTC.js";
-import "../../chunk-MLKGABMK.js";
+} from "../../chunk-7V2EH7U6.js";
+import "../../chunk-NK6X76EQ.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/spotify.ts
 var SpotifyDriver = class extends Oauth2Driver {
@@ -15,8 +15,18 @@ var SpotifyDriver = class extends Oauth2Driver {
     this.config = config;
     this.loadState();
   }
+  config;
+  /**
+   * Spotify token endpoint URL.
+   */
   accessTokenUrl = "https://accounts.spotify.com/api/token";
+  /**
+   * Spotify authorization endpoint URL.
+   */
   authorizeUrl = "https://accounts.spotify.com/authorize";
+  /**
+   * Spotify profile endpoint URL.
+   */
   userInfoUrl = "https://api.spotify.com/v1/me";
   /**
    * The param name for the authorization code
@@ -98,6 +108,8 @@ var SpotifyDriver = class extends Oauth2Driver {
   /**
    * Check if the error from the callback indicates that the user
    * denied authorization.
+   *
+   * @returns `true` when the provider reported an access-denied error.
    */
   accessDenied() {
     const error = this.getError();

package/build/src/drivers/twitter.d.ts

@@ -35,9 +35,21 @@ import { Oauth1Driver } from '../abstract_drivers/oauth1.ts';
 export declare class TwitterDriver extends Oauth1Driver<TwitterToken, string> {
     protected ctx: HttpContext;
     config: TwitterDriverConfig;
+    /**
+     * Twitter request-token endpoint URL.
+     */
     protected requestTokenUrl: string;
+    /**
+     * Twitter authorization endpoint URL.
+     */
     protected authorizeUrl: string;
+    /**
+     * Twitter access-token endpoint URL.
+     */
     protected accessTokenUrl: string;
+    /**
+     * Twitter profile endpoint URL.
+     */
     protected userInfoUrl: string;
     /**
      * The query string param name for the error.
@@ -65,6 +77,9 @@ export declare class TwitterDriver extends Oauth1Driver<TwitterToken, string> {
      * Twitter doesn't support scopes
      */
     protected scopeParamName: string;
+    /**
+     * Scope separator placeholder maintained for OAuth1 compatibility.
+     */
     protected scopesSeparator: string;
     /**
      * @param ctx - The HTTP context
@@ -131,6 +146,8 @@ export declare class TwitterDriver extends Oauth1Driver<TwitterToken, string> {
     /**
      * Check if the error from the callback indicates that the user
      * denied authorization.
+     *
+     * @returns `true` when the request contains the denial marker.
      */
     accessDenied(): boolean;
 }