@adonisjs/ally 6.1.0 → 6.2.0

package/build/{chunk-SBQAXPUK.js → chunk-4QTU45GZ.js}

@@ -4,7 +4,7 @@ import {
 import {
   E_OAUTH_MISSING_CODE,
   E_OAUTH_STATE_MISMATCH
-} from "./chunk-6BP2DK5A.js";
+} from "./chunk-TSIMPJ6I.js";
 
 // src/abstract_drivers/oauth1.ts
 import { Exception } from "@adonisjs/core/exceptions";

package/build/{chunk-46TOMXWK.js → chunk-7V2EH7U6.js}

@@ -4,7 +4,7 @@ import {
 import {
   E_OAUTH_MISSING_CODE,
   E_OAUTH_STATE_MISMATCH
-} from "./chunk-6BP2DK5A.js";
+} from "./chunk-TSIMPJ6I.js";
 
 // src/abstract_drivers/oauth2.ts
 import { Exception } from "@adonisjs/core/exceptions";

package/build/{chunk-TFPW7D75.js → chunk-ISWHUP4Q.js}

@@ -1,7 +1,7 @@
 import {
   E_LOCAL_SIGNUP_DISALLOWED,
   E_UNKNOWN_ALLY_PROVIDER
-} from "./chunk-6BP2DK5A.js";
+} from "./chunk-TSIMPJ6I.js";
 
 // src/ally_manager.ts
 var AllyManager = class {

package/build/chunk-TSIMPJ6I.js

@@ -0,0 +1,119 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/errors.ts
+var errors_exports = {};
+__export(errors_exports, {
+  E_LOCAL_SIGNUP_DISALLOWED: () => E_LOCAL_SIGNUP_DISALLOWED,
+  E_OAUTH_MISSING_CODE: () => E_OAUTH_MISSING_CODE,
+  E_OAUTH_STATE_MISMATCH: () => E_OAUTH_STATE_MISMATCH,
+  E_UNKNOWN_ALLY_PROVIDER: () => E_UNKNOWN_ALLY_PROVIDER,
+  HttpResponseException: () => HttpResponseException
+});
+import { Exception } from "@adonisjs/core/exceptions";
+var HttpResponseException = class extends Exception {
+  /**
+   * Returns the message to be sent in the HTTP response.
+   * Feel free to override this method and return a custom
+   * response.
+   */
+  getResponseMessage(error, ctx) {
+    if ("i18n" in ctx) {
+      return ctx.i18n.t(error.identifier, {}, error.message);
+    }
+    return error.message;
+  }
+  /**
+   * Converts exception to an HTTP response
+   */
+  async handle(error, ctx) {
+    const message = this.getResponseMessage(error, ctx);
+    switch (ctx.request.accepts(["html", "application/vnd.api+json", "json"])) {
+      case "html":
+      case null:
+        if (ctx.session) {
+          ctx.session.flash("error", message);
+          ctx.session.flashErrors({ [error.code]: message });
+          ctx.response.redirect().back();
+        } else {
+          ctx.response.status(error.status).send(message);
+        }
+        break;
+      case "json":
+        ctx.response.status(error.status).send({
+          errors: [
+            {
+              message
+            }
+          ]
+        });
+        break;
+      case "application/vnd.api+json":
+        ctx.response.status(error.status).send({
+          errors: [
+            {
+              code: error.code,
+              title: message
+            }
+          ]
+        });
+        break;
+    }
+  }
+};
+var E_OAUTH_MISSING_CODE = class extends HttpResponseException {
+  static status = 500;
+  static code = "E_OAUTH_MISSING_CODE";
+  /**
+   * Translation identifier. Can be customized
+   */
+  identifier = "errors.E_OAUTH_MISSING_CODE";
+  constructor(args, options) {
+    super(
+      `Cannot request access token. Redirect request is missing the "${args[0]}" param`,
+      options
+    );
+  }
+};
+var E_OAUTH_STATE_MISMATCH = class extends HttpResponseException {
+  static status = 400;
+  static code = "E_OAUTH_STATE_MISMATCH";
+  static message = "Unable to verify re-redirect state";
+  /**
+   * Translation identifier. Can be customized
+   */
+  identifier = "errors.E_OAUTH_STATE_MISMATCH";
+};
+var E_UNKNOWN_ALLY_PROVIDER = class extends HttpResponseException {
+  static status = 404;
+  static code = "E_UNKNOWN_ALLY_PROVIDER";
+  /**
+   * Translation identifier. Can be customized
+   */
+  identifier = "errors.E_UNKNOWN_ALLY_PROVIDER";
+  constructor(args, options) {
+    super(`Unknown authentication provider "${args[0]}"`, options);
+  }
+};
+var E_LOCAL_SIGNUP_DISALLOWED = class extends HttpResponseException {
+  static status = 403;
+  static code = "E_LOCAL_SIGNUP_DISALLOWED";
+  /**
+   * Translation identifier. Can be customized
+   */
+  identifier = "errors.E_LOCAL_SIGNUP_DISALLOWED";
+  constructor(args, options) {
+    super(`Cannot signup using "${args[0]}". Local signup is disabled for this provider`, options);
+  }
+};
+
+export {
+  E_OAUTH_MISSING_CODE,
+  E_OAUTH_STATE_MISMATCH,
+  E_UNKNOWN_ALLY_PROVIDER,
+  E_LOCAL_SIGNUP_DISALLOWED,
+  errors_exports
+};

package/build/index.js

@@ -1,18 +1,18 @@
 import {
   Oauth1Driver
-} from "./chunk-SBQAXPUK.js";
+} from "./chunk-4QTU45GZ.js";
 import {
   AllyManager
-} from "./chunk-TFPW7D75.js";
+} from "./chunk-ISWHUP4Q.js";
 import {
   Oauth2Driver
-} from "./chunk-46TOMXWK.js";
+} from "./chunk-7V2EH7U6.js";
 import {
   RedirectRequest
 } from "./chunk-NK6X76EQ.js";
 import {
   errors_exports
-} from "./chunk-6BP2DK5A.js";
+} from "./chunk-TSIMPJ6I.js";
 
 // index.ts
 import { HttpClient } from "@poppinss/oauth-client";
@@ -22,14 +22,19 @@ var stubsRoot = import.meta.dirname;
 
 // configure.ts
 var AVAILABLE_PROVIDERS = [
-  "discord",
-  "facebook",
-  "github",
-  "google",
-  "linkedin",
-  "linkedinOpenidConnect",
-  "spotify",
-  "twitter"
+  { name: "discord", message: "Discord", envPrefix: "DISCORD" },
+  { name: "facebook", message: "Facebook", envPrefix: "FACEBOOK" },
+  { name: "github", message: "GitHub", envPrefix: "GITHUB" },
+  { name: "google", message: "Google", envPrefix: "GOOGLE" },
+  { name: "linkedin", message: "LinkedIn", envPrefix: "LINKEDIN" },
+  {
+    name: "linkedinOpenidConnect",
+    message: "LinkedIn (OpenID Connect)",
+    envPrefix: "LINKEDIN_OC"
+  },
+  { name: "spotify", message: "Spotify", envPrefix: "SPOTIFY" },
+  { name: "twitter", message: "Twitter", envPrefix: "TWITTER" },
+  { name: "twitterX", message: "Twitter X (OAuth2)", envPrefix: "TWITTER_X" }
 ];
 async function configure(command) {
   let selectedProviders = command.parsedFlags.providers;
@@ -44,17 +49,20 @@ async function configure(command) {
       }
     );
   }
-  let providers = typeof selectedProviders === "string" ? [selectedProviders] : selectedProviders;
-  const unknownProvider = providers.find((provider) => !AVAILABLE_PROVIDERS.includes(provider));
+  const providerNames = typeof selectedProviders === "string" ? [selectedProviders] : selectedProviders;
+  const unknownProvider = providerNames.find(
+    (name) => !AVAILABLE_PROVIDERS.some((p) => p.name === name)
+  );
   if (unknownProvider) {
     command.exitCode = 1;
     command.logger.error(`Invalid social provider "${unknownProvider}"`);
     return;
   }
+  const providers = providerNames.map((name) => AVAILABLE_PROVIDERS.find((p) => p.name === name));
   const codemods = await command.createCodemods();
   await codemods.makeUsingStub(stubsRoot, "config/ally.stub", {
     providers: providers.map((provider) => {
-      return { provider, envPrefix: provider.toUpperCase() };
+      return { provider: provider.name, envPrefix: provider.envPrefix };
     })
   });
   await codemods.updateRcFile((rcFile) => {
@@ -62,15 +70,15 @@ async function configure(command) {
   });
   await codemods.defineEnvVariables(
     providers.reduce((result, provider) => {
-      result[`${provider.toUpperCase()}_CLIENT_ID`] = "";
-      result[`${provider.toUpperCase()}_CLIENT_SECRET`] = "";
+      result[`${provider.envPrefix}_CLIENT_ID`] = "";
+      result[`${provider.envPrefix}_CLIENT_SECRET`] = "";
       return result;
     }, {})
   );
   await codemods.defineEnvValidations({
     variables: providers.reduce((result, provider) => {
-      result[`${provider.toUpperCase()}_CLIENT_ID`] = "Env.schema.string()";
-      result[`${provider.toUpperCase()}_CLIENT_SECRET`] = "Env.schema.string()";
+      result[`${provider.envPrefix}_CLIENT_ID`] = "Env.schema.string()";
+      result[`${provider.envPrefix}_CLIENT_SECRET`] = "Env.schema.string()";
       return result;
     }, {}),
     leadingComment: "Variables for configuring ally package"

package/build/providers/ally_provider.js

@@ -1,7 +1,7 @@
 import {
   AllyManager
-} from "../chunk-TFPW7D75.js";
-import "../chunk-6BP2DK5A.js";
+} from "../chunk-ISWHUP4Q.js";
+import "../chunk-TSIMPJ6I.js";
 
 // providers/ally_provider.ts
 import { configProvider } from "@adonisjs/core";

package/build/src/drivers/discord.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/discord.ts
 var DiscordDriver = class extends Oauth2Driver {

package/build/src/drivers/facebook.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/facebook.ts
 var FacebookDriver = class extends Oauth2Driver {

package/build/src/drivers/github.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/github.ts
 var GithubDriver = class extends Oauth2Driver {

package/build/src/drivers/google.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/google.ts
 var SCOPE_PREFIXES = {

package/build/src/drivers/linked_in.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/linked_in.ts
 import { Exception } from "@adonisjs/core/exceptions";

package/build/src/drivers/linked_in_openid_connect.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/linked_in_openid_connect.ts
 var LinkedInOpenidConnectDriver = class extends Oauth2Driver {

package/build/src/drivers/spotify.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/spotify.ts
 var SpotifyDriver = class extends Oauth2Driver {

package/build/src/drivers/twitter.js

@@ -1,8 +1,8 @@
 import {
   Oauth1Driver
-} from "../../chunk-SBQAXPUK.js";
+} from "../../chunk-4QTU45GZ.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/twitter.ts
 var TwitterDriver = class extends Oauth1Driver {

package/build/src/drivers/twitter_x.js

@@ -1,8 +1,8 @@
 import {
   Oauth2Driver
-} from "../../chunk-46TOMXWK.js";
+} from "../../chunk-7V2EH7U6.js";
 import "../../chunk-NK6X76EQ.js";
-import "../../chunk-6BP2DK5A.js";
+import "../../chunk-TSIMPJ6I.js";
 
 // src/drivers/twitter_x.ts
 var TwitterXDriver = class extends Oauth2Driver {

package/build/src/errors.d.ts

@@ -1,3 +1,23 @@
+import { Exception } from '@adonisjs/core/exceptions';
+import { type HttpContext } from '@adonisjs/core/http';
+/**
+ * Base exception that self-handles by content-negotiating the
+ * HTTP response (HTML with session flash, JSON, JSONAPI)
+ * and supporting i18n translation.
+ */
+export declare abstract class HttpResponseException extends Exception {
+    abstract identifier: string;
+    /**
+     * Returns the message to be sent in the HTTP response.
+     * Feel free to override this method and return a custom
+     * response.
+     */
+    getResponseMessage(error: this, ctx: HttpContext): string;
+    /**
+     * Converts exception to an HTTP response
+     */
+    handle(error: this, ctx: HttpContext): Promise<void>;
+}
 /**
  * Error thrown when the OAuth redirect is missing the required
  * authorization code or token parameter.
@@ -7,7 +27,41 @@
  * throw new errors.E_OAUTH_MISSING_CODE(['code'])
  * ```
  */
-export declare const E_OAUTH_MISSING_CODE: new (args: [string], options?: ErrorOptions) => import("@adonisjs/core/exceptions").Exception;
+export declare const E_OAUTH_MISSING_CODE: {
+    new (args: [string], options?: ErrorOptions): {
+        /**
+         * Translation identifier. Can be customized
+         */
+        identifier: string;
+        /**
+         * Returns the message to be sent in the HTTP response.
+         * Feel free to override this method and return a custom
+         * response.
+         */
+        getResponseMessage(error: /*elided*/ any, ctx: HttpContext): string;
+        /**
+         * Converts exception to an HTTP response
+         */
+        handle(error: /*elided*/ any, ctx: HttpContext): Promise<void>;
+        name: string;
+        help?: string;
+        code?: string;
+        status: number;
+        toString(): string;
+        get [Symbol.toStringTag](): string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+    status: number;
+    code: string;
+    help?: string;
+    message?: string;
+    isError(error: unknown): error is Error;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+};
 /**
  * Error thrown when the OAuth state parameter does not match
  * the expected value, indicating a potential CSRF attack.
@@ -17,7 +71,44 @@ export declare const E_OAUTH_MISSING_CODE: new (args: [string], options?: ErrorO
  * throw new errors.E_OAUTH_STATE_MISMATCH()
  * ```
  */
-export declare const E_OAUTH_STATE_MISMATCH: new (args?: any, options?: ErrorOptions) => import("@adonisjs/core/exceptions").Exception;
+export declare const E_OAUTH_STATE_MISMATCH: {
+    new (message?: string, options?: ErrorOptions & {
+        code?: string;
+        status?: number;
+    }): {
+        /**
+         * Translation identifier. Can be customized
+         */
+        identifier: string;
+        /**
+         * Returns the message to be sent in the HTTP response.
+         * Feel free to override this method and return a custom
+         * response.
+         */
+        getResponseMessage(error: /*elided*/ any, ctx: HttpContext): string;
+        /**
+         * Converts exception to an HTTP response
+         */
+        handle(error: /*elided*/ any, ctx: HttpContext): Promise<void>;
+        name: string;
+        help?: string;
+        code?: string;
+        status: number;
+        toString(): string;
+        get [Symbol.toStringTag](): string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+    status: number;
+    code: string;
+    message: string;
+    help?: string;
+    isError(error: unknown): error is Error;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+};
 /**
  * Error thrown when attempting to use an unknown Ally provider.
  *
@@ -26,7 +117,41 @@ export declare const E_OAUTH_STATE_MISMATCH: new (args?: any, options?: ErrorOpt
  * throw new errors.E_UNKNOWN_ALLY_PROVIDER(['github'])
  * ```
  */
-export declare const E_UNKNOWN_ALLY_PROVIDER: new (args: [string], options?: ErrorOptions) => import("@adonisjs/core/exceptions").Exception;
+export declare const E_UNKNOWN_ALLY_PROVIDER: {
+    new (args: [string], options?: ErrorOptions): {
+        /**
+         * Translation identifier. Can be customized
+         */
+        identifier: string;
+        /**
+         * Returns the message to be sent in the HTTP response.
+         * Feel free to override this method and return a custom
+         * response.
+         */
+        getResponseMessage(error: /*elided*/ any, ctx: HttpContext): string;
+        /**
+         * Converts exception to an HTTP response
+         */
+        handle(error: /*elided*/ any, ctx: HttpContext): Promise<void>;
+        name: string;
+        help?: string;
+        code?: string;
+        status: number;
+        toString(): string;
+        get [Symbol.toStringTag](): string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+    status: number;
+    code: string;
+    help?: string;
+    message?: string;
+    isError(error: unknown): error is Error;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+};
 /**
  * Error thrown when a provider is used for signup but local signup
  * is disabled for it.
@@ -36,4 +161,38 @@ export declare const E_UNKNOWN_ALLY_PROVIDER: new (args: [string], options?: Err
  * throw new errors.E_LOCAL_SIGNUP_DISALLOWED(['github'])
  * ```
  */
-export declare const E_LOCAL_SIGNUP_DISALLOWED: new (args: [string], options?: ErrorOptions) => import("@adonisjs/core/exceptions").Exception;
+export declare const E_LOCAL_SIGNUP_DISALLOWED: {
+    new (args: [string], options?: ErrorOptions): {
+        /**
+         * Translation identifier. Can be customized
+         */
+        identifier: string;
+        /**
+         * Returns the message to be sent in the HTTP response.
+         * Feel free to override this method and return a custom
+         * response.
+         */
+        getResponseMessage(error: /*elided*/ any, ctx: HttpContext): string;
+        /**
+         * Converts exception to an HTTP response
+         */
+        handle(error: /*elided*/ any, ctx: HttpContext): Promise<void>;
+        name: string;
+        help?: string;
+        code?: string;
+        status: number;
+        toString(): string;
+        get [Symbol.toStringTag](): string;
+        message: string;
+        stack?: string;
+        cause?: unknown;
+    };
+    status: number;
+    code: string;
+    help?: string;
+    message?: string;
+    isError(error: unknown): error is Error;
+    captureStackTrace(targetObject: object, constructorOpt?: Function): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/ally",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Social authentication provider for AdonisJS",
   "type": "module",
   "main": "build/index.js",
@@ -42,7 +42,9 @@
     "@adonisjs/assembler": "^8.4.0",
     "@adonisjs/core": "^7.3.0",
     "@adonisjs/eslint-config": "^3.0.0",
+    "@adonisjs/i18n": "^3.0.0",
     "@adonisjs/prettier-config": "^1.4.5",
+    "@adonisjs/session": "^8.0.0",
     "@adonisjs/tsconfig": "^2.0.0",
     "@japa/assert": "^4.2.0",
     "@japa/expect-type": "^2.0.4",
@@ -65,12 +67,20 @@
     "@poppinss/oauth-client": "^7.2.0"
   },
   "peerDependencies": {
+    "@adonisjs/assembler": "^8.0.0",
     "@adonisjs/core": "^7.0.0-next.8 || ^7.0.0",
-    "@adonisjs/assembler": "^8.0.0"
+    "@adonisjs/i18n": "^3.0.0",
+    "@adonisjs/session": "^8.0.0"
   },
   "peerDependenciesMeta": {
     "@adonisjs/assembler": {
       "optional": true
+    },
+    "@adonisjs/i18n": {
+      "optional": true
+    },
+    "@adonisjs/session": {
+      "optional": true
     }
   },
   "homepage": "https://github.com/adonisjs/ally#readme",

package/build/chunk-6BP2DK5A.js

@@ -1,43 +0,0 @@
-var __defProp = Object.defineProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-
-// src/errors.ts
-var errors_exports = {};
-__export(errors_exports, {
-  E_LOCAL_SIGNUP_DISALLOWED: () => E_LOCAL_SIGNUP_DISALLOWED,
-  E_OAUTH_MISSING_CODE: () => E_OAUTH_MISSING_CODE,
-  E_OAUTH_STATE_MISMATCH: () => E_OAUTH_STATE_MISMATCH,
-  E_UNKNOWN_ALLY_PROVIDER: () => E_UNKNOWN_ALLY_PROVIDER
-});
-import { createError } from "@adonisjs/core/exceptions";
-var E_OAUTH_MISSING_CODE = createError(
-  'Cannot request access token. Redirect request is missing the "%s" param',
-  "E_OAUTH_MISSING_CODE",
-  500
-);
-var E_OAUTH_STATE_MISMATCH = createError(
-  "Unable to verify re-redirect state",
-  "E_OAUTH_STATE_MISMATCH",
-  400
-);
-var E_UNKNOWN_ALLY_PROVIDER = createError(
-  'Unknown ally provider "%s". Make sure it is registered inside the config/ally.ts file',
-  "E_UNKNOWN_ALLY_PROVIDER",
-  404
-);
-var E_LOCAL_SIGNUP_DISALLOWED = createError(
-  'Cannot use ally provider "%s" for signup. Local signup is disabled for this provider',
-  "E_LOCAL_SIGNUP_DISALLOWED",
-  403
-);
-
-export {
-  E_OAUTH_MISSING_CODE,
-  E_OAUTH_STATE_MISMATCH,
-  E_UNKNOWN_ALLY_PROVIDER,
-  E_LOCAL_SIGNUP_DISALLOWED,
-  errors_exports
-};