@adonisjs/ally/build/chunk-NK6X76EQ.js

Social authentication provider for AdonisJS

// src/redirect_request.ts
import { UrlBuilder } from "@poppinss/oauth-client";
var RedirectRequest = class extends UrlBuilder {
  /**
   * Optional callback used to transform scope values before serialization.
   */
  #scopesTransformer;
  /**
   * Query parameter name used to serialize the scope string.
   */
  #scopeParamName;
  /**
   * Separator used when joining multiple scopes.
   */
  #scopeSeparator;
  /**
   * Create a redirect request builder with scope helpers.
   *
   * @param baseUrl - The authorization URL for the OAuth provider
   * @param scopeParamName - The query parameter name for scopes (e.g., 'scope')
   * @param scopeSeparator - The character used to separate multiple scopes (e.g., ' ' or ',')
   */
  constructor(baseUrl, scopeParamName, scopeSeparator) {
    super(baseUrl);
    this.#scopeParamName = scopeParamName;
    this.#scopeSeparator = scopeSeparator;
  }
  /**
   * Register a custom function to transform scopes before they are
   * added to the authorization URL. This is useful for providers that
   * require scope prefixes or transformations.
   *
   * @param callback - Function that transforms the scopes array
   * @returns The current redirect request instance.
   *
   * @example
   * ```ts
   * request.transformScopes((scopes) => {
   *   return scopes.map(scope => `https://provider.com/auth/${scope}`)
   * })
   * ```
   */
  transformScopes(callback) {
    this.#scopesTransformer = callback;
    return this;
  }
  /**
   * Define the scopes to request during authorization. This replaces
   * any previously set scopes.
   *
   * @param scopes - Array of scope strings to request
   * @returns The current redirect request instance.
   *
   * @example
   * ```ts
   * request.scopes(['user:email', 'read:org'])
   * ```
   */
  scopes(scopes) {
    if (typeof this.#scopesTransformer === "function") {
      scopes = this.#scopesTransformer(scopes);
    }
    this.param(this.#scopeParamName, scopes.join(this.#scopeSeparator));
    return this;
  }
  /**
   * Merge additional scopes with any existing scopes. This is useful
   * for adding scopes without replacing the default ones.
   *
   * @param scopes - Array of scope strings to merge
   * @returns The current redirect request instance.
   *
   * @example
   * ```ts
   * request
   *   .scopes(['user:email'])
   *   .mergeScopes(['read:org'])
   * ```
   */
  mergeScopes(scopes) {
    if (typeof this.#scopesTransformer === "function") {
      scopes = this.#scopesTransformer(scopes);
    }
    const existingScopes = this.getParams()[this.#scopeParamName];
    const scopesString = scopes.join(this.#scopeSeparator);
    if (!existingScopes) {
      this.param(this.#scopeParamName, scopesString);
      return this;
    }
    this.param(this.#scopeParamName, `${existingScopes}${this.#scopeSeparator}${scopesString}`);
    return this;
  }
  /**
   * Clear all existing scopes from the authorization request.
   *
   * @returns The current redirect request instance.
   *
   * @example
   * ```ts
   * request.clearScopes().scopes(['user'])
   * ```
   */
  clearScopes() {
    this.clearParam(this.#scopeParamName);
    return this;
  }
};

export {
  RedirectRequest
};