@adonisjs/ally 5.0.0-6 → 5.0.0-7

package/build/src/drivers/github.js

@@ -1,213 +0,0 @@
-/*
- * @adonisjs/ally
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
-/**
- * Github driver to login user via Github
- */
-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;
-        /**
-         * Extremely important to call the following method to clear the
-         * state set by the redirect request
-         */
-        this.loadState();
-    }
-    /**
-     * Configuring the redirect request with defaults
-     */
-    configureRedirectRequest(request) {
-        /**
-         * Define user defined scopes or the default one's
-         */
-        request.scopes(this.config.scopes || ['user']);
-        /**
-         * Set "allow_signup" option when defined
-         */
-        if (this.config.allowSignup !== undefined) {
-            request.param('allow_signup', this.config.allowSignup);
-        }
-        /**
-         * Set "login" option when defined
-         */
-        if (this.config.login) {
-            request.param('login', this.config.login);
-        }
-    }
-    /**
-     * Configuring the access token API request to send extra fields
-     */
-    configureAccessTokenRequest(request) {
-        /**
-         * Send state to github when request is not stateles
-         */
-        if (!this.isStateless) {
-            request.field('state', this.stateCookieValue);
-        }
-        /**
-         * Clearing the default defined "grant_type". Github doesn't accept this.
-         * https://github.com/poppinss/oauth-client#following-is-the-list-of-fieldsparams-set-by-the-clients-implicitly
-         */
-        request.clearField('grant_type');
-    }
-    /**
-     * Returns the HTTP request with the authorization header set
-     */
-    getAuthenticatedRequest(url, token) {
-        const request = this.httpClient(url);
-        request.header('Authorization', `token ${token}`);
-        request.header('Accept', 'application/json');
-        request.parseAs('json');
-        return request;
-    }
-    /**
-     * Fetches the user info from the Github API
-     * https://docs.github.com/en/rest/reference/users#get-the-authenticated-user
-     */
-    async getUserInfo(token, callback) {
-        const request = this.getAuthenticatedRequest(this.config.userInfoUrl || this.userInfoUrl, token);
-        if (typeof callback === 'function') {
-            callback(request);
-        }
-        const body = await request.get();
-        return {
-            id: body.id,
-            nickName: body.name,
-            email: body.email,
-            emailVerificationState: (body.email
-                ? 'verified'
-                : 'unsupported'),
-            name: body.name,
-            avatarUrl: body.avatar_url,
-            original: body,
-        };
-    }
-    /**
-     * Fetches the user email from the Github API.
-     * https://docs.github.com/en/rest/reference/users#list-email-addresses-for-the-authenticated-user
-     */
-    async getUserEmail(token, callback) {
-        const request = this.getAuthenticatedRequest(this.config.userEmailUrl || this.userEmailUrl, token);
-        if (typeof callback === 'function') {
-            callback(request);
-        }
-        try {
-            let emails = await request.get();
-            /**
-             * Sort emails to keep the primary ones on the top
-             */
-            emails = emails.sort((email) => (email.primary ? -1 : 1));
-            /**
-             * Get the first verified email of the user
-             */
-            let mainEmail = emails.find((email) => email.verified);
-            /**
-             * If there are no verified emails, then get any first one
-             */
-            if (!mainEmail) {
-                mainEmail = emails[0];
-            }
-            return mainEmail;
-        }
-        catch (error) {
-            if (error && error.response && error.response.statusCode === 404) {
-                return;
-            }
-            throw error;
-        }
-    }
-    /**
-     * Find if the current error code is for access denied
-     */
-    accessDenied() {
-        const error = this.getError();
-        if (!error) {
-            return false;
-        }
-        return error === 'access_denied';
-    }
-    /**
-     * Returns details for the authorized user
-     */
-    async user(callback) {
-        const token = await this.accessToken(callback);
-        const user = await this.getUserInfo(token.token, callback);
-        /**
-         * Fetch email separately
-         */
-        if (!user.email) {
-            this.ctx.logger.trace('Fetching github user email separately');
-            const emailResponse = await this.getUserEmail(token.token, callback);
-            if (emailResponse) {
-                user.email = emailResponse.email;
-                user.emailVerificationState = emailResponse.verified
-                    ? 'verified'
-                    : 'unverified';
-            }
-        }
-        return {
-            ...user,
-            token: token,
-        };
-    }
-    /**
-     * Finds the user by the access token
-     */
-    async userFromToken(token, callback) {
-        const user = await this.getUserInfo(token, callback);
-        /**
-         * Fetch email separately
-         */
-        if (!user.email) {
-            this.ctx.logger.trace('Fetching github user email separately');
-            const emailResponse = await this.getUserEmail(token, callback);
-            if (emailResponse) {
-                user.email = emailResponse.email;
-                user.emailVerificationState = emailResponse.verified
-                    ? 'verified'
-                    : 'unverified';
-            }
-        }
-        return {
-            ...user,
-            token: { token, type: 'bearer' },
-        };
-    }
-}

package/build/src/drivers/google.js

@@ -1,197 +0,0 @@
-/*
- * @adonisjs/ally
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
-const SCOPE_PREFIXES = {
-    'https://www.googleapis.com/auth': [
-        'userinfo.email',
-        'userinfo.profile',
-        'contacts',
-        'contacts.other.readonly',
-        'contacts.readonly',
-        'directory.readonly',
-        'user.addresses.read',
-        'user.birthday.read',
-        'user.emails.read',
-        'user.gender.read',
-        'user.organization.read',
-        'user.phonenumbers.read',
-        'analytics',
-        'analytics.readonly',
-        'documents',
-        'documents.readonly',
-        'forms',
-        'forms.currentonly',
-        'groups',
-        'spreadsheets',
-        'calendar',
-        'calendar.events',
-        'calendar.events.readonly',
-        'calendar.readonly',
-        'calendar.settings.readonly',
-        'drive',
-        'drive.appdata',
-        'drive.file',
-        'drive.metadata',
-        'drive.metadata.readonly',
-        'drive.photos.readonly',
-        'drive.readonly',
-        'drive.scripts',
-    ],
-};
-/**
- * Google driver to login user via Google
- */
-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;
-        /**
-         * Extremely important to call the following method to clear the
-         * state set by the redirect request
-         */
-        this.loadState();
-    }
-    /**
-     * Configuring the redirect request with defaults
-     */
-    configureRedirectRequest(request) {
-        request.transformScopes((scopes) => this.buildScopes(scopes));
-        /**
-         * Define user defined scopes or the default one's
-         */
-        request.scopes(this.config.scopes || ['openid', 'userinfo.email', 'userinfo.profile']);
-        /**
-         * Set "response_type" param
-         */
-        request.param('response_type', 'code');
-        /**
-         * Define params based upon user config
-         */
-        if (this.config.accessType) {
-            request.param('access_type', this.config.accessType);
-        }
-        if (this.config.prompt) {
-            request.param('prompt', this.config.prompt);
-        }
-        if (this.config.display) {
-            request.param('display', this.config.display);
-        }
-        if (this.config.hostedDomain) {
-            request.param('hd', this.config.hostedDomain);
-        }
-    }
-    /**
-     * Returns the HTTP request with the authorization header set
-     */
-    getAuthenticatedRequest(url, token) {
-        const request = this.httpClient(url);
-        request.header('Authorization', `Bearer ${token}`);
-        request.header('Accept', 'application/json');
-        request.parseAs('json');
-        return request;
-    }
-    /**
-     * Fetches the user info from the Google API
-     */
-    async getUserInfo(token, callback) {
-        const request = this.getAuthenticatedRequest(this.config.userInfoUrl || this.userInfoUrl, token);
-        if (typeof callback === 'function') {
-            callback(request);
-        }
-        const body = await request.get();
-        return {
-            id: body.sub,
-            nickName: body.name,
-            name: body.name,
-            email: body.email,
-            avatarUrl: body.picture,
-            emailVerificationState: body.email_verified ? 'verified' : 'unverified',
-            original: body,
-        };
-    }
-    /**
-     * Find if the current error code is for access denied
-     */
-    accessDenied() {
-        const error = this.getError();
-        if (!error) {
-            return false;
-        }
-        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
-     */
-    async user(callback) {
-        const token = await this.accessToken(callback);
-        const user = await this.getUserInfo(token.token, callback);
-        return {
-            ...user,
-            token: token,
-        };
-    }
-    /**
-     * Finds the user by the access token
-     */
-    async userFromToken(token, callback) {
-        const user = await this.getUserInfo(token, callback);
-        return {
-            ...user,
-            token: { token, type: 'bearer' },
-        };
-    }
-    /**
-     * Prefixes google scopes with the url
-     */
-    buildScopes(scopes) {
-        return scopes.map((name) => {
-            const prefix = Object.keys(SCOPE_PREFIXES).find((one) => SCOPE_PREFIXES[one].includes(name));
-            return prefix ? `${prefix}/${name}` : name;
-        });
-    }
-}

package/build/src/drivers/linked_in.js

@@ -1,166 +0,0 @@
-/*
- * @adonisjs/ally
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Exception } from '@poppinss/utils';
-import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
-/**
- * LinkedIn driver to login user via LinkedIn
- */
-export class LinkedInDriver extends Oauth2Driver {
-    config;
-    accessTokenUrl = 'https://www.linkedin.com/oauth/v2/accessToken';
-    authorizeUrl = 'https://www.linkedin.com/oauth/v2/authorization';
-    userInfoUrl = 'https://api.linkedin.com/v2/me';
-    userEmailUrl = 'https://api.linkedin.com/v2/clientAwareMemberHandles';
-    /**
-     * The param name for the authorization code
-     */
-    codeParamName = 'code';
-    /**
-     * The param name for the error
-     */
-    errorParamName = 'error';
-    /**
-     * Cookie name for storing the "linkedin_oauth_state"
-     */
-    stateCookieName = 'linkedin_oauth_state';
-    /**
-     * Parameter name to be used for sending and receiving the state
-     * from linkedin
-     */
-    stateParamName = 'state';
-    /**
-     * Parameter name for defining the scopes
-     */
-    scopeParamName = 'scope';
-    /**
-     * Scopes separator
-     */
-    scopesSeparator = ' ';
-    constructor(ctx, config) {
-        super(ctx, config);
-        this.config = config;
-        /**
-         * Extremely important to call the following method to clear the
-         * state set by the redirect request
-         */
-        this.loadState();
-    }
-    /**
-     * Configuring the redirect request with defaults
-     */
-    configureRedirectRequest(request) {
-        /**
-         * Define user defined scopes or the default one's
-         */
-        request.scopes(this.config.scopes || ['r_emailaddress', 'r_liteprofile']);
-        /**
-         * Set "response_type" param
-         */
-        request.param('response_type', 'code');
-    }
-    /**
-     * Returns the HTTP request with the authorization header set
-     */
-    getAuthenticatedRequest(url, token) {
-        const request = this.httpClient(url);
-        request.header('Authorization', `Bearer ${token}`);
-        request.header('Accept', 'application/json');
-        request.parseAs('json');
-        return request;
-    }
-    /**
-     * Fetches the user info from the LinkedIn API
-     */
-    async getUserInfo(token, callback) {
-        let url = this.config.userInfoUrl || this.userInfoUrl;
-        const request = this.getAuthenticatedRequest(url, token);
-        request.param('projection', '(id,localizedLastName,localizedFirstName,vanityName,profilePicture(displayImage~digitalmediaAsset:playableStreams))');
-        if (typeof callback === 'function') {
-            callback(request);
-        }
-        const body = await request.get();
-        /**
-         * Finding the user avatar
-         */
-        let avatar = '';
-        if (body.profilePicture) {
-            const avatars = body.profilePicture['displayImage~']['elements'] || [];
-            if (avatars.length && avatars[0].identifiers && avatars[0].identifiers.length) {
-                avatar = avatars[0].identifiers[0].identifier;
-            }
-        }
-        return {
-            id: body.id,
-            nickName: body.vanityName || `${body.localizedFirstName} ${body.localizedLastName}`,
-            name: `${body.localizedFirstName} ${body.localizedLastName}`,
-            avatarUrl: avatar,
-            original: body,
-        };
-    }
-    /**
-     * Fetches the user email from the LinkedIn API
-     */
-    async getUserEmail(token, callback) {
-        let url = this.config.userEmailUrl || this.userEmailUrl;
-        const request = this.getAuthenticatedRequest(url, token);
-        request.param('q', 'members');
-        request.param('projection', '(elements*(primary,type,handle~))');
-        if (typeof callback === 'function') {
-            callback(request);
-        }
-        const body = await request.get();
-        let mainEmail = body.elements.find((resource) => {
-            return resource.type === 'EMAIL' && resource['handle~'];
-        });
-        /**
-         * We except email to always exist
-         */
-        if (!mainEmail) {
-            throw new Exception('Cannot request user email. Make sure you are using the "r_emailaddress" scope');
-        }
-        return mainEmail['handle~']['emailAddress'];
-    }
-    /**
-     * Find if the current error code is for access denied
-     */
-    accessDenied() {
-        const error = this.getError();
-        if (!error) {
-            return false;
-        }
-        return error === 'user_cancelled_login' || error === 'user_cancelled_authorize';
-    }
-    /**
-     * Returns details for the authorized user
-     */
-    async user(callback) {
-        const token = await this.accessToken(callback);
-        const user = await this.getUserInfo(token.token, callback);
-        const email = await this.getUserEmail(token.token, callback);
-        return {
-            ...user,
-            email: email,
-            emailVerificationState: 'unsupported',
-            token: token,
-        };
-    }
-    /**
-     * Finds the user by the access token
-     */
-    async userFromToken(token, callback) {
-        const user = await this.getUserInfo(token, callback);
-        const email = await this.getUserEmail(token, callback);
-        return {
-            ...user,
-            email: email,
-            emailVerificationState: 'unsupported',
-            token: { token, type: 'bearer' },
-        };
-    }
-}

package/build/src/drivers/spotify.js

@@ -1,130 +0,0 @@
-/*
- * @adonisjs/ally
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { Oauth2Driver } from '../abstract_drivers/oauth2.js';
-/**
- * Spotify driver to login user via Spotify
- */
-export class SpotifyDriver extends Oauth2Driver {
-    config;
-    accessTokenUrl = 'https://accounts.spotify.com/api/token';
-    authorizeUrl = 'https://accounts.spotify.com/authorize';
-    userInfoUrl = 'https://api.spotify.com/v1/me';
-    /**
-     * The param name for the authorization code
-     */
-    codeParamName = 'code';
-    /**
-     * The param name for the error
-     */
-    errorParamName = 'error';
-    /**
-     * Cookie name for storing the "spotify_oauth_state"
-     */
-    stateCookieName = 'spotify_oauth_state';
-    /**
-     * Parameter name to be used for sending and receiving the state
-     * from Spotify
-     */
-    stateParamName = 'state';
-    /**
-     * Parameter name for defining the scopes
-     */
-    scopeParamName = 'scope';
-    /**
-     * Scopes separator
-     */
-    scopesSeparator = ' ';
-    constructor(ctx, config) {
-        super(ctx, config);
-        this.config = config;
-        /**
-         * Extremely important to call the following method to clear the
-         * state set by the redirect request
-         */
-        this.loadState();
-    }
-    /**
-     * Configuring the redirect request with defaults
-     */
-    configureRedirectRequest(request) {
-        /**
-         * Define user defined scopes or the default one's
-         */
-        request.scopes(this.config.scopes || ['user-read-email']);
-        request.param('response_type', 'code');
-        request.param('grant_type', 'authorization_code');
-        /**
-         * Define params based upon user config
-         */
-        if (this.config.showDialog) {
-            request.param('show_dialog', this.config.showDialog);
-        }
-    }
-    /**
-     * Returns the HTTP request with the authorization header set
-     */
-    getAuthenticatedRequest(url, token) {
-        const request = this.httpClient(url);
-        request.header('Authorization', `Bearer ${token}`);
-        request.header('Accept', 'application/json');
-        request.parseAs('json');
-        return request;
-    }
-    /**
-     * Fetches the user info from the Spotify API
-     * https://discord.com/developers/docs/resources/user#get-current-user
-     */
-    async getUserInfo(token, callback) {
-        const request = this.getAuthenticatedRequest(this.userInfoUrl, token);
-        if (typeof callback === 'function') {
-            callback(request);
-        }
-        const body = await request.get();
-        return {
-            id: body.id,
-            nickName: body.display_name,
-            name: body.display_name,
-            email: body.email,
-            avatarUrl: body.images[0]?.url || null,
-            emailVerificationState: 'unsupported',
-            original: body,
-        };
-    }
-    /**
-     * Find if the current error code is for access denied
-     */
-    accessDenied() {
-        const error = this.getError();
-        if (!error) {
-            return false;
-        }
-        return error === 'access_denied';
-    }
-    /**
-     * Returns details for the authorized user
-     */
-    async user(callback) {
-        const token = await this.accessToken(callback);
-        const user = await this.getUserInfo(token.token, callback);
-        return {
-            ...user,
-            token,
-        };
-    }
-    /**
-     * Finds the user by the access token
-     */
-    async userFromToken(token, callback) {
-        const user = await this.getUserInfo(token, callback);
-        return {
-            ...user,
-            token: { token, type: 'bearer' },
-        };
-    }
-}