@adonisjs/ally 5.0.0-6 → 5.0.0-8

package/build/src/abstract_drivers/oauth2.js

@@ -1,175 +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 { Oauth2Client } from '@poppinss/oauth-client/oauth2';
-import * as errors from '../errors.js';
-import { RedirectRequest } from '../redirect_request.js';
-/**
- * Abstract implementation for an Oauth2 driver
- */
-export class Oauth2Driver extends Oauth2Client {
-    ctx;
-    config;
-    /**
-     * Is the authorization process stateless?
-     */
-    isStateless = false;
-    /**
-     * Oauth client version
-     */
-    version = 'oauth2';
-    /**
-     * The value of state read from the cookies.
-     */
-    stateCookieValue;
-    constructor(ctx, config) {
-        super(config);
-        this.ctx = ctx;
-        this.config = config;
-    }
-    /**
-     * The Oauth2Client will use the instance returned from this method to
-     * build the redirect url
-     */
-    urlBuilder(url) {
-        return new RedirectRequest(url, this.scopeParamName, this.scopesSeparator);
-    }
-    /**
-     * Loads the value of state from the cookie and removes it right
-     * away. We read the cookie value and clear it during the
-     * current request lifecycle.
-     *
-     * :::::
-     * NOTE
-     * :::::
-     *
-     * This child class must call this method inside the constructor.
-     */
-    loadState() {
-        if (this.isStateless) {
-            return;
-        }
-        this.stateCookieValue = this.ctx.request.encryptedCookie(this.stateCookieName);
-        this.ctx.response.clearCookie(this.stateCookieName);
-    }
-    /**
-     * Persists the state inside the cookie
-     */
-    #persistState() {
-        if (this.isStateless) {
-            return;
-        }
-        const state = this.getState();
-        this.ctx.response.encryptedCookie(this.stateCookieName, state, {
-            sameSite: false,
-            httpOnly: true,
-        });
-        return state;
-    }
-    /**
-     * Perform stateless authentication. Only applicable for Oauth2 client
-     */
-    stateless() {
-        this.isStateless = true;
-        return this;
-    }
-    /**
-     * Returns the redirect URL for the request.
-     */
-    async redirectUrl(callback) {
-        const url = this.getRedirectUrl(callback);
-        return url;
-    }
-    /**
-     * Redirect user for authorization.
-     */
-    async redirect(callback) {
-        const url = await this.redirectUrl((request) => {
-            const state = this.#persistState();
-            state && request.param(this.stateParamName, state);
-            if (typeof callback === 'function') {
-                callback(request);
-            }
-        });
-        this.ctx.response.redirect(url);
-    }
-    /**
-     * Find if there is a state mismatch
-     */
-    stateMisMatch() {
-        if (this.isStateless) {
-            return false;
-        }
-        return this.stateCookieValue !== this.ctx.request.input(this.stateParamName);
-    }
-    /**
-     * Find if there is an error post redirect
-     */
-    hasError() {
-        return !!this.getError();
-    }
-    /**
-     * Get the post redirect error
-     */
-    getError() {
-        const error = this.ctx.request.input(this.errorParamName);
-        if (error) {
-            return error;
-        }
-        if (!this.hasCode()) {
-            return 'unknown_error';
-        }
-        return null;
-    }
-    /**
-     * Returns the authorization code
-     */
-    getCode() {
-        return this.ctx.request.input(this.codeParamName, null);
-    }
-    /**
-     * Find it the code exists
-     */
-    hasCode() {
-        return !!this.getCode();
-    }
-    /**
-     * Get access token
-     */
-    async accessToken(callback) {
-        /**
-         * We expect the user to handle errors before calling this method
-         */
-        if (this.hasError()) {
-            throw new errors.E_OAUTH_MISSING_CODE([this.codeParamName]);
-        }
-        /**
-         * We expect the user to properly handle the state mis-match use case before
-         * calling this method
-         */
-        if (this.stateMisMatch()) {
-            throw new errors.E_OAUTH_STATE_MISMATCH();
-        }
-        /**
-         * Get access token by providing the authorization code
-         */
-        return this.getAccessToken((request) => {
-            request.field(this.codeParamName, this.getCode());
-            if (typeof callback === 'function') {
-                callback(request);
-            }
-        });
-    }
-    /**
-     * Not applicable with Oauth2
-     */
-    async userFromTokenAndSecret() {
-        throw new Exception('"userFromTokenAndSecret" is not applicable with Oauth2. Use "userFromToken" instead');
-    }
-}

package/build/src/ally_manager.js

@@ -1,40 +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 { RuntimeException } from '@poppinss/utils';
-/**
- * AllyManager is used to create instances of a social drivers during an
- * HTTP request. The drivers are cached during the lifecycle of a request.
- */
-export class AllyManager {
-    /**
-     * Config with the list of social providers
-     */
-    #config;
-    #ctx;
-    #driversCache = new Map();
-    constructor(config, ctx) {
-        this.#ctx = ctx;
-        this.#config = config;
-    }
-    /**
-     * Returns the driver instance of a social provider
-     */
-    use(provider) {
-        if (this.#driversCache.has(provider)) {
-            return this.#driversCache.get(provider);
-        }
-        const driver = this.#config[provider];
-        if (!driver) {
-            throw new RuntimeException(`Unknown ally provider "${String(provider)}". Make sure it is registered inside the config/ally.ts file`);
-        }
-        const driverInstance = driver(this.#ctx);
-        this.#driversCache.set(provider, driverInstance);
-        return driverInstance;
-    }
-}

package/build/src/debug.js

@@ -1,10 +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 { debuglog } from 'node:util';
-export default debuglog('adonisjs:ally');

package/build/src/define_config.js

@@ -1,75 +0,0 @@
-/*
- * @adonisjs/ally
- *
- * (c) Ally
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { configProvider } from '@adonisjs/core';
-/**
- * Define config for the ally
- */
-export function defineConfig(config) {
-    return configProvider.create(async (app) => {
-        const serviceNames = Object.keys(config);
-        const services = {};
-        for (let serviceName of serviceNames) {
-            const service = config[serviceName];
-            if (typeof service === 'function') {
-                services[serviceName] = service;
-            }
-            else {
-                services[serviceName] = await service.resolver(app);
-            }
-        }
-        return services;
-    });
-}
-/**
- * Helpers to configure social auth services
- */
-export const services = {
-    discord(config) {
-        return configProvider.create(async () => {
-            const { DiscordDriver } = await import('./drivers/discord.js');
-            return (ctx) => new DiscordDriver(ctx, config);
-        });
-    },
-    facebook(config) {
-        return configProvider.create(async () => {
-            const { FacebookDriver } = await import('./drivers/facebook.js');
-            return (ctx) => new FacebookDriver(ctx, config);
-        });
-    },
-    github(config) {
-        return configProvider.create(async () => {
-            const { GithubDriver } = await import('./drivers/github.js');
-            return (ctx) => new GithubDriver(ctx, config);
-        });
-    },
-    google(config) {
-        return configProvider.create(async () => {
-            const { GoogleDriver } = await import('./drivers/google.js');
-            return (ctx) => new GoogleDriver(ctx, config);
-        });
-    },
-    linkedin(config) {
-        return configProvider.create(async () => {
-            const { LinkedInDriver } = await import('./drivers/linked_in.js');
-            return (ctx) => new LinkedInDriver(ctx, config);
-        });
-    },
-    spotify(config) {
-        return configProvider.create(async () => {
-            const { SpotifyDriver } = await import('./drivers/spotify.js');
-            return (ctx) => new SpotifyDriver(ctx, config);
-        });
-    },
-    twitter(config) {
-        return configProvider.create(async () => {
-            const { TwitterDriver } = await import('./drivers/twitter.js');
-            return (ctx) => new TwitterDriver(ctx, config);
-        });
-    },
-};

package/build/src/drivers/discord.js

@@ -1,156 +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';
-/**
- * Discord driver to login user via Discord
- */
-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;
-        /**
-         * 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 || ['identify', 'email']);
-        request.param('response_type', 'code');
-        request.param('grant_type', 'authorization_code');
-        /**
-         * Define params based upon user config
-         */
-        if (this.config.prompt) {
-            request.param('prompt', this.config.prompt);
-        }
-        if (this.config.guildId) {
-            request.param('guild_id', this.config.guildId);
-        }
-        if (this.config.disableGuildSelect !== undefined) {
-            request.param('disable_guild_select', this.config.disableGuildSelect);
-        }
-        if (this.config.permissions !== undefined) {
-            request.param('permissions', this.config.permissions);
-        }
-    }
-    /**
-     * Configuring the access token API request to send extra fields
-     */
-    configureAccessTokenRequest(request) {
-        /**
-         * Send state to Discord when request is not stateles
-         */
-        if (!this.isStateless) {
-            request.field('state', this.stateCookieValue);
-        }
-    }
-    /**
-     * 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 Discord API
-     * https://discord.com/developers/docs/resources/user#get-current-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,
-            name: `${body.username}#${body.discriminator}`,
-            nickName: body.username,
-            avatarUrl: body.avatar
-                ? `https://cdn.discordapp.com/avatars/${body.id}/${body.avatar}.${body.avatar.startsWith('a_') ? 'gif' : 'png'}`
-                : `https://cdn.discordapp.com/embed/avatars/${body.discriminator % 5}.png`,
-            email: body.email,
-            emailVerificationState: 'verified' in body
-                ? body.verified
-                    ? 'verified'
-                    : 'unverified'
-                : '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' },
-        };
-    }
-}

package/build/src/drivers/facebook.js

@@ -1,155 +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';
-/**
- * Facebook driver to login user via Facebook
- */
-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;
-        /**
-         * 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 || ['email']);
-        request.param('response_type', 'code');
-        request.param('grant_type', 'authorization_code');
-        /**
-         * Define params based upon user config
-         */
-        if (this.config.display) {
-            request.param('display', this.config.display);
-        }
-        if (this.config.authType) {
-            request.param('auth_type', this.config.authType);
-        }
-    }
-    /**
-     * 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 Facebook API
-     * https://developers.facebook.com/docs/graph-api/reference/user/
-     */
-    async getUserInfo(token, callback) {
-        const request = this.getAuthenticatedRequest(this.config.userInfoUrl || this.userInfoUrl, token);
-        request.param('fields', (this.config.userFields || this.userFields).join(','));
-        const body = await request.get();
-        /**
-         * Invoke callback if defined
-         */
-        if (typeof callback === 'function') {
-            callback(request);
-        }
-        return {
-            id: body.id,
-            name: body.name,
-            nickName: body.name,
-            // https://developers.facebook.com/docs/graph-api/reference/user/picture/
-            avatarUrl: body.picture?.data?.url || null,
-            email: body.email || null,
-            // Important note: https://developers.facebook.com/docs/facebook-login/multiple-providers#postfb1
-            emailVerificationState: 'verified' in body
-                ? body.verified
-                    ? 'verified'
-                    : 'unverified'
-                : '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' },
-        };
-    }
-}