@adonisjs/ally 4.1.4 → 5.0.0-0

package/build/src/{Config/index.js → defaults/config.js}

@@ -1,60 +1,57 @@
-"use strict";
 /*
  * @adonisjs/ally
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.spotify = exports.facebook = exports.bitbucket = exports.microsoft = exports.discord = exports.patreon = exports.linkedin = exports.gitlab = exports.google = exports.github = exports.twitter = void 0;
-exports.twitter = {
+export const twitter = {
     REQUEST_TOKEN_URL: 'https://api.twitter.com/oauth/request_token',
     AUTHORIZE_URL: 'https://api.twitter.com/oauth/authenticate',
     ACCESS_TOKEN_URL: 'https://api.twitter.com/oauth/access_token',
 };
-exports.github = {
+export const github = {
     AUTHORIZE_URL: 'https://github.com/login/oauth/authorize',
     ACCESS_TOKEN_URL: 'https://github.com/login/oauth/access_token',
     USER_INFO_URL: 'https://api.github.com/user',
     USER_EMAIL_URL: 'https://api.github.com/user/emails',
 };
-exports.google = {
+export const google = {
     AUTHORIZE_URL: 'https://accounts.google.com/o/oauth2/v2/auth',
     ACCESS_TOKEN_URL: 'https://oauth2.googleapis.com/token',
     USER_INFO_URL: 'https://www.googleapis.com/oauth2/v3/userinfo',
 };
-exports.gitlab = {
+export const gitlab = {
     AUTHORIZE_URL: 'https://gitlab.com/oauth/authorize',
     ACCESS_TOKEN_URL: 'https://gitlab.com/oauth/token',
 };
-exports.linkedin = {
+export const linkedin = {
     AUTHORIZE_URL: 'https://www.linkedin.com/oauth/v2/authorization',
     ACCESS_TOKEN_URL: 'https://www.linkedin.com/oauth/v2/accessToken',
 };
-exports.patreon = {
+export const patreon = {
     AUTHORIZE_URL: 'https://www.patreon.com/oauth2/authorize',
     ACCESS_TOKEN_URL: 'https://www.patreon.com/api/oauth2/token',
 };
-exports.discord = {
+export const discord = {
     AUTHORIZE_URL: 'https://discord.com/api/oauth2/authorize',
     ACCESS_TOKEN_URL: 'https://discord.com/api/oauth2/token',
     USER_INFO_URL: 'https://discord.com/api/users/@me',
 };
-exports.microsoft = {
+export const microsoft = {
     AUTHORIZE_URL: 'https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize',
     ACCESS_TOKEN_URL: 'https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token',
 };
-exports.bitbucket = {
+export const bitbucket = {
     AUTHORIZE_URL: 'https://bitbucket.org/site/oauth2/authorize',
     ACCESS_TOKEN_URL: 'https://bitbucket.org/site/oauth2/access_token',
 };
-exports.facebook = {
+export const facebook = {
     AUTHORIZE_URL: 'https://www.facebook.com/v10.0/dialog/oauth',
     ACCESS_TOKEN_URL: 'https://graph.facebook.com/v10.0/dialog/oauth/access_token',
 };
-exports.spotify = {
+export const spotify = {
     AUTHORIZE_URL: 'https://accounts.spotify.com/authorize',
     ACCESS_TOKEN_URL: 'https://accounts.spotify.com/api/token',
     USER_INFO_URL: 'https://api.spotify.com/v1/me',

package/build/src/define_config.d.ts

@@ -0,0 +1,12 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { AllyDriversList } from './types.js';
+/**
+ * Define config for the ally
+ */
+export declare function defineConfig<KnownSocialProviders extends Record<string, {
+    [K in keyof AllyDriversList]: {
+        driver: K;
+    } & Parameters<AllyDriversList[K]>[0];
+}[keyof AllyDriversList]>>(config: KnownSocialProviders): {
+    [K in keyof KnownSocialProviders]: (ctx: HttpContext) => ReturnType<AllyDriversList[KnownSocialProviders[K]['driver']]>;
+};

package/build/src/define_config.js

@@ -0,0 +1,26 @@
+/*
+ * @adonisjs/ally
+ *
+ * (c) Ally
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import allyDriversCollection from './drivers_collection.js';
+/**
+ * Define config for the ally
+ */
+export function defineConfig(config) {
+    /**
+     * Converting user defined config to an object of providers
+     * that can be injected into the AllyManager class
+     */
+    const managerHashers = Object.keys(config).reduce((result, provider) => {
+        const providerConfig = config[provider];
+        result[provider] = (ctx) => {
+            return allyDriversCollection.create(providerConfig.driver, providerConfig, ctx);
+        };
+        return result;
+    }, {});
+    return managerHashers;
+}

package/build/src/{Drivers/Discord/index.d.ts → drivers/discord.d.ts}

@@ -1,6 +1,6 @@
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { DiscordScopes, DiscordToken, ApiRequestContract, DiscordDriverConfig, DiscordDriverContract, RedirectRequestContract } from '@ioc:Adonis/Addons/Ally';
-import { Oauth2Driver } from '../../AbstractDrivers/Oauth2';
+import type { HttpContext } from '@adonisjs/core/http';
+import { DiscordScopes, DiscordToken, ApiRequestContract, DiscordDriverConfig, DiscordDriverContract, RedirectRequestContract } from '../types.js';
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * Discord driver to login user via Discord
  */
@@ -34,7 +34,7 @@ export declare class DiscordDriver extends Oauth2Driver<DiscordToken, DiscordSco
      * Scopes separator
      */
     protected scopesSeparator: string;
-    constructor(ctx: HttpContextContract, config: DiscordDriverConfig);
+    constructor(ctx: HttpContext, config: DiscordDriverConfig);
     /**
      * Configuring the redirect request with defaults
      */

package/build/src/{Drivers/Discord/index.js → drivers/discord.js}

@@ -1,50 +1,48 @@
-"use strict";
 /*
  * @adonisjs/ally
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DiscordDriver = void 0;
-const Oauth2_1 = require("../../AbstractDrivers/Oauth2");
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * Discord driver to login user via Discord
  */
-class DiscordDriver extends Oauth2_1.Oauth2Driver {
+export class DiscordDriver extends Oauth2Driver {
+    config;
+    accessTokenUrl = 'https://discord.com/api/oauth2/token';
+    authorizeUrl = 'https://discord.com/api/oauth2/authorize';
+    userInfoUrl = 'https://discord.com/api/users/@me';
+    /**
+     * The param name for the authorization code
+     */
+    codeParamName = 'code';
+    /**
+     * The param name for the error
+     */
+    errorParamName = 'error';
+    /**
+     * Cookie name for storing the "discord_oauth_state"
+     */
+    stateCookieName = 'discord_oauth_state';
+    /**
+     * Parameter name to be used for sending and receiving the state
+     * from Discord
+     */
+    stateParamName = 'state';
+    /**
+     * Parameter name for defining the scopes
+     */
+    scopeParamName = 'scope';
+    /**
+     * Scopes separator
+     */
+    scopesSeparator = ' ';
     constructor(ctx, config) {
         super(ctx, config);
         this.config = config;
-        this.accessTokenUrl = 'https://discord.com/api/oauth2/token';
-        this.authorizeUrl = 'https://discord.com/api/oauth2/authorize';
-        this.userInfoUrl = 'https://discord.com/api/users/@me';
-        /**
-         * The param name for the authorization code
-         */
-        this.codeParamName = 'code';
-        /**
-         * The param name for the error
-         */
-        this.errorParamName = 'error';
-        /**
-         * Cookie name for storing the "discord_oauth_state"
-         */
-        this.stateCookieName = 'discord_oauth_state';
-        /**
-         * Parameter name to be used for sending and receiving the state
-         * from Discord
-         */
-        this.stateParamName = 'state';
-        /**
-         * Parameter name for defining the scopes
-         */
-        this.scopeParamName = 'scope';
-        /**
-         * Scopes separator
-         */
-        this.scopesSeparator = ' ';
         /**
          * Extremely important to call the following method to clear the
          * state set by the redirect request
@@ -156,4 +154,3 @@ class DiscordDriver extends Oauth2_1.Oauth2Driver {
         };
     }
 }
-exports.DiscordDriver = DiscordDriver;

package/build/src/{Drivers/Facebook/index.d.ts → drivers/facebook.d.ts}

@@ -1,6 +1,6 @@
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { FacebookToken, FacebookScopes, LiteralStringUnion, ApiRequestContract, FacebookDriverConfig, FacebookProfileFields, FacebookDriverContract, RedirectRequestContract } from '@ioc:Adonis/Addons/Ally';
-import { Oauth2Driver } from '../../AbstractDrivers/Oauth2';
+import type { HttpContext } from '@adonisjs/core/http';
+import { FacebookToken, FacebookScopes, LiteralStringUnion, ApiRequestContract, FacebookDriverConfig, FacebookProfileFields, FacebookDriverContract, RedirectRequestContract } from '../types.js';
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * Facebook driver to login user via Facebook
  */
@@ -38,7 +38,7 @@ export declare class FacebookDriver extends Oauth2Driver<FacebookToken, Facebook
      * Scopes separator
      */
     protected scopesSeparator: string;
-    constructor(ctx: HttpContextContract, config: FacebookDriverConfig);
+    constructor(ctx: HttpContext, config: FacebookDriverConfig);
     /**
      * Configuring the redirect request with defaults
      */

package/build/src/{Drivers/Facebook/index.js → drivers/facebook.js}

@@ -1,62 +1,60 @@
-"use strict";
 /*
  * @adonisjs/ally
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FacebookDriver = void 0;
-const Oauth2_1 = require("../../AbstractDrivers/Oauth2");
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * Facebook driver to login user via Facebook
  */
-class FacebookDriver extends Oauth2_1.Oauth2Driver {
+export class FacebookDriver extends Oauth2Driver {
+    config;
+    accessTokenUrl = 'https://graph.facebook.com/v10.0/oauth/access_token';
+    authorizeUrl = 'https://www.facebook.com/v10.0/dialog/oauth';
+    userInfoUrl = 'https://graph.facebook.com/v10.0/me';
+    /**
+     * The default set of fields to query for the user request
+     */
+    userFields = [
+        'name',
+        'first_name',
+        'last_name',
+        'link',
+        'email',
+        'picture.width(400).height(400)',
+        'verified',
+    ];
+    /**
+     * The param name for the authorization code
+     */
+    codeParamName = 'code';
+    /**
+     * The param name for the error
+     */
+    errorParamName = 'error';
+    /**
+     * Cookie name for storing the "facebok_oauth_state"
+     */
+    stateCookieName = 'facebok_oauth_state';
+    /**
+     * Parameter name to be used for sending and receiving the state
+     * from Facebok
+     */
+    stateParamName = 'state';
+    /**
+     * Parameter name for defining the scopes
+     */
+    scopeParamName = 'scope';
+    /**
+     * Scopes separator
+     */
+    scopesSeparator = ' ';
     constructor(ctx, config) {
         super(ctx, config);
         this.config = config;
-        this.accessTokenUrl = 'https://graph.facebook.com/v10.0/oauth/access_token';
-        this.authorizeUrl = 'https://www.facebook.com/v10.0/dialog/oauth';
-        this.userInfoUrl = 'https://graph.facebook.com/v10.0/me';
-        /**
-         * The default set of fields to query for the user request
-         */
-        this.userFields = [
-            'name',
-            'first_name',
-            'last_name',
-            'link',
-            'email',
-            'picture.width(400).height(400)',
-            'verified',
-        ];
-        /**
-         * The param name for the authorization code
-         */
-        this.codeParamName = 'code';
-        /**
-         * The param name for the error
-         */
-        this.errorParamName = 'error';
-        /**
-         * Cookie name for storing the "facebok_oauth_state"
-         */
-        this.stateCookieName = 'facebok_oauth_state';
-        /**
-         * Parameter name to be used for sending and receiving the state
-         * from Facebok
-         */
-        this.stateParamName = 'state';
-        /**
-         * Parameter name for defining the scopes
-         */
-        this.scopeParamName = 'scope';
-        /**
-         * Scopes separator
-         */
-        this.scopesSeparator = ' ';
         /**
          * Extremely important to call the following method to clear the
          * state set by the redirect request
@@ -155,4 +153,3 @@ class FacebookDriver extends Oauth2_1.Oauth2Driver {
         };
     }
 }
-exports.FacebookDriver = FacebookDriver;

package/build/src/{Drivers/Github/index.d.ts → drivers/github.d.ts}

@@ -1,6 +1,6 @@
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { GithubToken, GithubScopes, GithubDriverConfig, ApiRequestContract, GithubDriverContract, RedirectRequestContract } from '@ioc:Adonis/Addons/Ally';
-import { Oauth2Driver } from '../../AbstractDrivers/Oauth2';
+import type { HttpContext } from '@adonisjs/core/http';
+import { GithubToken, GithubScopes, GithubDriverConfig, ApiRequestContract, GithubDriverContract, RedirectRequestContract } from '../types.js';
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * Github driver to login user via Github
  */
@@ -35,7 +35,7 @@ export declare class GithubDriver extends Oauth2Driver<GithubToken, GithubScopes
      * Scopes separator
      */
     protected scopesSeparator: string;
-    constructor(ctx: HttpContextContract, config: GithubDriverConfig);
+    constructor(ctx: HttpContext, config: GithubDriverConfig);
     /**
      * Configuring the redirect request with defaults
      */

package/build/src/{Drivers/Github/index.js → drivers/github.js}

@@ -1,51 +1,49 @@
-"use strict";
 /*
  * @adonisjs/ally
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GithubDriver = void 0;
-const Oauth2_1 = require("../../AbstractDrivers/Oauth2");
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * Github driver to login user via Github
  */
-class GithubDriver extends Oauth2_1.Oauth2Driver {
+export class GithubDriver extends Oauth2Driver {
+    config;
+    accessTokenUrl = 'https://github.com/login/oauth/access_token';
+    authorizeUrl = 'https://github.com/login/oauth/authorize';
+    userInfoUrl = 'https://api.github.com/user';
+    userEmailUrl = 'https://api.github.com/user/emails';
+    /**
+     * The param name for the authorization code
+     */
+    codeParamName = 'code';
+    /**
+     * The param name for the error
+     */
+    errorParamName = 'error';
+    /**
+     * Cookie name for storing the "gh_oauth_state"
+     */
+    stateCookieName = 'gh_oauth_state';
+    /**
+     * Parameter name to be used for sending and receiving the state
+     * from Github
+     */
+    stateParamName = 'state';
+    /**
+     * Parameter name for defining the scopes
+     */
+    scopeParamName = 'scope';
+    /**
+     * Scopes separator
+     */
+    scopesSeparator = ' ';
     constructor(ctx, config) {
         super(ctx, config);
         this.config = config;
-        this.accessTokenUrl = 'https://github.com/login/oauth/access_token';
-        this.authorizeUrl = 'https://github.com/login/oauth/authorize';
-        this.userInfoUrl = 'https://api.github.com/user';
-        this.userEmailUrl = 'https://api.github.com/user/emails';
-        /**
-         * The param name for the authorization code
-         */
-        this.codeParamName = 'code';
-        /**
-         * The param name for the error
-         */
-        this.errorParamName = 'error';
-        /**
-         * Cookie name for storing the "gh_oauth_state"
-         */
-        this.stateCookieName = 'gh_oauth_state';
-        /**
-         * Parameter name to be used for sending and receiving the state
-         * from Github
-         */
-        this.stateParamName = 'state';
-        /**
-         * Parameter name for defining the scopes
-         */
-        this.scopeParamName = 'scope';
-        /**
-         * Scopes separator
-         */
-        this.scopesSeparator = ' ';
         /**
          * Extremely important to call the following method to clear the
          * state set by the redirect request
@@ -213,4 +211,3 @@ class GithubDriver extends Oauth2_1.Oauth2Driver {
         };
     }
 }
-exports.GithubDriver = GithubDriver;

package/build/src/{Drivers/Google/index.d.ts → drivers/google.d.ts}

@@ -1,6 +1,6 @@
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { GoogleToken, GoogleScopes, GoogleDriverConfig, ApiRequestContract, GoogleDriverContract, RedirectRequestContract } from '@ioc:Adonis/Addons/Ally';
-import { Oauth2Driver } from '../../AbstractDrivers/Oauth2';
+import type { HttpContext } from '@adonisjs/core/http';
+import { GoogleToken, GoogleScopes, GoogleDriverConfig, ApiRequestContract, GoogleDriverContract, RedirectRequestContract } from '../types.js';
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * Google driver to login user via Google
  */
@@ -34,7 +34,7 @@ export declare class GoogleDriver extends Oauth2Driver<GoogleToken, GoogleScopes
      * Scopes separator
      */
     protected scopesSeparator: string;
-    constructor(ctx: HttpContextContract, config: GoogleDriverConfig);
+    constructor(ctx: HttpContext, config: GoogleDriverConfig);
     /**
      * Configuring the redirect request with defaults
      */
@@ -59,6 +59,10 @@ export declare class GoogleDriver extends Oauth2Driver<GoogleToken, GoogleScopes
      * Find if the current error code is for access denied
      */
     accessDenied(): boolean;
+    /**
+     * Get access token
+     */
+    accessToken(callback?: (request: ApiRequestContract) => void): Promise<GoogleToken>;
     /**
      * Returns details for the authorized user
      */

package/build/src/{Drivers/Google/index.js → drivers/google.js}

@@ -1,15 +1,12 @@
-"use strict";
 /*
  * @adonisjs/ally
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GoogleDriver = void 0;
-const Oauth2_1 = require("../../AbstractDrivers/Oauth2");
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 const SCOPE_PREFIXES = {
     'https://www.googleapis.com/auth': [
         'userinfo.email',
@@ -50,38 +47,39 @@ const SCOPE_PREFIXES = {
 /**
  * Google driver to login user via Google
  */
-class GoogleDriver extends Oauth2_1.Oauth2Driver {
+export class GoogleDriver extends Oauth2Driver {
+    config;
+    accessTokenUrl = 'https://oauth2.googleapis.com/token';
+    authorizeUrl = 'https://accounts.google.com/o/oauth2/v2/auth';
+    userInfoUrl = 'https://www.googleapis.com/oauth2/v3/userinfo';
+    /**
+     * The param name for the authorization code
+     */
+    codeParamName = 'code';
+    /**
+     * The param name for the error
+     */
+    errorParamName = 'error';
+    /**
+     * Cookie name for storing the "google_oauth_state"
+     */
+    stateCookieName = 'google_oauth_state';
+    /**
+     * Parameter name to be used for sending and receiving the state
+     * from google
+     */
+    stateParamName = 'state';
+    /**
+     * Parameter name for defining the scopes
+     */
+    scopeParamName = 'scope';
+    /**
+     * Scopes separator
+     */
+    scopesSeparator = ' ';
     constructor(ctx, config) {
         super(ctx, config);
         this.config = config;
-        this.accessTokenUrl = 'https://oauth2.googleapis.com/token';
-        this.authorizeUrl = 'https://accounts.google.com/o/oauth2/v2/auth';
-        this.userInfoUrl = 'https://www.googleapis.com/oauth2/v3/userinfo';
-        /**
-         * The param name for the authorization code
-         */
-        this.codeParamName = 'code';
-        /**
-         * The param name for the error
-         */
-        this.errorParamName = 'error';
-        /**
-         * Cookie name for storing the "google_oauth_state"
-         */
-        this.stateCookieName = 'google_oauth_state';
-        /**
-         * Parameter name to be used for sending and receiving the state
-         * from google
-         */
-        this.stateParamName = 'state';
-        /**
-         * Parameter name for defining the scopes
-         */
-        this.scopeParamName = 'scope';
-        /**
-         * Scopes separator
-         */
-        this.scopesSeparator = ' ';
         /**
          * Extremely important to call the following method to clear the
          * state set by the redirect request
@@ -156,6 +154,16 @@ class GoogleDriver extends Oauth2_1.Oauth2Driver {
         }
         return error === 'access_denied';
     }
+    /**
+     * Get access token
+     */
+    async accessToken(callback) {
+        const token = await super.accessToken(callback);
+        return {
+            ...token,
+            idToken: token.id_token,
+        };
+    }
     /**
      * Returns details for the authorized user
      */
@@ -187,4 +195,3 @@ class GoogleDriver extends Oauth2_1.Oauth2Driver {
         });
     }
 }
-exports.GoogleDriver = GoogleDriver;

package/build/src/{Drivers/LinkedIn/index.d.ts → drivers/linked_in.d.ts}

@@ -1,6 +1,6 @@
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { LinkedInToken, LinkedInScopes, ApiRequestContract, LinkedInDriverConfig, LinkedInDriverContract, RedirectRequestContract } from '@ioc:Adonis/Addons/Ally';
-import { Oauth2Driver } from '../../AbstractDrivers/Oauth2';
+import type { HttpContext } from '@adonisjs/core/http';
+import { LinkedInToken, LinkedInScopes, ApiRequestContract, LinkedInDriverConfig, LinkedInDriverContract, RedirectRequestContract } from '../types.js';
+import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
 /**
  * LinkedIn driver to login user via LinkedIn
  */
@@ -35,7 +35,7 @@ export declare class LinkedInDriver extends Oauth2Driver<LinkedInToken, LinkedIn
      * Scopes separator
      */
     protected scopesSeparator: string;
-    constructor(ctx: HttpContextContract, config: LinkedInDriverConfig);
+    constructor(ctx: HttpContext, config: LinkedInDriverConfig);
     /**
      * Configuring the redirect request with defaults
      */