@adonisjs/ally 5.0.0-0 → 5.0.0-2

package/build/configure.js

@@ -10,9 +10,27 @@
  * Configures the package
  */
 export async function configure(command) {
-    await command.publishStub('config.stub');
-    await command.publishStub('types.stub');
+    const providers = await command.prompt.multiple('Select the social auth providers you plan to use', ['discord', 'facebook', 'github', 'google', 'linkedin', 'spotify', 'twitter']);
+    /**
+     * Publish config file
+     */
+    await command.publishStub('config.stub', {
+        providers: providers.map((provider) => {
+            return { provider, envPrefix: provider.toUpperCase() };
+        }),
+    });
+    /**
+     * Publish provider
+     */
     await command.updateRcFile((rcFile) => {
         rcFile.addProvider('@adonisjs/ally/ally_provider');
     });
+    /**
+     * Define env variables for the selected providers
+     */
+    await command.defineEnvVariables(providers.reduce((result, provider) => {
+        result[`${provider.toUpperCase()}_CLIENT_ID`] = '';
+        result[`${provider.toUpperCase()}_CLIENT_SECRET`] = '';
+        return result;
+    }, {}));
 }

package/build/index.d.ts

@@ -1,6 +1,6 @@
 import './src/bindings/types.js';
 export { HttpClient as ApiRequest } from '@poppinss/oauth-client';
-export * as errors from './src/exceptions.js';
+export * as errors from './src/errors.js';
 export { AllyManager } from './src/ally_manager.js';
 export { defineConfig } from './src/define_config.js';
 export { RedirectRequest } from './src/redirect_request.js';

package/build/index.js

@@ -8,7 +8,7 @@
  */
 import './src/bindings/types.js';
 export { HttpClient as ApiRequest } from '@poppinss/oauth-client';
-export * as errors from './src/exceptions.js';
+export * as errors from './src/errors.js';
 export { AllyManager } from './src/ally_manager.js';
 export { defineConfig } from './src/define_config.js';
 export { RedirectRequest } from './src/redirect_request.js';

package/build/providers/ally_provider.d.ts

@@ -1,4 +1,4 @@
-import { ApplicationService } from '@adonisjs/core/types';
+import type { ApplicationService } from '@adonisjs/core/types';
 /**
  * AllyProvider extends the HTTP context with the "ally" property
  */

package/build/providers/ally_provider.js

@@ -6,6 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import driversList from '../src/drivers_collection.js';
 import { extendHttpContext } from '../src/bindings/http_context.js';
 /**
  * AllyProvider extends the HTTP context with the "ally" property
@@ -16,6 +17,8 @@ export default class AllyProvider {
         this.app = app;
     }
     async boot() {
-        extendHttpContext(this.app.config.get('ally'));
+        const config = this.app.config.get('ally');
+        extendHttpContext(config.services);
+        await driversList.registerBundledDrivers(config.driversInUse);
     }
 }

package/build/src/abstract_drivers/oauth1.js

@@ -8,7 +8,7 @@
  */
 import { Exception } from '@poppinss/utils';
 import { Oauth1Client } from '@poppinss/oauth-client';
-import * as errors from '../exceptions.js';
+import * as errors from '../errors.js';
 import { RedirectRequest } from '../redirect_request.js';
 /**
  * Abstract implementation for an Oauth1 driver

package/build/src/abstract_drivers/oauth2.js

@@ -8,7 +8,7 @@
  */
 import { Exception } from '@poppinss/utils';
 import { Oauth2Client } from '@poppinss/oauth-client';
-import * as errors from '../exceptions.js';
+import * as errors from '../errors.js';
 import { RedirectRequest } from '../redirect_request.js';
 /**
  * Abstract implementation for an Oauth2 driver

package/build/src/bindings/http_context.d.ts

@@ -1,6 +1,6 @@
 import './types.js';
-import { AllyManagerDriverFactory, SocialProviders } from '../types.js';
+import { AllyManagerDriverFactory } from '../types.js';
 /**
  * Extends HttpContext class with the ally getter
  */
-export declare function extendHttpContext(config: SocialProviders extends Record<string, AllyManagerDriverFactory> ? SocialProviders : never): void;
+export declare function extendHttpContext(config: Record<string, AllyManagerDriverFactory>): void;

package/build/src/debug.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="@types/node" resolution-mode="require"/>
+declare const _default: import("util").DebugLogger;
+export default _default;

package/build/src/debug.js

@@ -0,0 +1,10 @@
+/*
+ * @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.d.ts

@@ -8,5 +8,8 @@ export declare function defineConfig<KnownSocialProviders extends Record<string,
         driver: K;
     } & Parameters<AllyDriversList[K]>[0];
 }[keyof AllyDriversList]>>(config: KnownSocialProviders): {
-    [K in keyof KnownSocialProviders]: (ctx: HttpContext) => ReturnType<AllyDriversList[KnownSocialProviders[K]['driver']]>;
+    services: {
+        [K in keyof KnownSocialProviders]: (ctx: HttpContext) => ReturnType<AllyDriversList[KnownSocialProviders[K]['driver']]>;
+    };
+    driversInUse: Set<keyof AllyDriversList>;
 };

package/build/src/define_config.js

@@ -12,15 +12,20 @@ import allyDriversCollection from './drivers_collection.js';
  */
 export function defineConfig(config) {
     /**
-     * Converting user defined config to an object of providers
+     * Converting user defined config to an object of services
      * that can be injected into the AllyManager class
      */
-    const managerHashers = Object.keys(config).reduce((result, provider) => {
+    const driversInUse = new Set();
+    const services = Object.keys(config).reduce((result, provider) => {
         const providerConfig = config[provider];
+        driversInUse.add(providerConfig.driver);
         result[provider] = (ctx) => {
             return allyDriversCollection.create(providerConfig.driver, providerConfig, ctx);
         };
         return result;
     }, {});
-    return managerHashers;
+    return {
+        services,
+        driversInUse,
+    };
 }

package/build/src/drivers_collection.d.ts

@@ -1,6 +1,10 @@
 import type { HttpContext } from '@adonisjs/core/http';
 import type { AllyDriversList } from './types.js';
+/**
+ * A global collection of ally drivers.
+ */
 declare class AllyDriversCollection {
+    registerBundledDrivers(drivers: Set<keyof AllyDriversList>): Promise<void>;
     /**
      * List of registered drivers
      */

package/build/src/drivers_collection.js

@@ -7,31 +7,52 @@
  * file that was distributed with this source code.
  */
 import { RuntimeException } from '@poppinss/utils';
-import { GithubDriver } from './drivers/github.js';
-import { GoogleDriver } from './drivers/google.js';
-import { SpotifyDriver } from './drivers/spotify.js';
-import { TwitterDriver } from './drivers/twitter.js';
-import { DiscordDriver } from './drivers/discord.js';
-import { FacebookDriver } from './drivers/facebook.js';
-import { LinkedInDriver } from './drivers/linked_in.js';
+import debug from './debug.js';
+/**
+ * A global collection of ally drivers.
+ */
 class AllyDriversCollection {
+    async registerBundledDrivers(drivers) {
+        debug('drivers in use %O', drivers);
+        if (drivers.has('discord') && !this.list['discord']) {
+            const { DiscordDriver } = await import('../src/drivers/discord.js');
+            this.extend('discord', (config, ctx) => new DiscordDriver(ctx, config));
+        }
+        if (drivers.has('facebook') && !this.list['facebook']) {
+            const { FacebookDriver } = await import('../src/drivers/facebook.js');
+            this.extend('facebook', (config, ctx) => new FacebookDriver(ctx, config));
+        }
+        if (drivers.has('github') && !this.list['github']) {
+            const { GithubDriver } = await import('../src/drivers/github.js');
+            this.extend('github', (config, ctx) => new GithubDriver(ctx, config));
+        }
+        if (drivers.has('google') && !this.list['google']) {
+            const { GoogleDriver } = await import('../src/drivers/google.js');
+            this.extend('google', (config, ctx) => new GoogleDriver(ctx, config));
+        }
+        if (drivers.has('linkedin') && !this.list['linkedin']) {
+            const { LinkedInDriver } = await import('../src/drivers/linked_in.js');
+            this.extend('linkedin', (config, ctx) => new LinkedInDriver(ctx, config));
+        }
+        if (drivers.has('spotify') && !this.list['spotify']) {
+            const { SpotifyDriver } = await import('../src/drivers/spotify.js');
+            this.extend('spotify', (config, ctx) => new SpotifyDriver(ctx, config));
+        }
+        if (drivers.has('twitter') && !this.list['twitter']) {
+            const { TwitterDriver } = await import('../src/drivers/twitter.js');
+            this.extend('twitter', (config, ctx) => new TwitterDriver(ctx, config));
+        }
+    }
     /**
      * List of registered drivers
      */
-    list = {
-        discord: (config, ctx) => new DiscordDriver(ctx, config),
-        facebook: (config, ctx) => new FacebookDriver(ctx, config),
-        github: (config, ctx) => new GithubDriver(ctx, config),
-        google: (config, ctx) => new GoogleDriver(ctx, config),
-        linkedin: (config, ctx) => new LinkedInDriver(ctx, config),
-        spotify: (config, ctx) => new SpotifyDriver(ctx, config),
-        twitter: (config, ctx) => new TwitterDriver(ctx, config),
-    };
+    list = {};
     /**
      * Extend drivers collection and add a custom
      * driver to it.
      */
     extend(driverName, factoryCallback) {
+        debug('registering %s driver', driverName);
         this.list[driverName] = factoryCallback;
         return this;
     }
@@ -43,6 +64,7 @@ class AllyDriversCollection {
         if (!driverFactory) {
             throw new RuntimeException(`Unknown ally driver "${String(name)}". Make sure the driver is registered`);
         }
+        debug('creating instance of %s driver', name);
         return driverFactory(config, ctx);
     }
 }

package/build/src/types.d.ts

@@ -380,4 +380,6 @@ export type AllyManagerDriverFactory = (ctx: HttpContext) => AllyDriverContract<
  */
 export interface SocialProviders {
 }
-export type InferSocialProviders<T extends Record<string, AllyManagerDriverFactory>> = T;
+export type InferSocialProviders<T extends {
+    services: Record<string, AllyManagerDriverFactory>;
+}> = T['services'];

package/build/stubs/config.stub

@@ -1,7 +1,22 @@
 ---
 to: {{ app.configPath('ally.ts') }}
 ---
-import { defineConfig } from '@adonisjs/ally'
 import env from '#start/env'
+import { defineConfig } from '@adonisjs/ally'
+
+const allyConfig = defineConfig({
+{{#each providers as provider}}
+  {{provider.provider}}: {
+    driver: '{{provider.provider}}',
+    clientId: env.get('{{provider.envPrefix}}_CLIENT_ID'),
+    clientSecret: env.get('{{provider.envPrefix}}_CLIENT_SECRET'),
+    callbackUrl: '',
+  },
+{{/each}}
+})
+
+export default allyConfig
 
-export default defineConfig({})
+declare module '@adonisjs/ally/types' {
+  interface SocialProviders extends InferSocialProviders<typeof allyConfig> {}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/ally",
-  "version": "5.0.0-0",
+  "version": "5.0.0-2",
   "description": "Social authentication provider for AdonisJS",
   "type": "module",
   "main": "build/index.js",
@@ -47,23 +47,23 @@
   "author": "adonisjs,virk",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/core": "^6.1.5-8",
+    "@adonisjs/core": "^6.1.5-15",
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
     "@adonisjs/tsconfig": "^1.1.8",
-    "@commitlint/cli": "^17.6.6",
-    "@commitlint/config-conventional": "^17.6.6",
+    "@commitlint/cli": "^17.6.7",
+    "@commitlint/config-conventional": "^17.6.7",
     "@japa/assert": "^2.0.0-1",
     "@japa/expect-type": "^2.0.0-0",
     "@japa/file-system": "^2.0.0-1",
     "@japa/runner": "^3.0.0-6",
-    "@swc/core": "^1.3.69",
-    "@types/node": "^20.4.2",
-    "c8": "^8.0.0",
+    "@swc/core": "^1.3.74",
+    "@types/node": "^20.4.6",
+    "c8": "^8.0.1",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.0.0",
     "dotenv": "^16.3.1",
-    "eslint": "^8.45.0",
+    "eslint": "^8.46.0",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
     "nock": "^13.3.2",
@@ -76,6 +76,9 @@
     "@poppinss/oauth-client": "^5.1.0-3",
     "@poppinss/utils": "^6.5.0-3"
   },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.1.5-15"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/adonisjs/adonis-ally.git"

package/build/stubs/types.stub

@@ -1,12 +0,0 @@
----
-to: {{ app.contractsPath('ally.ts') }}
----
-import allyConfig from '#config/ally'
-
-declare module '@adonisjs/ally/types' {
-  /**
-   * Here we get a list of social providers you have configured inside
-   * the config/ally.ts file.
-   */
-  interface SocialProviders extends InferSocialProviders<typeof allyConfig> {}
-}